observe

README

observe -- Prometheus compatible convenience library for Observability

A little tiny Go package that makes dealing with Prometheus metrics a little easier.

Install

go get -u git.mills.io/prologic/observe

Usage

metrics = NewMetrics("foo")

ctime := time.Now()

// server uptime counter
metrics.NewCounterFunc(
    "server", "uptime",
    "Number of nanoseconds the server has been running",
    func() float64 {
        return float64(time.Since(ctime).Nanoseconds())
    },
)

License

MIT

Documentation

Index

• Variables
• type Metrics
  • func NewMetrics(namespace string) *Metrics
  • func (m *Metrics) Counter(subsystem, name string) prometheus.Counter
  • func (m *Metrics) CounterVec(subsystem, name string) *prometheus.CounterVec
  • func (m *Metrics) Gauge(subsystem, name string) prometheus.Gauge
  • func (m *Metrics) GaugeVec(subsystem, name string) *prometheus.GaugeVec
  • func (m *Metrics) Handler() http.Handler
  • func (m *Metrics) NewCounter(subsystem, name, help string) prometheus.Counter
  • func (m *Metrics) NewCounterFunc(subsystem, name, help string, f func() float64) prometheus.CounterFunc
  • func (m *Metrics) NewCounterVec(subsystem, name, help string, labels []string) *prometheus.CounterVec
  • func (m *Metrics) NewGauge(subsystem, name, help string) prometheus.Gauge
  • func (m *Metrics) NewGaugeFunc(subsystem, name, help string, f func() float64) prometheus.GaugeFunc
  • func (m *Metrics) NewGaugeVec(subsystem, name, help string, labels []string) *prometheus.GaugeVec
  • func (m *Metrics) NewSummary(subsystem, name, help string) prometheus.Summary
  • func (m *Metrics) NewSummaryVec(subsystem, name, help string, labels []string) *prometheus.SummaryVec
  • func (m *Metrics) Run(addr string)
  • func (m *Metrics) Summary(subsystem, name string) prometheus.Summary
  • func (m *Metrics) SummaryVec(subsystem, name string) *prometheus.SummaryVec

Variables

var DefObjectives = map[float64]float64{
	0.50: 0.05,
	0.90: 0.01,
	0.95: 0.005,
	0.99: 0.001,
}

DefObjectives ...

Types

type Metrics

type Metrics struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Metrics ...

func NewMetrics

func NewMetrics(namespace string) *Metrics

NewMetrics ...

func (*Metrics) Counter

func (m *Metrics) Counter(subsystem, name string) prometheus.Counter

Counter ...

func (*Metrics) CounterVec

func (m *Metrics) CounterVec(subsystem, name string) *prometheus.CounterVec

CounterVec ...

func (*Metrics) Gauge

func (m *Metrics) Gauge(subsystem, name string) prometheus.Gauge

Gauge ...

func (*Metrics) GaugeVec

func (m *Metrics) GaugeVec(subsystem, name string) *prometheus.GaugeVec

GaugeVec ...

func (*Metrics) Handler

func (m *Metrics) Handler() http.Handler

Handler ...

func (*Metrics) NewCounter

func (m *Metrics) NewCounter(subsystem, name, help string) prometheus.Counter

NewCounter ...

func (*Metrics) NewCounterFunc

func (m *Metrics) NewCounterFunc(subsystem, name, help string, f func() float64) prometheus.CounterFunc

NewCounterFunc ...

func (*Metrics) NewCounterVec

func (m *Metrics) NewCounterVec(subsystem, name, help string, labels []string) *prometheus.CounterVec

NewCounterVec ...

func (*Metrics) NewGauge

func (m *Metrics) NewGauge(subsystem, name, help string) prometheus.Gauge

NewGauge ...

func (*Metrics) NewGaugeFunc

func (m *Metrics) NewGaugeFunc(subsystem, name, help string, f func() float64) prometheus.GaugeFunc

NewGaugeFunc ...

func (*Metrics) NewGaugeVec

func (m *Metrics) NewGaugeVec(subsystem, name, help string, labels []string) *prometheus.GaugeVec

NewGaugeVec ...

func (*Metrics) NewSummary

func (m *Metrics) NewSummary(subsystem, name, help string) prometheus.Summary

NewSummary ...

func (*Metrics) NewSummaryVec

func (m *Metrics) NewSummaryVec(subsystem, name, help string, labels []string) *prometheus.SummaryVec

NewSummaryVec ...

func (*Metrics) Run

func (m *Metrics) Run(addr string)

Run ...

func (*Metrics) Summary

func (m *Metrics) Summary(subsystem, name string) prometheus.Summary

Summary ...

func (*Metrics) SummaryVec

func (m *Metrics) SummaryVec(subsystem, name string) *prometheus.SummaryVec

SummaryVec ...