Health Check

Middleware that adds liveness, readiness, and startup probes to Fiber apps. It provides a generic handler you can mount on any route, with constants for the conventional /livez, /readyz, and /startupz endpoints.

Overview

Register the middleware on any endpoint you want to expose a probe on. The package exports constants for the conventional liveness, readiness, and startup endpoints:

app.Get(healthcheck.LivenessEndpoint, healthcheck.New())
app.Get(healthcheck.ReadinessEndpoint, healthcheck.New())
app.Get(healthcheck.StartupEndpoint, healthcheck.New())

By default the probe returns true, so each endpoint responds with 200 OK; returning false yields 503 Service Unavailable.

The default response format is plain text, but you can configure the middleware to return responses in JSON, XML, MessagePack, or CBOR formats.

Liveness: Checks if the server is running.
Readiness: Checks if the application is ready to handle requests.
Startup: Checks if the application has completed its startup sequence.

Signatures

func New(config ...Config) fiber.Handler

Examples

Import the middleware package:

import (
    "github.com/gofiber/fiber/v3"
    "github.com/gofiber/fiber/v3/middleware/healthcheck"
)

After your app is initialized, register the middleware on the endpoints you want to expose:

// Use the default probe on the conventional endpoints
app.Get(healthcheck.LivenessEndpoint, healthcheck.New())
app.Get(healthcheck.ReadinessEndpoint, healthcheck.New(healthcheck.Config{
    Probe: func(c fiber.Ctx) bool {
        return serviceA.Ready() && serviceB.Ready()
    },
}))
app.Get(healthcheck.StartupEndpoint, healthcheck.New())

// Register a custom endpoint
app.Get("/healthz", healthcheck.New())

The middleware responds only to GET. Use app.All to expose a probe on every method; other methods fall through to the next handler:

app.All("/healthz", healthcheck.New())

Response Formats

You can configure the response format using the ResponseFormat field in the config:

import (
    "github.com/gofiber/fiber/v3"
    "github.com/gofiber/fiber/v3/middleware/healthcheck"
)

// JSON format
app.Get(healthcheck.LivenessEndpoint, healthcheck.New(healthcheck.Config{
    ResponseFormat: healthcheck.FormatJSON,
}))
// Response: {"status":"OK"}

// XML format
app.Get(healthcheck.ReadinessEndpoint, healthcheck.New(healthcheck.Config{
    ResponseFormat: healthcheck.FormatXML,
}))
// Response: <healthResponse><status>OK</status></healthResponse>

Note: MessagePack and CBOR formats require configuring the appropriate encoders in your Fiber app:

import (
    "github.com/fxamacker/cbor/v2"
    "github.com/gofiber/fiber/v3"
    "github.com/gofiber/fiber/v3/middleware/healthcheck"
    "github.com/shamaton/msgpack/v3"
)

app := fiber.New(fiber.Config{
    MsgPackEncoder: msgpack.Marshal,
    CBOREncoder:    cbor.Marshal,
})

app.Get(healthcheck.LivenessEndpoint, healthcheck.New(healthcheck.Config{
    ResponseFormat: healthcheck.FormatMsgPack,
}))

Config

type Config struct {
    // Next defines a function to skip this middleware when it returns true. If this function returns true
    // and no other handlers are defined for the route, Fiber will return a status 404 Not Found, since
    // no other handlers were defined to return a different status.
    //
    // Optional. Default: nil
    Next func(fiber.Ctx) bool

    // Probe is executed to determine the current health state. It can be used for
    // liveness, readiness or startup checks. Returning true indicates the application
    // is healthy.
    //
    // Optional. Default: func(c fiber.Ctx) bool { return true }
    Probe func(fiber.Ctx) bool

    // ResponseFormat specifies the format of the healthcheck response.
    // Supported formats: Text (default), JSON, XML, MsgPack, CBOR.
    //
    // Optional. Default: FormatText
    ResponseFormat ResponseFormat
}

Response Format Constants

type ResponseFormat int

const (
    FormatText    ResponseFormat = iota // Plain text response (default)
    FormatJSON                          // JSON response
    FormatXML                           // XML response
    FormatMsgPack                       // MessagePack response
    FormatCBOR                          // CBOR response
)

Default Config

The default configuration used by this middleware is defined as follows:

func defaultProbe(_ fiber.Ctx) bool { return true }

var ConfigDefault = Config{
    Next:  nil,
    Probe: defaultProbe,
}