Skip to content
Go port of Coda Hale's Metrics library
Go Shell
Find file
Latest commit 51425a2 @mihasya mihasya Merge pull request #96 from Dieterbe/expvar
support serving up go-metrics as expvars
Failed to load latest commit information.
cmd initial implementation of GaugeFloat64
exp use /debug/metrics as endpoint, seems more proper/elegant
librato Merge pull request #114 from pressly/master
stathat initial implementation of GaugeFloat64
.gitignore never-read debugging tool.
.travis.yml Add support for Golang 1.5 in Travis CI
LICENSE Updated docs, deleted Makefiles.
README.md Merge pull request #96 from Dieterbe/expvar
counter.go Allow lazy instantiation of metric in GetOrRegister.
counter_test.go Fully introduce snapshots for all metric types.
debug.go Use time.Tick everywhere else we should, too
debug_test.go Skip tests that require GOMAXPROCS > 1.
ewma.go gofmt pass
ewma_test.go Benchmarks for everyone!
gauge.go Allow lazy instantiation of metric in GetOrRegister.
gauge_float64.go Do not export methods from sync.Mutex on gauges.
gauge_float64_test.go Tidying whitespace.
gauge_test.go Fully introduce snapshots for all metric types.
graphite.go deprecate the graphite client in favor of the new separate lib
graphite_test.go gofmt pass
healthcheck.go Mostly documentation and naming changes.
histogram.go Alphabetize
histogram_test.go Fix tests broken by sample changes.
json.go Fix registry race caused by copying a sync.Mutex
json_test.go Added JSON->io.Writer; consistent ordering to WriteOnce
log.go include duration's unit in printed metrics
memory.md Installation and usage.
meter.go Fix Meter.RateMean int64 overflow
meter_test.go Fix race condition on test
metrics.go ETOOCLEVER so s/ObserverEffect/UseNilMetrics/.
metrics_test.go initial implementation of GaugeFloat64
opentsdb.go Fix #74 for OpenTSDB, too
opentsdb_test.go gofmt pass
registry.go Add NewPrefixedChildRegistry()
registry_test.go Add NewPrefixedChildRegistry()
runtime.go Add support for fraction of CPU time used by GC
runtime_cgo.go Fixes: Won't compile on AppEngine #67
runtime_gccpufraction.go Add support for fraction of CPU time used by GC
runtime_no_cgo.go Fixes: Won't compile on AppEngine #67
runtime_no_gccpufraction.go Add support for fraction of CPU time used by GC
runtime_test.go Rework NumGC and PauseNs runtime metrics.
sample.go Prevent most allocations in ExpDecaySample
sample_test.go Test for #104
syslog.go Use time.Tick everywhere else we should, too
timer.go Alphabetize
timer_test.go Fix tests broken by sample changes.
validate.sh first attempt at basic travis build
writer.go Use time.Tick everywhere else we should, too
writer_test.go Merge branch 'master' of github.com:stuartcarnie/go-metrics

README.md

go-metrics

travis build status

Go port of Coda Hale's Metrics library: https://github.com/dropwizard/metrics.

Documentation: http://godoc.org/github.com/rcrowley/go-metrics.

Usage

Create and update metrics:

c := metrics.NewCounter()
metrics.Register("foo", c)
c.Inc(47)

g := metrics.NewGauge()
metrics.Register("bar", g)
g.Update(47)

s := metrics.NewExpDecaySample(1028, 0.015) // or metrics.NewUniformSample(1028)
h := metrics.NewHistogram(s)
metrics.Register("baz", h)
h.Update(47)

m := metrics.NewMeter()
metrics.Register("quux", m)
m.Mark(47)

t := metrics.NewTimer()
metrics.Register("bang", t)
t.Time(func() {})
t.Update(47)

Periodically log every metric in human-readable form to standard error:

go metrics.Log(metrics.DefaultRegistry, 5 * time.Second, log.New(os.Stderr, "metrics: ", log.Lmicroseconds))

Periodically log every metric in slightly-more-parseable form to syslog:

w, _ := syslog.Dial("unixgram", "/dev/log", syslog.LOG_INFO, "metrics")
go metrics.Syslog(metrics.DefaultRegistry, 60e9, w)

Periodically emit every metric to Graphite using the Graphite client:

import "github.com/cyberdelia/go-metrics-graphite"

addr, _ := net.ResolveTCPAddr("tcp", "127.0.0.1:2003")
go graphite.Graphite(metrics.DefaultRegistry, 10e9, "metrics", addr)

Periodically emit every metric into InfluxDB:

NOTE: this has been pulled out of the library due to constant fluctuations in the InfluxDB API. In fact, all client libraries are on their way out. see issues #121 and #124 for progress and details.

import "github.com/rcrowley/go-metrics/influxdb"

go influxdb.Influxdb(metrics.DefaultRegistry, 10e9, &influxdb.Config{
    Host:     "127.0.0.1:8086",
    Database: "metrics",
    Username: "test",
    Password: "test",
})

Periodically upload every metric to Librato using the Librato client:

Note: the client included with this repository under the librato package has been deprecated and moved to the repository linked above.

import "github.com/mihasya/go-metrics-librato"

go librato.Librato(metrics.DefaultRegistry,
    10e9,                  // interval
    "example@example.com", // account owner email address
    "token",               // Librato API token
    "hostname",            // source
    []float64{0.95},       // percentiles to send
    time.Millisecond,      // time unit
)

Periodically emit every metric to StatHat:

import "github.com/rcrowley/go-metrics/stathat"

go stathat.Stathat(metrics.DefaultRegistry, 10e9, "example@example.com")

Maintain all metrics along with expvars at /debug/metrics:

This uses the same mechanism as the official expvar but exposed under /debug/metrics, which shows a json representation of all your usual expvars as well as all your go-metrics.

import "github.com/rcrowley/go-metrics/exp"

exp.Exp(metrics.DefaultRegistry)

Installation

go get github.com/rcrowley/go-metrics

StatHat support additionally requires their Go client:

go get github.com/stathat/go

Publishing Metrics

Clients are available for the following destinations:

Something went wrong with that request. Please try again.