health

package

v0.0.0-...-3f71ca0 Latest Latest Go to latest Published: May 2, 2024 License: Apache-2.0 Imports: 14 Imported by: 15

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

View Source

const (
	InfluxStatusOK = "pass"
)

This section is empty.

This section is empty.

type Check func(context.Context) error

func Influx(client influxdb2.Client) Check

Influx do a healtheck in influx Cloud version.

func InfluxOSS(client influxdb2.Client) Check

InfluxOSS do a healtheckIN influx OSS version.

func Mongo(db *mongo.Database) Check

func Noop() Check

func Redis(client *redis.Client) Check

Redis does a ping.

func SNS(config aws.Config, url string) Check

func SQS(config aws.Config, url string) Check

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

Controller definition.

func NewController(checks []Check, logger *zap.Logger) *Controller

NewController creates a Controller instance.

func (c *Controller) HealthCheck(ctx *fiber.Ctx) error

HealthCheck handler for the endpoint /health.

func (c *Controller) ReadyCheck(ctx *fiber.Ctx) error

ReadyCheck handler for the endpoint /ready.

type HealthCheck struct {
	Status string `json:"status"`
}

type ReadyCheck struct {
	Ready string `json:"ready"`
}