Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

middleware

package

Go to main page

Versions in this module

v0

v0.1.3

Aug 12, 2026

Changes in this version

+ func WithRouteFunc(ctx context.Context, resolve func() string) context.Context

v0.1.2

Aug 12, 2026

Changes in this version

+ func IsOperationalPath(path string) bool

+ func QuietSuccessfulProbes(r *http.Request, status int) bool

+ func RequestLoggingWith(opts LoggingOptions) func(http.Handler) http.Handler

+ type LoggingOptions struct

+ Logger *slog.Logger

+ Quiet func(r *http.Request, status int) bool

+ ServiceName string

v0.1.1

Aug 12, 2026

Changes in this version

+ const APIKeyHeader

+ const MetricsPath

+ const ScopeAll

+ const StatusHealthy

+ const StatusUnhealthy

+ var DefaultCORSHeaders = []string

+ var DefaultCORSMethods = []string

+ var RateLimitConfigs = map[EndpointType]RateLimitConfig

+ func CORS(opts CORSOptions) func(http.Handler) http.Handler

+ func CORSWithOrigins(allowedOrigins []string) func(http.Handler) http.Handler

+ func ClientIP(r *http.Request) string

+ func ClientIdentifier(r *http.Request) string

+ func HasScope(ctx context.Context, scope string) bool

+ func HealthHandler(serviceName string, checks ...HealthChecker) http.Handler

+ func IsServiceAuthenticated(ctx context.Context) bool

+ func Metrics(serviceName string) func(http.Handler) http.Handler

+ func MetricsHandler() http.Handler

+ func ObserveRequest(serviceName, method, route string, status int, d time.Duration)

+ func OptionalServiceAuth(validator ServiceKeyValidator) func(http.Handler) http.Handler

+ func RateLimit(redisClient *rediscluster.ClusterClient, serviceName string) func(http.Handler) http.Handler

+ func ReadinessHandler(serviceName string, checks ...HealthChecker) http.Handler

+ func RecordRateLimitCheck(serviceName, endpointType, result string)

+ func RecordRateLimitError(serviceName, endpointType, errorMsg string)

+ func RecordRateLimitExceeded(serviceName, endpointType, clientID string)

+ func RequestLogging(serviceName string) func(http.Handler) http.Handler

+ func RequestLoggingTo(logger *slog.Logger, serviceName string) func(http.Handler) http.Handler

+ func RequireServiceScope(requiredScope string) func(http.Handler) http.Handler

+ func Route(r *http.Request) string

+ func ServiceAuthOrUserAuth(validator ServiceKeyValidator, userAuth func(http.Handler) http.Handler) func(http.Handler) http.Handler

+ func ServiceAuthRequired(validator ServiceKeyValidator) func(http.Handler) http.Handler

+ func ServiceKeyFromRequest(r *http.Request) string

+ func ServiceName(ctx context.Context) (string, bool)

+ func TraceFromRequest(r *http.Request) *httpclient.TraceContext

+ func Tracing() func(http.Handler) http.Handler

+ func TrackInFlight(serviceName string) func()

+ func UserID(ctx context.Context) (string, bool)

+ func WithAuthType(ctx context.Context, at AuthType) context.Context

+ func WithRoute(ctx context.Context, pattern string) context.Context

+ func WithServiceIdentity(ctx context.Context, info *ServiceKeyInfo) context.Context

+ func WithUserID(ctx context.Context, id string) context.Context

+ type AuthType string

+ const AuthTypeService

+ const AuthTypeUser

+ type CORSOptions struct

+ AllowCredentials bool

+ AllowedHeaders []string

+ AllowedMethods []string

+ AllowedOrigins []string

+ MaxAge time.Duration

+ type CheckResult struct

+ Duration string

+ LastChecked int64

+ Message string

+ Status string

+ type DatabaseHealthChecker struct

+ func NewDatabaseHealthChecker(name string, ping func() error) *DatabaseHealthChecker

+ func (d *DatabaseHealthChecker) Check() (string, string, string)

+ type DatabaseMetrics struct

+ ConnectionsActive prometheus.Gauge

+ QueriesTotal prometheus.CounterVec

+ QueryDuration prometheus.HistogramVec

+ func NewDatabaseMetrics(serviceName string) *DatabaseMetrics

+ type EndpointType string

+ const EndpointTypeAdmin

+ const EndpointTypeAuth

+ const EndpointTypeData

+ const EndpointTypeHealthy

+ const EndpointTypeInternal

+ const EndpointTypePublic

+ const EndpointTypeUpload

+ func ClassifyEndpoint(path, method string) EndpointType

+ type EventBusHealthChecker struct

+ func NewEventBusHealthChecker(name string, ping func() error) *EventBusHealthChecker

+ func (e *EventBusHealthChecker) Check() (string, string, string)

+ type HealthCheckResponse struct

+ Checks map[string]CheckResult

+ Service string

+ Status string

+ Timestamp int64

+ Uptime int64

+ Version string

+ type HealthChecker interface

+ Check func() (name string, status string, message string)

+ type RateLimitConfig struct

+ BlockDuration time.Duration

+ BurstAllowance int

+ RequestsPerMinute int

+ type RateLimiter struct

+ func NewRateLimiter(redisClient *rediscluster.ClusterClient, serviceName string) *RateLimiter

+ func (rl *RateLimiter) IsAllowed(ctx context.Context, clientID string, endpointType EndpointType) (bool, int, error)

+ type ServiceHealthChecker struct

+ func NewServiceHealthChecker(name, url string, checker func() error) *ServiceHealthChecker

+ func (s *ServiceHealthChecker) Check() (string, string, string)

+ type ServiceKeyInfo struct

+ ExpiresAt *time.Time

+ Scopes []string

+ ServiceName string

+ func ServiceIdentity(ctx context.Context) (*ServiceKeyInfo, bool)

+ type ServiceKeyValidator interface

+ ValidateServiceKey func(apiKey string) (*ServiceKeyInfo, error)