metrics

README

lib-metrics

GoDoc

Dependency

github.com/AlecAivazis/survey/v2 v2.0.1 // indirect
github.com/atotto/clipboard v0.1.2 // indirect
github.com/go-redis/redis v6.15.2+incompatible
github.com/golang/protobuf v1.3.1
github.com/onsi/ginkgo v1.8.0 // indirect
github.com/onsi/gomega v1.5.0 // indirect
github.com/prometheus/client_golang v1.0.0
github.com/prometheus/client_model v0.0.0-20190129233127-fd36f4220a90
github.com/prometheus/common v0.6.0
gopkg.in/robfig/cron.v2 v2.0.0-20150107220207-be2e0b0deed5
gopkg.in/yaml.v2 v2.2.2 // indirect

Initialization

init global collector gather

subsystem := "test"
metricsCollector = NewAutumnCollector(subsystem)

create local metric and registry

localMetrics = metricsCollector.NewAutumnLocalMetric("local_test", "local_type")
// Reset data at zero every day
localMetrics.ResetByCron("0 0 * * *")
metricsCollector.Register(localMetrics)

create metric base on redis and registry

redisMetric = metricsCollector.NewAutumnRedisMetric(client, "redis_test", "type")
// reset redis key
redisMetric.ResetMetricRedisKey("reset_redis_key_test")
// get now redis key
redisMetric.GetRedisKey()
// Reset data at zero every day
redisMetric.ResetByCron("0 0 * * *")
// registry metric
metricsCollector.Register(redisMetric)

Register HTTP handler middleware to customize metrics for collecting HTTP requests

// Collect interface responses
var standardRequestDuration = prometheus.NewHistogramVec(
	prometheus.HistogramOpts{
		Name:    "server_request_duration_seconds",
		Help:    "How much time costs(s)",
		Buckets: []float64{0.0005, 0.001, 0.002, 0.005, 0.010, 0.020, 0.050, 0.1, 0.5, 1, 5},
	}, []string{"code", "router"})

metricsCollector.RegisterPrometheus(standardRequestDuration)

// Pre-interceptor record start time
metricsCollector.UseBeforeHandlerHook(func(ctx *Context) {
	fmt.Println("this is before 1 start")
	start := time.Now()
	ctx.Set("start", start)
	fmt.Println("this is before 1 end")
})

// the post-interceptor calculates the response time and obtains information such as code, which is set by Observer.
metricsCollector.UseAfterHandlerHook(func(ctx *Context) {
	fmt.Println("this is after 1 start")
	start := ctx.GetTime("start")
	elapsed := time.Since(start).Seconds()
	standardRequestDuration.WithLabelValues(fmt.Sprint(ctx.ResponseWriter.Status()), ctx.Request.URL.Path).Observe(elapsed)
	fmt.Println("this is after 1 end")
})

Usage

// local metrics
localMetrics.Set(1,"1")
localMetrics.Incr("2")
localMetrics.Add(1,"3")

// redis metrics
redisMetric.Set(1,"1")
redisMetric.Incr("2")
redisMetric.Add(1,"3")

// Using native metric
standardRequestDuration.WithLabelValues(200, "/test").Observe(10)

Registry Handler

Register gin middleware and add metrics interface to collect HTTP metrics information

engine = gin.New()
// add gin middleware
engine.Use(func(ctx *gin.Context) {
	metricsCollector.Use(http.HandlerFunc(func(w http.ResponseWriter,r *http.Request) {
		ctx.Next()
	})).ServeHTTP(ctx.Writer,ctx.Request)
})
// Register gin interface to provide metrics interface
engine.Get(DefaultMetricPath, gin.WrapF(metricsCollector.Handler()))

Register native HTTP Middleware

engine = new(http.ServeMux)
h:=metricsCollector.Use(engine)
engine.Handle(DefaultMetricPath, metricsCollector.Handler())
http.ListenAndServe(":8080", h)

Built-in default HTTP service startup metrics interface

if err := metricsCollector.ListenAndServe(":8080",metricsCollector.Handler); err != nil && err != http.ErrServerClosed {
     panic(err)
}

Documentation

Index

• Constants
• func DefaultCron() *cron.Cron
• type AutumnLocalMetric
  • func (arm *AutumnLocalMetric) ResetByCron(spec string) error
