metrics

Documentation

Index

• Constants
• type Metrics
  • func New(applicationName string) *Metrics
  • func (m *Metrics) GinHandler() gin.HandlerFunc
  • func (m *Metrics) IncRequestPathHit(user, method, path, status string)
  • func (m *Metrics) Middleware() gin.HandlerFunc
  • func (m *Metrics) RegisterWithPrometheus()

Constants

const MetricsPath = "/metrics"

Prometheus metrics endpoint

Types

type Metrics

type Metrics struct {
	// contains filtered or unexported fields
}

func New

func New(applicationName string) *Metrics

func (*Metrics) GinHandler

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

GinHandler returns a Gin handler for Prometheus metrics endpoint

func (*Metrics) IncRequestPathHit

func (m *Metrics) IncRequestPathHit(user, method, path, status string)

func (*Metrics) Middleware

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

Middleware is gin middleware to maintain prometheus metrics on user, paths and status codes

func (*Metrics) RegisterWithPrometheus

func (m *Metrics) RegisterWithPrometheus()

RegisterMetrics registers our operational metrics