Skip to content

aschenmaker/fiber-health-check

Repository files navigation

Fiber-health-check 🩺 Middleware

codecov License GoDoc Go Report Card

🩺Fiber-health-check middleware support health-check forFiber⚡️ framework.

Signatures

funcNew(config...Config) fiber.Handler

How to use

Frist import the midllware from Github,

go get -u github /gofiber/v2
go get -u github /aschenmaker/fiber-health-check

Then create a Fiber app withapp:= fiber.New().

Default Config

app.Use(healthcheck.New())

Custom Config

app.Use(healthcheck.New(
HeaderName:"X-Custom-Header",
HeaderValue:"customValue",
ResponseCode:http.StatusTeapot,
ResponseText:"teapot",
))

Config

// Config defines the config for middleware
typeConfigstruct{
// HeaderName defines the health check header key
//
// Optional. Default: "X-Health-Check"
HeaderNamestring
// HeaderValue defines the health check header val
//
// Optional. Default: "1"
HeaderValuestring
// ResponseCode defines the health check response code
//
// Optional. Default: http.StatusOK
ResponseCodeint
// ResponseText defines the health check response description
//
// Optional. Default: "ok"
ResponseTextstring
}

About

A health check middleware for fiber web framework.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages