Commit 30a3b754 authored by Ben Kochie's avatar Ben Kochie Committed by Brian Brazil

Improve the wording of the defintion of a Counter (#1035)

* Improve the wording of the defintion of a Counter

* Link to the wikipedia article on Montonic functions.
* Mention that counters can be reset to zero.
* Change language to speak directly to the user.
Signed-off-by: 's avatarBen Kochie <superq@gmail.com>

* Fixup "that can decrease"
Signed-off-by: 's avatarBen Kochie <superq@gmail.com>
parent 9c6c46c3
...@@ -13,11 +13,15 @@ untyped time series. This may change in the future. ...@@ -13,11 +13,15 @@ untyped time series. This may change in the future.
## Counter ## Counter
A _counter_ is a cumulative metric that represents a single numerical value A _counter_ is a cumulative metric that represents a single [monotonically
that only ever goes up. A counter is typically used to count requests served, increasing counter](https://en.wikipedia.org/wiki/Monotonic_function) whose
tasks completed, errors occurred, etc. Counters should not be used to expose value can only increase or be reset to zero on restart. For example, you can
current counts of items whose number can also go down, e.g. the number of use a counter to represent the number of requests served, tasks completed, or
currently running goroutines. Use gauges for this use case. errors.
Do not use a counter to expose a value that can decrease. For example, do not
use a counter for the number of currently running processes, but use a gauge
instead.
Client library usage documentation for counters: Client library usage documentation for counters:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment