Rene Nochebuena
c4ef1948f6
Introduces code.nochebuena.dev/einherjar/web — the HTTP transport layer of the
Einherjar framework. Absorbs httpserver, httpmw, and httputil from micro-lib,
replacing gorilla/mux with chi, adopting SecurityBag-native middleware, and
centralizing error handling through a single httputil.Error function.
server:
- Server interface — embeds lifecycle.Component and chi.Router
- Config struct (EINHERJAR_SERVER_* env vars); DefaultConfig
- New(logger, cfg, opts...) Server; WithMiddleware option
- Binds TCP synchronously in OnStart; logs "server: listening" on success
- Graceful shutdown within ShutdownTimeout on OnStop
mw:
- Recover — catches panics, returns 500, logs at Error
- RequestID — injects UUID v7 (UUID v4 fallback) into context and X-Request-ID header
- RequestLogger — structured access log per request
- CORS / CORSAllowAll — chi-based, applied only when origins non-empty
- IPRateLimit / UserRateLimit — pluggable RateLimiterStore interface
- InMemoryRateLimiterStore — token-bucket backed by golang.org/x/time/rate;
background goroutine evicts stale entries every 5 minutes
- StatusRecorder — wraps ResponseWriter to capture HTTP status code
httputil:
- Handle[Req, Res] / HandleNoBody[Res] / HandleEmpty[Req] — generic handler adapters
- Error(logger, w, r, err) — derives log level from status (≥500→Error, 4xx→Warn,
499→Info); writes standardized JSON body; logz enriches *xerrors.Err automatically
- JSON(w, status, v) / NoContent(w) — response helpers
- HandlerFunc adapter type
health:
- NewHandler / NewHandlerWithConfig — runs all Checkable checks concurrently;
returns JSON {status, components} with per-component latency and error
- Config struct (EINHERJAR_HEALTH_CHECK_TIMEOUT, default 5s)
Root factory:
- web.New(logger, cfg...) Server — composes Recover+RequestID+RequestLogger+CORS
in outermost-first order; CORS applied only when AllowedOrigins non-empty
- server.Server interface and web/server/identifiable.go: embeds observability.Identifiable;
ModulePath and ModuleVersion read via runtime/debug.ReadBuildInfo() — prints in launcher banner
24 lines
843 B
Go
24 lines
843 B
Go
// Package health provides a concurrent health check HTTP handler.
|
|
//
|
|
// The handler runs all registered checks in parallel, collects results within
|
|
// a configurable timeout, and returns a structured JSON response. It maps
|
|
// directly onto Kubernetes liveness and readiness probes.
|
|
//
|
|
// Components register themselves by implementing
|
|
// [observability.Checkable] from einherjar/contracts — no adapter needed.
|
|
//
|
|
// - [observability.LevelCritical]: if DOWN, overall status is DOWN (503)
|
|
// - [observability.LevelDegraded]: if DOWN, overall status is DEGRADED (200)
|
|
//
|
|
// # Example
|
|
//
|
|
// srv.Get("/health", health.NewHandler(logger, db, cache, storage))
|
|
//
|
|
// Or with custom timeout:
|
|
//
|
|
// srv.Get("/health", health.NewHandlerWithConfig(logger,
|
|
// health.Config{CheckTimeout: 3 * time.Second},
|
|
// db, cache,
|
|
// ))
|
|
package health
|