• type AutumnMetricsCollector
  • func NewAutumnCollector(subsystem string, path ...string) *AutumnMetricsCollector
  • func (ac *AutumnMetricsCollector) NewAutumnLocalMetric(name string, labels ...string) *AutumnLocalMetric
  • func (ac *AutumnMetricsCollector) NewAutumnRedisMetric(client *redis.Client, name string, labels ...string) *AutumnRedisMetric
• type AutumnRedisMetric
  • func (arm *AutumnRedisMetric) Add(value float64, labelValues ...string) error
  • func (arm *AutumnRedisMetric) GetLabelValues() []*pure.LabelValue
  • func (arm *AutumnRedisMetric) GetLabels() []string
  • func (arm *AutumnRedisMetric) GetMetricValueKey() string
  • func (arm *AutumnRedisMetric) GetName() string
  • func (arm *AutumnRedisMetric) GetRedisKey() string
  • func (arm *AutumnRedisMetric) GetValue(label ...string) float64
  • func (arm *AutumnRedisMetric) Incr(labelValues ...string) error
  • func (arm *AutumnRedisMetric) ResetByCron(spec string) error
  • func (arm *AutumnRedisMetric) ResetMetricRedisKey(redisKey string) *AutumnRedisMetric
  • func (arm *AutumnRedisMetric) ResetMetricValueRedisKey(valueKey string) *AutumnRedisMetric
  • func (arm *AutumnRedisMetric) Set(value float64, labelValues ...string) error

Constants

const (
	DefaultMetricRedisKey  = "a:p:rm:%s:%s:%s"
	DefaultMetricsValueKey = "m_value"
)

Functions

func DefaultCron

func DefaultCron() *cron.Cron

Types

type AutumnLocalMetric

type AutumnLocalMetric struct {
	*pure.LocalPureMetric
	// contains filtered or unexported fields
}

func (*AutumnLocalMetric) ResetByCron

func (arm *AutumnLocalMetric) ResetByCron(spec string) error

type AutumnMetricsCollector

type AutumnMetricsCollector struct {
	*pure.CollectorPure
	// contains filtered or unexported fields
}

func NewAutumnCollector

func NewAutumnCollector(subsystem string, path ...string) *AutumnMetricsCollector

func (*AutumnMetricsCollector) NewAutumnLocalMetric

func (ac *AutumnMetricsCollector) NewAutumnLocalMetric(name string, labels ...string) *AutumnLocalMetric

func (*AutumnMetricsCollector) NewAutumnRedisMetric

func (ac *AutumnMetricsCollector) NewAutumnRedisMetric(client *redis.Client, name string, labels ...string) *AutumnRedisMetric

type AutumnRedisMetric

type AutumnRedisMetric struct {
	Name string
	Type pure.MetricType

	Labels []string
	// contains filtered or unexported fields
}

func (*AutumnRedisMetric) Add

func (arm *AutumnRedisMetric) Add(value float64, labelValues ...string) error

func (*AutumnRedisMetric) GetLabelValues

func (arm *AutumnRedisMetric) GetLabelValues() []*pure.LabelValue

func (*AutumnRedisMetric) GetLabels

func (arm *AutumnRedisMetric) GetLabels() []string

func (*AutumnRedisMetric) GetMetricValueKey

func (arm *AutumnRedisMetric) GetMetricValueKey() string

func (*AutumnRedisMetric) GetName

func (arm *AutumnRedisMetric) GetName() string

func (*AutumnRedisMetric) GetRedisKey

func (arm *AutumnRedisMetric) GetRedisKey() string

func (*AutumnRedisMetric) GetValue

func (arm *AutumnRedisMetric) GetValue(label ...string) float64

func (*AutumnRedisMetric) Incr

func (arm *AutumnRedisMetric) Incr(labelValues ...string) error

func (*AutumnRedisMetric) ResetByCron

func (arm *AutumnRedisMetric) ResetByCron(spec string) error

func (*AutumnRedisMetric) ResetMetricRedisKey

func (arm *AutumnRedisMetric) ResetMetricRedisKey(redisKey string) *AutumnRedisMetric

func (*AutumnRedisMetric) ResetMetricValueRedisKey

func (arm *AutumnRedisMetric) ResetMetricValueRedisKey(valueKey string) *AutumnRedisMetric

func (*AutumnRedisMetric) Set

func (arm *AutumnRedisMetric) Set(value float64, labelValues ...string) error