metrics

Documentation

Index

• Constants
• func PrometheusHandler() gin.HandlerFunc
• func ToContext(c Setter, metrics *Metrics)
• type Metrics
  • func FromContext(c context.Context) *Metrics
  • func New() *Metrics
  • func (m *Metrics) Handler() gin.HandlerFunc
• type Setter

Constants

const (
	B  = 1
	KB = 1024 * B
	MB = 1024 * KB
	GB = 1024 * MB
)

const Key = "metrics"

Key is the key name of the metrics in the Gin context.

Functions

func PrometheusHandler

func PrometheusHandler() gin.HandlerFunc

PrometheusHandler serves the collected service information for Prometheus.

func ToContext

func ToContext(c Setter, metrics *Metrics)

ToContext adds the metric to this context if it supports the Setter interface.

Types

type Metrics

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

Metrics stores instrument data.

func FromContext

func FromContext(c context.Context) *Metrics

FromContext returns the metric associated with this context.

func New

func New() *Metrics

New defines the instrument elements.

func (*Metrics) Handler

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

Handler handles and parses, calculates the incoming http requests.

type Setter

type Setter interface {
	Set(string, interface{})
}

Setter defines a context that enables setting values.