GOMODULES
/
fiber
mirror of https://github.com/gofiber/fiber.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

🧹 chore: Simplify HealthCheck middleware (#3380) 

* Simplify middleware

* Rename default endpoints
pull/3296/merge
Juan Calderon-Perez 2025-03-30 05:46:52 -04:00 committed by GitHub
parent e90fe8afbc
commit 75281bd874
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 52 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/middleware/healthcheck.md
View File

@ -27,7 +27,7 @@ Liveness, readiness and startup probes middleware for [Fiber](https://github.com
## Signatures
```go
func NewHealthChecker(config Config) fiber.Handler
func New(config Config) fiber.Handler
```
## Examples
@ -41,38 +41,44 @@ import(
)
```
After you initiate your [Fiber](https://github.com/gofiber/fiber) app, you can use the following possibilities:
After you initiate your [Fiber](https://github.com/gofiber/fiber) app, you can use the following options:
```go
// Provide a minimal config for liveness check
app.Get(healthcheck.DefaultLivenessEndpoint, healthcheck.NewHealthChecker())
app.Get(healthcheck.LivenessEndpoint, healthcheck.New())
// Provide a minimal config for readiness check
app.Get(healthcheck.DefaultReadinessEndpoint, healthcheck.NewHealthChecker())
app.Get(healthcheck.ReadinessEndpoint, healthcheck.New())
// Provide a minimal config for startup check
app.Get(healthcheck.DefaultStartupEndpoint, healthcheck.NewHealthChecker())
app.Get(healthcheck.StartupEndpoint, healthcheck.New())
// Provide a minimal config for check with custom endpoint
app.Get("/live", healthcheck.NewHealthChecker())
app.Get("/live", healthcheck.New())
// Or extend your config for customization
app.Get(healthcheck.DefaultLivenessEndpoint, healthcheck.NewHealthChecker(healthcheck.Config{
app.Get(healthcheck.LivenessEndpoint, healthcheck.New(healthcheck.Config{
Probe: func(c fiber.Ctx) bool {
return true
},
}))
// And it works the same for readiness, just change the route
app.Get(healthcheck.DefaultReadinessEndpoint, healthcheck.NewHealthChecker(healthcheck.Config{
app.Get(healthcheck.ReadinessEndpoint, healthcheck.New(healthcheck.Config{
Probe: func(c fiber.Ctx) bool {
return true
},
}))
// And it works the same for startup, just change the route
app.Get(healthcheck.DefaultStartupEndpoint, healthcheck.NewHealthChecker(healthcheck.Config{
app.Get(healthcheck.StartupEndpoint, healthcheck.New(healthcheck.Config{
Probe: func(c fiber.Ctx) bool {
return true
},
}))
// With a custom route and custom probe
app.Get("/live", healthcheck.NewHealthChecker(healthcheck.Config{
app.Get("/live", healthcheck.New(healthcheck.Config{
Probe: func(c fiber.Ctx) bool {
return true
},
@ -81,7 +87,7 @@ app.Get("/live", healthcheck.NewHealthChecker(healthcheck.Config{
// It can also be used with app.All, although it will only respond to requests with the GET method
// in case of calling the route with any method which isn't GET, the return will be 404 Not Found when app.All is used
// and 405 Method Not Allowed when app.Get is used
app.All(healthcheck.DefaultReadinessEndpoint, healthcheck.NewHealthChecker(healthcheck.Config{
app.All(healthcheck.ReadinessEndpoint, healthcheck.New(healthcheck.Config{
Probe: func(c fiber.Ctx) bool {
return true
},
@ -108,7 +114,7 @@ type Config struct {
// initialization and readiness checks
//
// Optional. Default: func(c fiber.Ctx) bool { return true }
Probe HealthChecker
Probe func(fiber.Ctx) bool
}
```
@ -117,7 +123,7 @@ type Config struct {
The default configuration used by this middleware is defined as follows:
```go
func defaultProbe(fiber.Ctx) bool { return true }
func defaultProbe(_ fiber.Ctx) bool { return true }
var ConfigDefault = Config{
Probe: defaultProbe,

8
docs/whats_new.md
View File

@ -1564,25 +1564,25 @@ With the new version, each health check endpoint is configured separately, allow
// after
// Default liveness endpoint configuration
app.Get(healthcheck.DefaultLivenessEndpoint, healthcheck.NewHealthChecker(healthcheck.Config{
app.Get(healthcheck.LivenessEndpoint, healthcheck.New(healthcheck.Config{
Probe: func(c fiber.Ctx) bool {
return true
},
}))
// Default readiness endpoint configuration
app.Get(healthcheck.DefaultReadinessEndpoint, healthcheck.NewHealthChecker())
app.Get(healthcheck.ReadinessEndpoint, healthcheck.New())
// New default startup endpoint configuration
// Default endpoint is /startupz
app.Get(healthcheck.DefaultStartupEndpoint, healthcheck.NewHealthChecker(healthcheck.Config{
app.Get(healthcheck.StartupEndpoint, healthcheck.New(healthcheck.Config{
Probe: func(c fiber.Ctx) bool {
return serviceA.Ready() && serviceB.Ready() && ...
},
}))
// Custom liveness endpoint configuration
app.Get("/live", healthcheck.NewHealthChecker())
app.Get("/live", healthcheck.New())
```
#### Monitor

12
middleware/healthcheck/config.go
View File

@ -18,18 +18,18 @@ type Config struct {
// the application is in a state where it can handle requests (e.g., the server is up and running).
//
// Optional. Default: func(c fiber.Ctx) bool { return true }
Probe HealthChecker
Probe func(fiber.Ctx) bool
}
const (
DefaultLivenessEndpoint = "/livez"
DefaultReadinessEndpoint = "/readyz"
DefaultStartupEndpoint = "/startupz"
LivenessEndpoint = "/livez"
ReadinessEndpoint = "/readyz"
StartupEndpoint = "/startupz"
)
func defaultProbe(fiber.Ctx) bool { return true }
func defaultProbe(_ fiber.Ctx) bool { return true }
func defaultConfigV3(config ...Config) Config {
func defaultConfig(config ...Config) Config {
if len(config) < 1 {
return Config{
Probe: defaultProbe,

7
middleware/healthcheck/healthcheck.go
View File

@ -4,11 +4,8 @@ import (
"github.com/gofiber/fiber/v3"
)
// HealthChecker defines a function to check liveness or readiness of the application
type HealthChecker func(fiber.Ctx) bool
func NewHealthChecker(config ...Config) fiber.Handler {
cfg := defaultConfigV3(config...)
func New(config ...Config) fiber.Handler {
cfg := defaultConfig(config...)
return func(c fiber.Ctx) error {
// Don't execute middleware if Next returns true

42
middleware/healthcheck/healthcheck_test.go
View File

@ -34,9 +34,9 @@ func Test_HealthCheck_Strict_Routing_Default(t *testing.T) {
StrictRouting: true,
})
app.Get(DefaultLivenessEndpoint, NewHealthChecker())
app.Get(DefaultReadinessEndpoint, NewHealthChecker())
app.Get(DefaultStartupEndpoint, NewHealthChecker())
app.Get(LivenessEndpoint, New())
app.Get(ReadinessEndpoint, New())
app.Get(StartupEndpoint, New())
shouldGiveOK(t, app, "/readyz")
shouldGiveOK(t, app, "/livez")
@ -53,9 +53,9 @@ func Test_HealthCheck_Default(t *testing.T) {
t.Parallel()
app := fiber.New()
app.Get(DefaultLivenessEndpoint, NewHealthChecker())
app.Get(DefaultReadinessEndpoint, NewHealthChecker())
app.Get(DefaultStartupEndpoint, NewHealthChecker())
app.Get(LivenessEndpoint, New())
app.Get(ReadinessEndpoint, New())
app.Get(StartupEndpoint, New())
shouldGiveOK(t, app, "/readyz")
shouldGiveOK(t, app, "/livez")
@ -73,12 +73,12 @@ func Test_HealthCheck_Custom(t *testing.T) {
app := fiber.New()
c1 := make(chan struct{}, 1)
app.Get("/live", NewHealthChecker(Config{
app.Get("/live", New(Config{
Probe: func(_ fiber.Ctx) bool {
return true
},
}))
app.Get("/ready", NewHealthChecker(Config{
app.Get("/ready", New(Config{
Probe: func(_ fiber.Ctx) bool {
select {
case <-c1:
@ -88,7 +88,7 @@ func Test_HealthCheck_Custom(t *testing.T) {
}
},
}))
app.Get(DefaultStartupEndpoint, NewHealthChecker(Config{
app.Get(StartupEndpoint, New(Config{
Probe: func(_ fiber.Ctx) bool {
return false
},
@ -123,12 +123,12 @@ func Test_HealthCheck_Custom_Nested(t *testing.T) {
app := fiber.New()
c1 := make(chan struct{}, 1)
app.Get("/probe/live", NewHealthChecker(Config{
app.Get("/probe/live", New(Config{
Probe: func(_ fiber.Ctx) bool {
return true
},
}))
app.Get("/probe/ready", NewHealthChecker(Config{
app.Get("/probe/ready", New(Config{
Probe: func(_ fiber.Ctx) bool {
select {
case <-c1:
@ -164,15 +164,15 @@ func Test_HealthCheck_Next(t *testing.T) {
app := fiber.New()
checker := NewHealthChecker(Config{
checker := New(Config{
Next: func(_ fiber.Ctx) bool {
return true
},
})
app.Get(DefaultLivenessEndpoint, checker)
app.Get(DefaultReadinessEndpoint, checker)
app.Get(DefaultStartupEndpoint, checker)
app.Get(LivenessEndpoint, checker)
app.Get(ReadinessEndpoint, checker)
app.Get(StartupEndpoint, checker)
// This should give not found since there are no other handlers to execute
// so it's like the route isn't defined at all
@ -184,9 +184,9 @@ func Test_HealthCheck_Next(t *testing.T) {
func Benchmark_HealthCheck(b *testing.B) {
app := fiber.New()
app.Get(DefaultLivenessEndpoint, NewHealthChecker())
app.Get(DefaultReadinessEndpoint, NewHealthChecker())
app.Get(DefaultStartupEndpoint, NewHealthChecker())
app.Get(LivenessEndpoint, New())
app.Get(ReadinessEndpoint, New())
app.Get(StartupEndpoint, New())
h := app.Handler()
fctx := &fasthttp.RequestCtx{}
@ -206,9 +206,9 @@ func Benchmark_HealthCheck(b *testing.B) {
func Benchmark_HealthCheck_Parallel(b *testing.B) {
app := fiber.New()
app.Get(DefaultLivenessEndpoint, NewHealthChecker())
app.Get(DefaultReadinessEndpoint, NewHealthChecker())
app.Get(DefaultStartupEndpoint, NewHealthChecker())
app.Get(LivenessEndpoint, New())
app.Get(ReadinessEndpoint, New())
app.Get(StartupEndpoint, New())
h := app.Handler()