healthx

package

v0.0.96 Latest Latest Go to latest Published: Aug 14, 2023 License: Apache-2.0 Imports: 3 Imported by: 7

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

Repository

github.com/factly/x

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Alive(w http.ResponseWriter, r *http.Request)
func Ready(readyCheckers ReadyCheckers) func(w http.ResponseWriter, r *http.Request)
func RegisterRoutes(r *chi.Mux, readyCheckers ReadyCheckers)
type ReadyChecker
type ReadyCheckers

Constants ¶

View Source

const (
	// AliveCheckPath is the path where information about the life state of the instance is provided.
	AliveCheckPath = "/health/alive"
	// ReadyCheckPath is the path where information about the ready state of the instance is provided.
	ReadyCheckPath = "/health/ready"
)

Variables ¶

This section is empty.

Functions ¶

func Alive ¶

func Alive(w http.ResponseWriter, r *http.Request)

Alive handler

func Ready ¶

func Ready(readyCheckers ReadyCheckers) func(w http.ResponseWriter, r *http.Request)

Ready handler

func RegisterRoutes ¶

func RegisterRoutes(r *chi.Mux, readyCheckers ReadyCheckers)

RegisterRoutes registers health check routes

Types ¶

type ReadyChecker ¶

type ReadyChecker func() error

ReadyChecker should return an error if the component is not ready yet.

type ReadyCheckers ¶

type ReadyCheckers map[string]ReadyChecker

ReadyCheckers is a map of ReadyCheckers.

Source Files ¶

View all Source files

handler.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL