gohc

type CodecClientType int32

type GrpcHealthCheck struct {
	// contains filtered or unexported fields
}

type GrpcOpt struct {
	// An optional service name parameter which will be sent to gRPC service in
	// `grpc.health.v1.HealthCheckRequest
	// <https://github.com/grpc/grpc/blob/master/src/proto/grpc/health/v1/health.proto#L20>`_.
	// message. See `gRPC health-checking overview
	// <https://github.com/grpc/grpc/blob/master/doc/health-checking.md>`_ for more information.
	ServiceName string
	// The value of the :authority header in the gRPC health check request. If
	// left empty (default value) this will be host in check.
	// The authority header can be customized for a specific endpoint by setting
	// the HealthCheckConfig.hostname field.
	Authority string
	// Timeout for the gRPC health check request. If left empty (default to 5s)
	Timeout time.Duration
	// TlsEnabled set to true if the gRPC health check request should be sent over TLS.
	TlsEnabled bool
	// TlsConfig specifies the TLS configuration to use for TLS enabled gRPC health check requests.
	TlsConfig *tls.Config
	// AltPort specifies the port to use for gRPC health check requests.
	// If left empty it taks the port from host during check.
	AltPort uint32
}

type HealthChecker interface {
	Check(host string) error
}

type HttpHealthCheck struct {
	// contains filtered or unexported fields
}

type HttpOpt struct {
	// The value of the host header in the HTTP health check request
	Host string
	// Specifies the HTTP path that will be requested during health checking. For example
	// */healthcheck*.
	Path string
	// HTTP specific payload.
	Send *Payload
	// HTTP specific response.
	Receive *Payload
	// Specifies a list of HTTP headers that should be added to each request that is sent to the
	// health checked cluster.
	Headers http.Header
	// Specifies a list of HTTP response statuses considered healthy. If provided, replaces default
	// 200-only policy - 200 must be included explicitly as needed. Ranges follow half-open
	// semantics of Int64Range. The start and end of each
	ExpectedStatuses *IntRange
	// Use specified application protocol for health checks.
	CodecClientType CodecClientType
	// HTTP Method that will be used for health checking, default is "GET".
	// If a non-200 response is expected by the method, it needs to be set in expected_statuses.
	Method string
	// Timeout for the http health check request. If left empty (default to 5s)
	Timeout time.Duration
	// TlsEnabled set to true if the gRPC health check request should be sent over TLS.
	TlsEnabled bool
	// TlsConfig specifies the TLS configuration to use for TLS enabled gRPC health check requests.
	TlsConfig *tls.Config
	// AltPort specifies the port to use for gRPC health check requests.
	// If left empty it taks the port from host during check.
	AltPort uint32
}

type IcmpHealthCheck struct {
	// contains filtered or unexported fields
}

type IcmpOpt struct {
	// Timeout for ping response. If left empty (default to 5s)
	Timeout time.Duration
	// Delay specifies the delay between ICMP reply read try. If left empty (default to 1s)
	Delay time.Duration
}

type IntRange struct {
	// start of the range (inclusive)
	Start int64
	// end of the range (exclusive)
	End int64
}

type NoHealthCheck struct {
}

type Payload struct {
	// Text payload
	Text string
	// Binary payload.
	Binary []byte
}

type ProgramHealthCheck struct {
	// contains filtered or unexported fields
}

type ProgramOpt struct {
	// The path to the executable.
	Path string
	// The arguments to pass to the executable.
	Args []string
	// Options to pass to the executable.
	Options map[string]any
	// Timeout program finish. If left empty (default to 5s)
	Timeout time.Duration
	// TlsEnabled set to true if the gRPC health check request should be sent over TLS.
	TlsEnabled bool
	// Tls configuration for program
	ProgramTlsConfig *ProgramTlsOpt
	// AltPort specifies the port to use for gRPC health check requests.
	// If left empty it taks the port from host during check.
	AltPort uint32
}

type ProgramTlsOpt struct {
	// Set to true to not verify the server's certificate. This is strongly discouraged.
	InsecureSkipVerify bool
	// ServerName is used to verify the hostname on the returned
	ServerName string
	// Trusted CA certificates for verifying the server certificate. It must be in pem format
	RootCAs []string
}

type TcpHealthCheck struct {
	// contains filtered or unexported fields
}

type TcpOpt struct {
	// TCP specific payload.
	// Empty payloads imply a connect-only health check.
	Send *Payload
	// When checking the response, “fuzzy” matching is performed such that each
	// binary block must be found, and in the order specified, but not
	// necessarily contiguous.
	Receive []*Payload
	// Timeout for connection and for each receive data. If left empty (default to 5s)
	Timeout time.Duration
	// TlsEnabled set to true if the gRPC health check request should be sent over TLS.
	TlsEnabled bool
	// TlsConfig specifies the TLS configuration to use for TLS enabled gRPC health check requests.
	TlsConfig *tls.Config
	// AltPort specifies the port to use for gRPC health check requests.
	// If left empty it taks the port from host during check.
	AltPort uint32
}

type UdpHealthCheck struct {
	// contains filtered or unexported fields
}

type UdpOpt struct {
	// TCP specific payload.
	// Empty payloads imply a connect-only health check.
	// If left empty (default to "test-gohc")
	Send *Payload
	// When checking the response, “fuzzy” matching is performed such that each
	// binary block must be found, and in the order specified, but not
	// necessarily contiguous.
	Receive []*Payload
	// Timeout for port unreachable response or for each receive read deadline. If left empty (default to 5s)
	Timeout time.Duration
	// PingTimeout specifies the timeout for ICMP requests. If left empty (default to 5s)
	PingTimeout time.Duration
	// Delay specifies the delay between ICMP requests. If left empty (default to 1s)
	Delay time.Duration
	// AltPort specifies the port to use for gRPC health check requests.
	// If left empty it taks the port from host during check.
	AltPort uint32
}