Skip to content

Commit 69e5ae2

Browse files
committed
docs: address review feedback on counter example and table header
Revert quick-start counter example to use 'my_failures' (no _total suffix) since the library appends it automatically. Rename 'Value goes' column to 'Behavior' in the metric type overview table for clarity across all six types. Signed-off-by: k1chik <107162115+k1chik@users.noreply.github.com>
1 parent 9acd092 commit 69e5ae2

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

docs/content/instrumenting/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ weight: 2
55

66
Six metric types are available. Pick based on what your value does:
77

8-
| Type | Value goes | Use for |
8+
| Type | Behavior | Use for |
99
|------|-----------|---------|
1010
| [Counter](counter/) | only up | requests served, errors, bytes sent |
1111
| [Gauge](gauge/) | up and down | queue depth, active connections, memory usage |

docs/content/instrumenting/counter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ If your value can go down, use a [Gauge](../gauge/) instead.
1010

1111
```python
1212
from prometheus_client import Counter
13-
c = Counter('my_failures_total', 'Description of counter')
13+
c = Counter('my_failures', 'Description of counter')
1414
c.inc() # Increment by 1
1515
c.inc(1.6) # Increment by given value
1616
```

0 commit comments

Comments
 (0)