plugeth/metrics
Felix Lange b628d72766
build: upgrade to go 1.19 (#25726)
This changes the CI / release builds to use the latest Go version. It also
upgrades golangci-lint to a newer version compatible with Go 1.19.

In Go 1.19, godoc has gained official support for links and lists. The
syntax for code blocks in doc comments has changed and now requires a
leading tab character. gofmt adapts comments to the new syntax
automatically, so there are a lot of comment re-formatting changes in this
PR. We need to apply the new format in order to pass the CI lint stage with
Go 1.19.

With the linter upgrade, I have decided to disable 'gosec' - it produces
too many false-positive warnings. The 'deadcode' and 'varcheck' linters
have also been removed because golangci-lint warns about them being
unmaintained. 'unused' provides similar coverage and we already have it
enabled, so we don't lose much with this change.
2022-09-10 13:25:40 +02:00
..
exp all: remove unneeded parentheses (#21921) 2021-02-02 11:32:44 +02:00
influxdb build: upgrade to go 1.19 (#25726) 2022-09-10 13:25:40 +02:00
librato all: replace uses of ioutil with io and os (#24869) 2022-05-16 11:59:35 +02:00
prometheus all: fix some typos (#25551) 2022-08-19 09:00:21 +03:00
config.go cmd, metrics: add support for influxdb-v2 (cherry-picking from italoacasas' changes), leave existing support for v1 to maintain backwards-compatibility. (#23194) 2021-08-17 18:40:14 +02:00
counter_test.go metrics: fix issues reported by staticcheck (#20365) 2019-11-22 16:04:35 +01:00
counter.go metrics: added NewCounterForced (#17919) 2018-10-16 16:22:51 +02:00
cpu_disabled.go all: add go:build lines (#23468) 2021-08-25 18:46:29 +02:00
cpu_enabled.go all: add go:build lines (#23468) 2021-08-25 18:46:29 +02:00
cpu.go metrics: disable CPU stats (gosigar) on iOS 2020-03-26 11:24:58 +02:00
cputime_nop.go all: add go:build lines (#23468) 2021-08-25 18:46:29 +02:00
cputime_unix.go all: add go:build lines (#23468) 2021-08-25 18:46:29 +02:00
debug_test.go metrics: pull library and introduce ResettingTimer and InfluxDB reporter (#15910) 2018-02-23 11:56:08 +02:00
debug.go metrics: pull library and introduce ResettingTimer and InfluxDB reporter (#15910) 2018-02-23 11:56:08 +02:00
disk_linux.go all: fix ineffectual assignments and remove uses of crypto.Sha3 2017-01-09 16:24:42 +01:00
disk_nop.go all: add go:build lines (#23468) 2021-08-25 18:46:29 +02:00
disk.go all: fix license headers one more time 2015-07-23 18:35:11 +02:00
doc.go travis: enable test suite on ARM64 (#20219) 2019-11-08 10:58:57 +02:00
ewma_test.go travis: enable test suite on ARM64 (#20219) 2019-11-08 10:58:57 +02:00
ewma.go metrics: make meter updates lock-free (#21446) 2020-08-18 11:27:04 +02:00
FORK.md metrics: pull library and introduce ResettingTimer and InfluxDB reporter (#15910) 2018-02-23 11:56:08 +02:00
gauge_float64_test.go all: fix some typos (#25551) 2022-08-19 09:00:21 +03:00
gauge_float64.go metrics: pull library and introduce ResettingTimer and InfluxDB reporter (#15910) 2018-02-23 11:56:08 +02:00
gauge_test.go all: fix some typos (#25551) 2022-08-19 09:00:21 +03:00
gauge.go core, metrics, p2p: switch some invalid counters to gauges 2019-09-10 14:39:07 +03:00
graphite_test.go metrics: pull library and introduce ResettingTimer and InfluxDB reporter (#15910) 2018-02-23 11:56:08 +02:00
graphite.go metrics: pull library and introduce ResettingTimer and InfluxDB reporter (#15910) 2018-02-23 11:56:08 +02:00
healthcheck.go metrics: pull library and introduce ResettingTimer and InfluxDB reporter (#15910) 2018-02-23 11:56:08 +02:00
histogram_test.go metrics: fix issues reported by staticcheck (#20365) 2019-11-22 16:04:35 +01:00
histogram.go eth/protocols, metrics, p2p: add handler performance metrics 2021-03-26 14:00:06 +02:00
init_test.go metrics: pull library and introduce ResettingTimer and InfluxDB reporter (#15910) 2018-02-23 11:56:08 +02:00
json_test.go metrics: fix issues reported by staticcheck (#20365) 2019-11-22 16:04:35 +01:00
json.go metrics: pull library and introduce ResettingTimer and InfluxDB reporter (#15910) 2018-02-23 11:56:08 +02:00
LICENSE metrics: pull library and introduce ResettingTimer and InfluxDB reporter (#15910) 2018-02-23 11:56:08 +02:00
log.go metrics: pull library and introduce ResettingTimer and InfluxDB reporter (#15910) 2018-02-23 11:56:08 +02:00
memory.md metrics: pull library and introduce ResettingTimer and InfluxDB reporter (#15910) 2018-02-23 11:56:08 +02:00
meter_test.go metrics: zero temp variable in updateMeter (#21470) 2020-08-21 11:04:36 +03:00
meter.go metrics: zero temp variable in updateMeter (#21470) 2020-08-21 11:04:36 +03:00
metrics_test.go all: replace uses of ioutil with io and os (#24869) 2022-05-16 11:59:35 +02:00
metrics.go dashboard: remove the dashboard (#20279) 2019-11-14 10:04:16 +01:00
opentsdb_test.go metrics: pull library and introduce ResettingTimer and InfluxDB reporter (#15910) 2018-02-23 11:56:08 +02:00
opentsdb.go metrics: remove redundant type specifiers (#19090) 2019-02-18 13:37:31 +02:00
README.md metrics: change links in README.md to https (#20182) 2019-10-20 12:25:25 +02:00
registry_test.go all: add whitespace linter (#25312) 2022-07-25 13:14:03 +03:00
registry.go swarm/metrics: Send the accounting registry to InfluxDB (#18470) 2019-01-24 18:57:20 +01:00
resetting_sample.go eth/protocols, metrics: use resetting histograms for rare packets 2021-03-26 16:14:12 +02:00
resetting_timer_test.go metrics: expvar support for ResettingTimer (#16878) 2018-06-04 13:05:16 +03:00
resetting_timer.go metrics: return an empty snapshot for NilResettingTimer (#16930) 2018-06-11 10:31:55 +03:00
runtime_cgo.go all: add go:build lines (#23468) 2021-08-25 18:46:29 +02:00
runtime_gccpufraction.go all: add go:build lines (#23468) 2021-08-25 18:46:29 +02:00
runtime_no_cgo.go all: add go:build lines (#23468) 2021-08-25 18:46:29 +02:00
runtime_no_gccpufraction.go all: add go:build lines (#23468) 2021-08-25 18:46:29 +02:00
runtime_test.go metrics: fix issues reported by staticcheck (#20365) 2019-11-22 16:04:35 +01:00
runtime.go metrics: pull library and introduce ResettingTimer and InfluxDB reporter (#15910) 2018-02-23 11:56:08 +02:00
sample_test.go metrics: add missing calls to Ticker.Stop in tests (#20866) 2020-04-02 16:01:18 +02:00
sample.go metrics: fix issues reported by staticcheck (#20365) 2019-11-22 16:04:35 +01:00
syslog.go all: add go:build lines (#23468) 2021-08-25 18:46:29 +02:00
timer_test.go metrics: improve TestTimerFunc (#20818) 2020-03-31 15:01:16 +02:00
timer.go metrics: fix issues reported by staticcheck (#20365) 2019-11-22 16:04:35 +01:00
validate.sh metrics: pull library and introduce ResettingTimer and InfluxDB reporter (#15910) 2018-02-23 11:56:08 +02:00
writer_test.go metrics: pull library and introduce ResettingTimer and InfluxDB reporter (#15910) 2018-02-23 11:56:08 +02:00
writer.go metrics: pull library and introduce ResettingTimer and InfluxDB reporter (#15910) 2018-02-23 11:56:08 +02:00

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
    "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: