Skip to content

Files

Latest commit

14eb896 · Mar 21, 2024

History

History
This branch is 11 commits ahead of, 723 commits behind ethereum/go-ethereum:master.

metrics

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Sep 13, 2023
Mar 11, 2024
Sep 13, 2023
Sep 13, 2023
Mar 11, 2024
Sep 13, 2023
Feb 23, 2018
Feb 23, 2018
Oct 20, 2019
Mar 11, 2024
Feb 7, 2024
Sep 13, 2023
Sep 13, 2023
Sep 13, 2023
Mar 6, 2023
Aug 25, 2021
Mar 6, 2023
Mar 6, 2023
Mar 6, 2023
Feb 23, 2018
Feb 23, 2018
Jul 23, 2015
Jan 9, 2017
Nov 15, 2023
Sep 13, 2023
Sep 13, 2023
Feb 7, 2024
Feb 7, 2024
Nov 15, 2023
Feb 7, 2024
Sep 13, 2023
Sep 13, 2023
Sep 13, 2023
Feb 23, 2018
Feb 7, 2024
Feb 7, 2024
Sep 13, 2023
Sep 13, 2023
Feb 23, 2018
Mar 20, 2024
Nov 22, 2019
Sep 13, 2023
Feb 23, 2018
Sep 13, 2023
Sep 13, 2023
Mar 11, 2024
Sep 13, 2023
Sep 13, 2023
Sep 13, 2023
Mar 20, 2024
Sep 13, 2023
Sep 13, 2023
Sep 13, 2023
Sep 13, 2023
Sep 13, 2023
Sep 13, 2023
Feb 29, 2024
Mar 21, 2024
Sep 13, 2023
Mar 20, 2024
Sep 13, 2023
Feb 23, 2018
Sep 13, 2023
Aug 11, 2023

go-metrics

travis build status

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

Documentation: https://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)

r := NewRegistry()
g := metrics.NewRegisteredFunctionalGauge("cache-evictions", r, func() int64 { return cache.getEvictionsCount() })

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)

Register() is not threadsafe. For threadsafe metric registration use GetOrRegister:

t := metrics.GetOrRegisterTimer("account.create.latency", nil)
t.Time(func() {})
t.Update(47)

NOTE: Be sure to unregister short-lived meters and timers otherwise they will leak memory:

// Will call Stop() on the Meter to allow for garbage collection
metrics.Unregister("quux")
// Or similarly for a Timer that embeds a Meter
metrics.Unregister("bang")

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/vrischmann/go-metrics-influxdb"

go influxdb.InfluxDB(metrics.DefaultRegistry,
  10e9, 
  "127.0.0.1:8086", 
  "database-name", 
  "username", 
  "password"
)

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
    "[email protected]", // 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, "[email protected]")

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: