health

package

v1.6.3 Latest Latest Go to latest Published: Nov 7, 2022 License: Apache-2.0 Imports: 9 Imported by: 0

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

Package health provides handler for health checks.

This section is empty.

This section is empty.

func GetVersion() string

GetVersion returns service's version and commit.

func SetupRouter(r chi.Router, p ...Pinger)

SetupRouter setups all pingers to /health.

type PingFunc func(ctx context.Context) error

PingFunc is wrapper for raw func.

func (f PingFunc) Ping(ctx context.Context) error

Ping ...

type Pinger interface {
	Ping(ctx context.Context) error
}

Pinger pings external service.

type VersionResponse struct {
	Version string `json:"version"`
	Commit  string `json:"commit"`
}

VersionResponse ...