docs: add API reference for all metric types #1159
Open
k1chik wants to merge 3 commits intoprometheus:masterfrom
Open
docs: add API reference for all metric types #1159k1chik wants to merge 3 commits intoprometheus:masterfrom
k1chik wants to merge 3 commits intoprometheus:masterfrom
Conversation
csmarchbanks
reviewed
Apr 7, 2026
Member
csmarchbanks
left a comment
csmarchbanks
left a comment
There was a problem hiding this comment.
Thanks! Generally this looks great, just a couple of small comments.
| ```python | ||
| from prometheus_client import Counter | ||
| c = Counter('my_failures', 'Description of counter') | ||
| c = Counter('my_failures_total', 'Description of counter') |
Member
There was a problem hiding this comment.
The library should add _total automatically so this is not necessary to change.
docs/content/instrumenting/_index.md
Outdated
| See the documentation on [metric types](http://prometheus.io/docs/concepts/metric_types/) | ||
| Six metric types are available. Pick based on what your value does: | ||
|
|
||
| | Type | Value goes | Use for | |
Member
There was a problem hiding this comment.
"Value goes" is a bit awkward for non counter/gauges. Maybe instead something like how a value is set?
Author
There was a problem hiding this comment.
thanks for the review!
- reverted the quick example in counter.md back to my_failures (without
_total) - renamed the
Value goescolumn toUpdate model(does this work?)
Adds constructor parameter tables, method documentation, and runnable real-world examples for Counter, Gauge, Histogram, Summary, Info, and Enum. The _index.md quick-pick table now covers all six types. Also fixes labels.md which was missing remove(), remove_by_labels(), and clear() -- the metric pages were already linking to it for those methods. Closes prometheus#1021 Signed-off-by: k1chik <[email protected]>
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 <[email protected]>
Signed-off-by: k1chik <[email protected]>
k1chik
force-pushed
the
fix/1021-api-reference-docs
branch
from
95921c5 to
8d924c5
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #1021
Adds constructor parameter tables, method documentation, and runnable real world examples for Counter, Gauge, Histogram, Summary, Info, and Enum. The _index.md quick-pick table now covers all six types. Also fixes labels.md, which was missing remove(), remove_by_labels(), and clear(). The metric pages were already linking to them.
cc @csmarchbanks