health

Documentation

Index

• func GRPCProbe(config GRPCProbeConfigOptions) error
• func HTTPProbe(config HTTPProbeConfigOptions) error
• func ProbeHandler(prober func() bool, tracingEnabled bool) http.HandlerFunc
• func TCPProbe(config TCPProbeConfigOptions) error
• type GRPCProbeConfigOptions
• type HTTPProbeConfigOptions
• type TCPProbeConfigOptions

Functions

func GRPCProbe

func GRPCProbe(config GRPCProbeConfigOptions) error

GRPCProbe checks that gRPC connection can be established to the address.

func HTTPProbe

func HTTPProbe(config HTTPProbeConfigOptions) error

HTTPProbe checks that HTTP connection can be established to the address.

func ProbeHandler

func ProbeHandler(prober func() bool, tracingEnabled bool) http.HandlerFunc

ProbeHandler returns a http.HandlerFunc that responds to health checks. This handler assumes the Knative Probe Header will be passed.

func TCPProbe

func TCPProbe(config TCPProbeConfigOptions) error

TCPProbe checks that a TCP socket to the address can be opened. Did not reuse k8s.io/kubernetes/pkg/probe/tcp to not create a dependency on klog.

Types

type GRPCProbeConfigOptions

type GRPCProbeConfigOptions struct {
	Timeout time.Duration
	*corev1.GRPCAction
	KubeMajor string
	KubeMinor string
}

GRPCProbeConfigOptions holds the gRPC probe config options

type HTTPProbeConfigOptions

type HTTPProbeConfigOptions struct {
	Timeout time.Duration
	*corev1.HTTPGetAction
	KubeMajor     string
	KubeMinor     string
	MaxProtoMajor int
}

HTTPProbeConfigOptions holds the HTTP probe config options

type TCPProbeConfigOptions

type TCPProbeConfigOptions struct {
	SocketTimeout time.Duration
	Address       string
}

TCPProbeConfigOptions holds the TCP probe config options