https://github.com/zserge/metric

Minimal metrics for Go (counter/gauge/histogram). No dependencies. Compatible with expvar. Web UI included.
https://github.com/zserge/metric

counter gauge histogram metrics minimal

Last synced: 2 months ago
JSON representation

Minimal metrics for Go (counter/gauge/histogram). No dependencies. Compatible with expvar. Web UI included.

• Host: GitHub
• URL: https://github.com/zserge/metric
• Owner: zserge
• License: mit
• Created: 2018-05-23T11:25:51.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2019-12-20T04:43:31.000Z (over 5 years ago)
• Last Synced: 2025-03-30T01:09:44.025Z (3 months ago)
• Topics: counter, gauge, histogram, metrics, minimal
• Language: Go
• Homepage:
• Size: 105 KB
• Stars: 358
• Watchers: 7
• Forks: 27
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# metric

[![Build Status](https://travis-ci.org/zserge/metric.svg?branch=master)](https://travis-ci.org/zserge/metric)

[![GoDoc](https://godoc.org/github.com/zserge/metric?status.svg)](https://godoc.org/github.com/zserge/metric)

[![Go Report Card](https://goreportcard.com/badge/github.com/zserge/metric)](https://goreportcard.com/report/github.com/zserge/metric)

Package provides simple uniform interface for metrics such as counters,

gauges and histograms. It keeps track of metrics in runtime and can be used for

some basic web service instrumentation in Go, where complex tools such as

Prometheus or InfluxDB are not required.

It is compatible with [expvar](https://golang.org/pkg/expvar/) package, that is

also commonly used for monitoring.

## Usage

```go

// Create new metric. All metrics may take time frames if you want them to keep

// history. If no time frames are given the metric only keeps track of a single

// current value.

c := metric.NewCounter("15m10s") // 15 minutes of history with 10 second precision

// Increment counter

c.Add(1)

// Return JSON with all recorded counter values

c.String() // Or json.Marshal(c)

// With expvar

// Register a metric

expvar.Publish("latency", metric.NewHistogram("5m1s", "15m30s", "1h1m"))

// Register HTTP handler to visualize metrics

http.Handle("/debug/metrics", metric.Handler(metric.Exposed))

// Measure time and update the metric

start := time.Now()

...

expvar.Get("latency").(metric.Metric).Add(time.Since(start).Seconds())

```

Metrics are thread-safe and can be updated from background goroutines.

## Web UI

Nothing fancy, really, but still better than reading plain JSON. No javascript,

only good old HTML, CSS and SVG.

![web ui](example/screenshot.png)

Of course you may customize a list of metrics to show in the web UI.

If you need precise values - you may use `/debug/vars` HTTP endpoint provided

by `expvar`.

## License

Code is distributed under MIT license, feel free to use it in your proprietary

projects as well.