Skip to content

Add example for initializing metrics with labels #589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 21, 2020
Merged

Add example for initializing metrics with labels #589

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4ee8d86
Add example for initializing metrics with labels
mpitt Oct 21, 2020
c03ca0b
Separate label init example from common use case
mpitt Oct 21, 2020
1b48018
Fix typo
mpitt Oct 21, 2020
2480f09
Remove redundancy, fix typo
mpitt Oct 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,17 @@ c.labels(method='get', endpoint='/').inc()
c.labels(method='post', endpoint='/submit').inc()
```

Metrics with labels are not initialized when declared, because the client can't
know what values the label can have. It is recommended to initialize the label
values by calling the `.labels()` method alone:

```python
from prometheus_client import Counter
c = Counter('my_requests_total', 'HTTP Failures', ['method', 'endpoint'])
c.labels('get', '/')
c.labels('post', '/submit')
```

### Process Collector

The Python client automatically exports metrics about process CPU usage, RAM,
Expand Down