gin

package

v2.16.21 Latest Latest Go to latest Published: Aug 2, 2026 License: Apache-2.0, Apache-2.0 Imports: 11 Imported by: 0

Details

Package gin defines a set of basic building blocks for instrumenting KrakenD gateways built using the gin router

This section is empty.

This section is empty.

func NewHTTPHandlerFactory(rm *metrics.RouterMetrics, hf krakendgin.HandlerFactory) krakendgin.HandlerFactory

NewHTTPHandlerFactory wraps a handler factory adding some simple instrumentation to the generated handlers

type Metrics struct {
	*metrics.Metrics
}

Metrics is the component that manages all the metrics for the gin-based gateways

func New(ctx context.Context, e config.ExtraConfig, l logging.Logger) *Metrics

New creates a new metrics producer with support for the gin router

func (m *Metrics) NewEngine() *gin.Engine

NewEngine returns a *gin.Engine with some defaults and the stats endpoint (no logger)

func (m *Metrics) NewExpHandler() gin.HandlerFunc

NewExpHandler creates an http.Handler ready to expose all the collected metrics as a JSON

func (m *Metrics) NewHTTPHandlerFactory(hf krakendgin.HandlerFactory) krakendgin.HandlerFactory

NewHTTPHandlerFactory wraps a handler factory adding some simple instrumentation to the generated handlers

func (m *Metrics) RunEndpoint(ctx context.Context, e *gin.Engine, l logging.Logger)

RunEndpoint runs the *gin.Engine (that should have the stats endpoint) with the logger