stats

README

stats

Stats provides usecase for scoring your app metrics

How to Use

stats.Stats defines standard stats interface.

type service struct {
  stats stats.Stats
}

func (s *service) DoSomething() {
  // something happened
  if err != nil {
    s.stats.Increment("something_failed", stats.Option{
      Tags: stats.Tags{"method": "DoSomething"}
    })
  }
}

You can inject stats implementor.

import (
  gogox_prom "github.com/raymondwongso/gogox/stats/prometheus"
)

func main() {
  // e.g: prometheus stats, you can add base tags for your stats.
  prom := gogox_prom.New("mynamespace", stats.Tags{"service":"gogox_service"})

  service := service.NewService(prom)
}

Documentation

Index

• type Option
• type Stats
• type Tags
  • func MergeTags(t1, t2 Tags) Tags

Types

type Option

type Option struct {
	Rate float64
	Tags Tags
}

type Stats

type Stats interface {
	// Increment increase metric by 1
	Increment(metric string, opt Option) error
	// Histogram samples observations and counts them in configurable buckets
	Histogram(metric string, value float64, opt Option) error
	// Gauge represents a single numerical value
	Gauge(metric string, value float64, opt Option) error
	// Add increase metric by value
	Add(metric string, value float64, opt Option) error
}

Stats defines commonly used stats usecases

type Tags

type Tags map[string]string

func MergeTags

func MergeTags(t1, t2 Tags) Tags