proto

package
v0.13.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 23, 2024 License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	Default_ProbeConf_Protocol                   = ProbeConf_HTTP
	Default_ProbeConf_Scheme                     = ProbeConf_HTTP
	Default_ProbeConf_ExportResponseAsMetrics    = bool(false)
	Default_ProbeConf_Method                     = ProbeConf_GET
	Default_ProbeConf_MaxIdleConns               = int32(256)
	Default_ProbeConf_IntervalBetweenTargetsMsec = int32(10)
	Default_ProbeConf_RequestsPerProbe           = int32(1)
	Default_ProbeConf_RequestsIntervalMsec       = int32(0)
)

Default values for ProbeConf fields.

Variables

View Source 
var (
	ProbeConf_Scheme_name = map[int32]string{
		0: "HTTP",
		1: "HTTPS",
	}
	ProbeConf_Scheme_value = map[string]int32{
		"HTTP":  0,
		"HTTPS": 1,
	}
)

Enum value maps for ProbeConf_Scheme.

View Source 
var (
	ProbeConf_Method_name = map[int32]string{
		0: "GET",
		1: "POST",
		2: "PUT",
		3: "HEAD",
		4: "DELETE",
		5: "PATCH",
		6: "OPTIONS",
	}
	ProbeConf_Method_value = map[string]int32{
		"GET":     0,
		"POST":    1,
		"PUT":     2,
		"HEAD":    3,
		"DELETE":  4,
		"PATCH":   5,
		"OPTIONS": 6,
	}
)

Enum value maps for ProbeConf_Method.

View Source 
var (
	ProbeConf_LatencyBreakdown_name = map[int32]string{
		0: "NO_BREAKDOWN",
		1: "ALL_STAGES",
		2: "DNS_LATENCY",
		3: "CONNECT_LATENCY",
		4: "TLS_HANDSHAKE_LATENCY",
		5: "REQ_WRITE_LATENCY",
		6: "FIRST_BYTE_LATENCY",
	}
	ProbeConf_LatencyBreakdown_value = map[string]int32{
		"NO_BREAKDOWN":          0,
		"ALL_STAGES":            1,
		"DNS_LATENCY":           2,
		"CONNECT_LATENCY":       3,
		"TLS_HANDSHAKE_LATENCY": 4,
		"REQ_WRITE_LATENCY":     5,
		"FIRST_BYTE_LATENCY":    6,
	}
)

Enum value maps for ProbeConf_LatencyBreakdown.

View Source 
var File_github_com_cloudprober_cloudprober_probes_http_proto_config_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type ProbeConf 

