unistack-org/metrics
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

metrics.go: improve docs

Browse Source
This commit is contained in:
Aliaksandr Valialkin 2019-04-08 21:15:17 +03:00
parent a62b8e250a
commit d9e8d487bc
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
metrics.go
View File

@ -2,6 +2,12 @@
// //
// This package is lightweight alternative to https://github.com/prometheus/client_golang // This package is lightweight alternative to https://github.com/prometheus/client_golang
// with simpler API and small dependencies. // with simpler API and small dependencies.
//
// Usage:
//
// 1. Register the required metrics via New* functions.
// 2. Expose them to `/metrics` page via WritePrometheus.
// 3. Update the registered metrics during application lifetime.
package metrics package metrics
import ( import (
@ -25,7 +31,7 @@ func (g *gauge) marshalTo(prefix string, w io.Writer) {
fmt.Fprintf(w, "%s %g\n", prefix, v) fmt.Fprintf(w, "%s %g\n", prefix, v)
} }
// NewGauge creates a gauge with the given name, which calls f // NewGauge registers gauge with the given name, which calls f
// to obtain gauge value. // to obtain gauge value.
// //
// name must be valid Prometheus-compatible metric with possible labels. // name must be valid Prometheus-compatible metric with possible labels.
@ -50,7 +56,7 @@ type Counter struct {
n uint64 n uint64
} }
// NewCounter creates and returns new counter with the given name. // NewCounter registers and returns new counter with the given name.
// //
// name must be valid Prometheus-compatible metric with possible lables. // name must be valid Prometheus-compatible metric with possible lables.
// For instance, // For instance,