Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func HealthRoute ¶ added in v1.0.0
HealthRoute registers a lightweight health check endpoint.
func KubernetesProbeRoutes ¶ added in v1.0.0
func KubernetesProbeRoutes(a *fiber.App, checks ...ReadinessCheck)
KubernetesProbeRoutes registers liveness and readiness endpoints for Kubernetes probes.
func LivezRoute ¶ added in v1.0.0
LivezRoute registers a lightweight liveness endpoint.
func NotFoundRoute ¶
NotFoundRoute func for describe 404 Error route.
func ReadyzRoute ¶ added in v1.0.0
func ReadyzRoute(a *fiber.App, checks ...ReadinessCheck)
ReadyzRoute registers a readiness endpoint with pluggable checks.
Types ¶
type ReadinessCheck ¶ added in v1.0.0
type ReadinessCheck func() error
ReadinessCheck is a custom function that verifies whether an API dependency is ready. Return nil when healthy, or an error when the dependency is unavailable.
Source Files
Click to show internal directories.
Click to hide internal directories.