probe

package

v1.14.0 Latest Latest Go to latest Published: Mar 25, 2024 License: Apache-2.0 Imports: 8 Imported by: 8

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.

func WithReadinessHandler(h http.Handler) interface{ Option }

WithReadinessHandler is an option to set a readiness handler for probe server.

type Option interface {
	SetOption(*Server)
}

Option is ued to set probe server's options.

type Server struct {
	lifecycle.Readiness
	// contains filtered or unexported fields
}

Server is a http server for service probe.

func New(port int, opts ...Option) *Server

New creates a new probe server.

func (s *Server) Start(_ context.Context) error

Start starts the probe server and starts returning success status on liveness endpoint.

func (s *Server) Stop(ctx context.Context) error

Stop shutdown the probe server.