http

package
v0.3.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 10, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type HealthHandler

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

func NewHealthHandler

func NewHealthHandler(checks ...ReadinessCheck) *HealthHandler

func (*HealthHandler) Liveness

func (h *HealthHandler) Liveness(c *fiber.Ctx) error

Liveness godoc @Summary Liveness probe @Description Reports whether the process is alive. @Tags system @Produce json @Success 200 {object} map[string]string @Router /healthz [get]

func (*HealthHandler) Readiness

func (h *HealthHandler) Readiness(c *fiber.Ctx) error

Readiness godoc @Summary Readiness probe @Description Reports whether the process is ready to serve traffic. @Tags system @Produce json @Success 200 {object} map[string]string @Failure 503 {object} map[string]string @Router /readyz [get]

type ReadinessCheck added in v0.3.4

type ReadinessCheck struct {
	Name string
	Ping func(ctx context.Context) error
}

type VersionHandler

type VersionHandler struct{}

func NewVersionHandler

func NewVersionHandler() *VersionHandler

func (*VersionHandler) Handle

func (h *VersionHandler) Handle(c *fiber.Ctx) error

Handle godoc @Summary Build version @Description Returns build/version information for the running binary. @Tags system @Produce json @Success 200 {object} version.Info @Router /__/version [get]

Jump to

Keyboard shortcuts

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