type ProbeConf struct {

	// HTTP request scheme (Corresponding target label: "scheme"). If not set, we
	// use taget's 'scheme' label if present.
	// Note: protocol is deprecated, use scheme instead.
	//
	// Types that are assignable to SchemeType:
	//
	//	*ProbeConf_Protocol
	//	*ProbeConf_Scheme_
	SchemeType isProbeConf_SchemeType `protobuf_oneof:"scheme_type"`
	// Relative URL (Corresponding target label: "path"). We construct the final
	// URL like this:
	// <scheme>://<host>:<port>/<relative_url>.
	//
	// Note that the relative_url should start with a '/'.
	RelativeUrl *string `protobuf:"bytes,2,opt,name=relative_url,json=relativeUrl" json:"relative_url,omitempty"`
	// Port for HTTP requests (Corresponding target field: port)
	// Default is to use the scheme specific port, but if this field is not
	// set and discovered target has a port (e.g., k8s services, ingresses),
	// we use target's port.
	Port *int32 `protobuf:"varint,3,opt,name=port" json:"port,omitempty"`
	// Whether to resolve the target before making the request. If set to true,
	// we resolve the target first to an IP address and make a request using
	// that while passing target name (or 'host' label if present) as Host
	// header.
	//
	// This behavior is automatic for discovered targets if they have an IP
	// address associated with them. Usually you don't need to worry about this
	// field and you can left it unspecified. We'll ty to do the right thing.
	ResolveFirst *bool `protobuf:"varint,4,opt,name=resolve_first,json=resolveFirst" json:"resolve_first,omitempty"`
	// Export response (body) count as a metric
	ExportResponseAsMetrics *bool `` /* 134-byte string literal not displayed */
	// HTTP request method
	Method *ProbeConf_Method `protobuf:"varint,7,opt,name=method,enum=cloudprober.probes.http.ProbeConf_Method,def=0" json:"method,omitempty"`
	// HTTP request headers
	// It is recommended to use "header" instead of "headers" for new configs.
	//
	//	header {
	//	  key: "Authorization"
	//	  value: "Bearer {{env "AUTH_TOKEN"}}"
	//	}
	Headers []*ProbeConf_Header `protobuf:"bytes,8,rep,name=headers" json:"headers,omitempty"`
	Header  map[string]string   `` /* 133-byte string literal not displayed */
	// Request body. This field works similar to the curl's data flag. If there
	// are multiple "body" fields, we combine their values with a '&' in between.
	//
	// Also, we try to guess the content-type header based on the data:
	//  1. If data appears to be a valid json, we automatically set the
	//     content-type header to "application/json".
	//  2. If the final data string appears to be a valid query string, we
	//     set content-type to "application/x-www-form-urlencoded". Content type
	//     header can still be overridden using the header field above.
	//
	// Example:
	//
	//	body: "grant_type=client_credentials"
	//	body: "scope=transferMoney"
	//	body: "clientId=aweseomeClient"
	//	body: "clientSecret=noSecret"
	Body []string `protobuf:"bytes,9,rep,name=body" json:"body,omitempty"`
	// Enable HTTP keep-alive. If set to true, underlying connection is reused
	// for further probes. Default is to close the connection after every request.
	KeepAlive *bool `protobuf:"varint,10,opt,name=keep_alive,json=keepAlive" json:"keep_alive,omitempty"`
	// OAuth Config
	OauthConfig *proto.Config `protobuf:"bytes,11,opt,name=oauth_config,json=oauthConfig" json:"oauth_config,omitempty"`
	// Disable HTTP2
	// Golang HTTP client automatically enables HTTP/2 if server supports it. This
	// option disables that behavior to enforce HTTP/1.1 for testing purpose.
	DisableHttp2 *bool `protobuf:"varint,13,opt,name=disable_http2,json=disableHttp2" json:"disable_http2,omitempty"`
	// Disable TLS certificate validation. If set to true, any certificate
	// presented by the server for any host name will be accepted
	// Deprecation: This option is now subsumed by the tls_config below. To
	// disable cert validation use:
	//
	//	tls_config {
	//	  disable_cert_validation: true
	//	}
	DisableCertValidation *bool `protobuf:"varint,14,opt,name=disable_cert_validation,json=disableCertValidation" json:"disable_cert_validation,omitempty"`
	// TLS config
	TlsConfig *proto1.TLSConfig `protobuf:"bytes,15,opt,name=tls_config,json=tlsConfig" json:"tls_config,omitempty"`
	// Proxy URL, e.g. http://myproxy:3128
	ProxyUrl *string `protobuf:"bytes,16,opt,name=proxy_url,json=proxyUrl" json:"proxy_url,omitempty"`
	// User agent. Default user agent is Go's default user agent.
	UserAgent *string `protobuf:"bytes,19,opt,name=user_agent,json=userAgent" json:"user_agent,omitempty"`
	// Maximum idle connections to keep alive
	MaxIdleConns *int32 `protobuf:"varint,17,opt,name=max_idle_conns,json=maxIdleConns,def=256" json:"max_idle_conns,omitempty"`
	// The maximum amount of redirects the HTTP client will follow.
	// To disable redirects, use max_redirects: 0.
	MaxRedirects *int32 `protobuf:"varint,18,opt,name=max_redirects,json=maxRedirects" json:"max_redirects,omitempty"`
	// Add latency breakdown to probe results. This will add latency breakdown
	// by various stages of the request processing, e.g., DNS resolution, TCP
	// connection, TLS handshake, etc. You can select stages individually or
	// specify "ALL_STAGES" to get breakdown for all stages.
	//
	// Example:
	//
	//	latency_breakdown: [ ALL_STAGES ]
	//	latency_breakdown: [ DNS_LATENCY, CONNECT_LATENCY, TLS_HANDSHAKE_LATENCY ]
	LatencyBreakdown []ProbeConf_LatencyBreakdown `` /* 160-byte string literal not displayed */
	// Interval between targets.
	IntervalBetweenTargetsMsec *int32 `` /* 145-byte string literal not displayed */
	// Requests per probe.
	// Number of HTTP requests per probe. Requests are executed concurrently and
	// each HTTP re contributes to probe results. For example, if you run two
	// requests per probe, "total" counter will be incremented by 2.
	RequestsPerProbe *int32 `protobuf:"varint,98,opt,name=requests_per_probe,json=requestsPerProbe,def=1" json:"requests_per_probe,omitempty"`
	// How long to wait between two requests to the same target. Only relevant
	// if requests_per_probe is also configured.
	//
	// This value should be less than (interval - timeout) / requests_per_probe.
	// This is to ensure that all requests are executed within one probe interval
	// and all of them get sufficient time. For example, if probe interval is 2s,
	// timeout is 1s, and requests_per_probe is 10,  requests_interval_msec
	// should be less than 10ms.
	RequestsIntervalMsec *int32 `protobuf:"varint,99,opt,name=requests_interval_msec,json=requestsIntervalMsec,def=0" json:"requests_interval_msec,omitempty"`
	// contains filtered or unexported fields
}

