gin

README

Middleware

Package contains common shared Go Gin Middleware.

Documentation

Index

• func FromContextOrDiscard(c *gin.Context) logr.Logger
• func Logger(cfg LogConfig) gin.HandlerFunc
• func NewEngine(cfg Config) *gogin.Engine
• type Config
  • func DefaultConfig() Config
• type LogConfig
• type MetricsConfig

Functions

func FromContextOrDiscard

func FromContextOrDiscard(c *gin.Context) logr.Logger

func Logger

func Logger(cfg LogConfig) gin.HandlerFunc

func NewEngine

func NewEngine(cfg Config) *gogin.Engine

Types

type Config

type Config struct {
	LogConfig     LogConfig
	MetricsConfig MetricsConfig
}

func DefaultConfig

func DefaultConfig() Config

type LogConfig

type LogConfig struct {
	// Logger instance to output request logs.
	Logger logr.Logger
	// Regex used to filter out request logs.
	PathFilter *regexp.Regexp
	// Should request logs should include latency.
	IncludeLatency bool
	// Should request logs should include client IP.
	IncludeClientIP bool
	// Context keys to include in request log.
	IncludeKeys []string
}

type MetricsConfig

type MetricsConfig struct {
	// Service is used to differentiate between multiple metrics handlers.
	Service string
	// Handler ID to use when using dynamic path parameters.
	HandlerID string
}