Skip to content

Commit c25dd5f

Browse files
committed
Document removal of _total from metric name.
It's only in the timeseries name now. Signed-off-by: Brian Brazil <brian.brazil@robustperception.io>
1 parent 5cc3ca8 commit c25dd5f

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,11 @@ c.inc() # Increment by 1
7272
c.inc(1.6) # Increment by given value
7373
```
7474

75+
If there is a suffix of `_total` on the metric name, it will be removed. When
76+
exposing the time series for counter, a `_total` suffix will be added. This is
77+
for compatibility between OpenMetrics and the Prometheus text format, as OpenMetrics
78+
requires the `_total` suffix.
79+
7580
There are utilities to count exceptions raised:
7681

7782
```python

0 commit comments

Comments
 (0)