Next tag: 21

func (*ProbeConf) Descriptor deprecated 

func (*ProbeConf) Descriptor() ([]byte, []int)

Deprecated: Use ProbeConf.ProtoReflect.Descriptor instead.

func (*ProbeConf) GetBody 

func (x *ProbeConf) GetBody() []string

func (*ProbeConf) GetDisableCertValidation added in v0.10.2 

func (x *ProbeConf) GetDisableCertValidation() bool

func (*ProbeConf) GetDisableHttp2 added in v0.10.2 

func (x *ProbeConf) GetDisableHttp2() bool

func (*ProbeConf) GetExportResponseAsMetrics 

func (x *ProbeConf) GetExportResponseAsMetrics() bool

func (*ProbeConf) GetHeader added in v0.12.7 

func (x *ProbeConf) GetHeader() map[string]string

func (*ProbeConf) GetHeaders 

func (x *ProbeConf) GetHeaders() []*ProbeConf_Header

func (*ProbeConf) GetIntervalBetweenTargetsMsec added in v0.11.4 

func (x *ProbeConf) GetIntervalBetweenTargetsMsec() int32

func (*ProbeConf) GetKeepAlive added in v0.10.2 

func (x *ProbeConf) GetKeepAlive() bool

func (*ProbeConf) GetLatencyBreakdown added in v0.13.4 

func (x *ProbeConf) GetLatencyBreakdown() []ProbeConf_LatencyBreakdown

func (*ProbeConf) GetMaxIdleConns added in v0.12.3 

func (x *ProbeConf) GetMaxIdleConns() int32

func (*ProbeConf) GetMaxRedirects added in v0.12.4 

func (x *ProbeConf) GetMaxRedirects() int32

func (*ProbeConf) GetMethod 

func (x *ProbeConf) GetMethod() ProbeConf_Method

func (*ProbeConf) GetOauthConfig added in v0.11.4 

func (x *ProbeConf) GetOauthConfig() *proto.Config

func (*ProbeConf) GetPort 

func (x *ProbeConf) GetPort() int32

func (*ProbeConf) GetProtocol 

func (x *ProbeConf) GetProtocol() ProbeConf_Scheme

func (*ProbeConf) GetProxyUrl added in v0.11.4 

func (x *ProbeConf) GetProxyUrl() string

func (*ProbeConf) GetRelativeUrl 

func (x *ProbeConf) GetRelativeUrl() string

func (*ProbeConf) GetRequestsIntervalMsec 

func (x *ProbeConf) GetRequestsIntervalMsec() int32

func (*ProbeConf) GetRequestsPerProbe 

func (x *ProbeConf) GetRequestsPerProbe() int32

func (*ProbeConf) GetResolveFirst 

func (x *ProbeConf) GetResolveFirst() bool

func (*ProbeConf) GetScheme added in v0.13.1 

func (x *ProbeConf) GetScheme() ProbeConf_Scheme

func (*ProbeConf) GetSchemeType added in v0.13.1 

func (m *ProbeConf) GetSchemeType() isProbeConf_SchemeType

func (*ProbeConf) GetTlsConfig added in v0.11.4 

func (x *ProbeConf) GetTlsConfig() *proto1.TLSConfig

func (*ProbeConf) GetUserAgent added in v0.12.7 

func (x *ProbeConf) GetUserAgent() string

func (*ProbeConf) ProtoMessage 

func (*ProbeConf) ProtoMessage()

func (*ProbeConf) ProtoReflect added in v0.11.4 

func (x *ProbeConf) ProtoReflect() protoreflect.Message

func (*ProbeConf) Reset 

func (x *ProbeConf) Reset()

func (*ProbeConf) String 

func (x *ProbeConf) String() string

type ProbeConf_Header 

