probe

package

v0.0.0-...-bb45038 Latest Latest Go to latest Published: Apr 26, 2024 License: Apache-2.0 Imports: 8 Imported by: 3

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type HealthService interface {
	Register(server *grpc.Server)
	SetServing()
	Shutdown()
}

func NewHealthService() HealthService

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

LivenessProbe wraps a liveness probe handler.

func (p *LivenessProbe) LivenessHandler(w http.ResponseWriter, r *http.Request)

LivenessHandler writes back the HTTP status code 200 if the operator is ready, and 500 otherwise.

func (p *LivenessProbe) Lock()

Lock the probe, preventing the LivenessHandler from responding to requests.

func (p *LivenessProbe) Unlock()

Unlock the probe, allowing the LivenessHandler to respond to requests.

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

ReadyProbe wraps a readiness probe handler.

func (p *ReadyProbe) IsReady() bool

IsReady returns true when the given probe has been marked ready.

func (p *ReadyProbe) ReadyHandler(w http.ResponseWriter, r *http.Request)

ReadyHandler writes back the HTTP status code 200 if the operator is ready, and 500 otherwise.

func (p *ReadyProbe) SetReady()

SetReady marks the probe as ready.