type ProbeConf_Header struct {
	Name  *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Value *string `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*ProbeConf_Header) Descriptor deprecated 

func (*ProbeConf_Header) Descriptor() ([]byte, []int)

Deprecated: Use ProbeConf_Header.ProtoReflect.Descriptor instead.

func (*ProbeConf_Header) GetName 

func (x *ProbeConf_Header) GetName() string

func (*ProbeConf_Header) GetValue 

func (x *ProbeConf_Header) GetValue() string

func (*ProbeConf_Header) ProtoMessage 

func (*ProbeConf_Header) ProtoMessage()

func (*ProbeConf_Header) ProtoReflect added in v0.11.4 

func (x *ProbeConf_Header) ProtoReflect() protoreflect.Message

func (*ProbeConf_Header) Reset 

func (x *ProbeConf_Header) Reset()

func (*ProbeConf_Header) String 

func (x *ProbeConf_Header) String() string

type ProbeConf_LatencyBreakdown added in v0.13.4 

type ProbeConf_LatencyBreakdown int32
const (
	ProbeConf_NO_BREAKDOWN          ProbeConf_LatencyBreakdown = 0
	ProbeConf_ALL_STAGES            ProbeConf_LatencyBreakdown = 1
	ProbeConf_DNS_LATENCY           ProbeConf_LatencyBreakdown = 2 // Exported as dns_latency
	ProbeConf_CONNECT_LATENCY       ProbeConf_LatencyBreakdown = 3 // Exported as connect_latency
	ProbeConf_TLS_HANDSHAKE_LATENCY ProbeConf_LatencyBreakdown = 4 // Exported as tls_handshake_latency
	ProbeConf_REQ_WRITE_LATENCY     ProbeConf_LatencyBreakdown = 5 // Exported as req_write_latency
	ProbeConf_FIRST_BYTE_LATENCY    ProbeConf_LatencyBreakdown = 6 // Exported as first_byte_latency
)

func (ProbeConf_LatencyBreakdown) Descriptor added in v0.13.4 

func (ProbeConf_LatencyBreakdown) Descriptor() protoreflect.EnumDescriptor

func (ProbeConf_LatencyBreakdown) Enum added in v0.13.4 

func (x ProbeConf_LatencyBreakdown) Enum() *ProbeConf_LatencyBreakdown

func (ProbeConf_LatencyBreakdown) EnumDescriptor deprecated added in v0.13.4 

func (ProbeConf_LatencyBreakdown) EnumDescriptor() ([]byte, []int)

Deprecated: Use ProbeConf_LatencyBreakdown.Descriptor instead.

func (ProbeConf_LatencyBreakdown) Number added in v0.13.4 

func (x ProbeConf_LatencyBreakdown) Number() protoreflect.EnumNumber

func (ProbeConf_LatencyBreakdown) String added in v0.13.4 

func (x ProbeConf_LatencyBreakdown) String() string

func (ProbeConf_LatencyBreakdown) Type added in v0.13.4 

func (ProbeConf_LatencyBreakdown) Type() protoreflect.EnumType

func (*ProbeConf_LatencyBreakdown) UnmarshalJSON deprecated added in v0.13.4 

func (x *ProbeConf_LatencyBreakdown) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type ProbeConf_Method 

type ProbeConf_Method int32
const (
	ProbeConf_GET     ProbeConf_Method = 0
	ProbeConf_POST    ProbeConf_Method = 1
	ProbeConf_PUT     ProbeConf_Method = 2
	ProbeConf_HEAD    ProbeConf_Method = 3
	ProbeConf_DELETE  ProbeConf_Method = 4
	ProbeConf_PATCH   ProbeConf_Method = 5
	ProbeConf_OPTIONS ProbeConf_Method = 6
)

func (ProbeConf_Method) Descriptor added in v0.11.4 

func (ProbeConf_Method) Descriptor() protoreflect.EnumDescriptor

func (ProbeConf_Method) Enum 

func (x ProbeConf_Method) Enum() *ProbeConf_Method

func (ProbeConf_Method) EnumDescriptor deprecated 

func (ProbeConf_Method) EnumDescriptor() ([]byte, []int)

Deprecated: Use ProbeConf_Method.Descriptor instead.

func (ProbeConf_Method) Number added in v0.11.4 

func (x ProbeConf_Method) Number() protoreflect.EnumNumber

func (ProbeConf_Method) String 

func (x ProbeConf_Method) String() string

func (ProbeConf_Method) Type added in v0.11.4 

func (ProbeConf_Method) Type() protoreflect.EnumType

func (*ProbeConf_Method) UnmarshalJSON deprecated 

func (x *ProbeConf_Method) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type ProbeConf_Protocol added in v0.13.1 

type ProbeConf_Protocol struct {
	Protocol ProbeConf_Scheme `protobuf:"varint,1,opt,name=protocol,enum=cloudprober.probes.http.ProbeConf_Scheme,oneof,def=0"`
}

type ProbeConf_Scheme added in v0.13.1 

type ProbeConf_Scheme int32
const (
	ProbeConf_HTTP  ProbeConf_Scheme = 0
	ProbeConf_HTTPS ProbeConf_Scheme = 1
)

func (ProbeConf_Scheme) Descriptor added in v0.13.1 

func (ProbeConf_Scheme) Descriptor() protoreflect.EnumDescriptor

func (ProbeConf_Scheme) Enum added in v0.13.1 

func (x ProbeConf_Scheme) Enum() *ProbeConf_Scheme

func (ProbeConf_Scheme) EnumDescriptor deprecated added in v0.13.1 

func (ProbeConf_Scheme) EnumDescriptor() ([]byte, []int)

Deprecated: Use ProbeConf_Scheme.Descriptor instead.

func (ProbeConf_Scheme) Number added in v0.13.1 

func (x ProbeConf_Scheme) Number() protoreflect.EnumNumber

func (ProbeConf_Scheme) String added in v0.13.1 

func (x ProbeConf_Scheme) String() string

func (ProbeConf_Scheme) Type added in v0.13.1 

func (ProbeConf_Scheme) Type() protoreflect.EnumType

func (*ProbeConf_Scheme) UnmarshalJSON deprecated added in v0.13.1 

func (x *ProbeConf_Scheme) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type ProbeConf_Scheme_ added in v0.13.1 

type ProbeConf_Scheme_ struct {
	Scheme ProbeConf_Scheme `protobuf:"varint,21,opt,name=scheme,enum=cloudprober.probes.http.ProbeConf_Scheme,oneof,def=0"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.