unistack-org/metrics
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

README.md: add a link to Prometheus metric naming convention

Browse Source
This commit is contained in:
Aliaksandr Valialkin 2022-07-20 12:50:27 +03:00
parent f05b7d77a2
commit 96a67ce905
No known key found for this signature in database
GPG Key ID: A72BEC6CD3D0DED1
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -86,8 +86,8 @@ Because the `github.com/prometheus/client_golang` is too complex and is hard to
#### Why the `metrics.WritePrometheus` doesn't expose documentation for each metric? #### Why the `metrics.WritePrometheus` doesn't expose documentation for each metric?
Because this documentation is ignored by Prometheus. The documentation is for users. Because this documentation is ignored by Prometheus. The documentation is for users.
Just give meaningful names to the exported metrics or add comments in the source code Just give [meaningful names to the exported metrics](https://prometheus.io/docs/practices/naming/#metric-names)
or in other suitable place explaining each metric exposed from your application. or add comments in the source code or in other suitable place explaining each metric exposed from your application.
#### How to implement [CounterVec](https://godoc.org/github.com/prometheus/client_golang/prometheus#CounterVec) in `metrics`? #### How to implement [CounterVec](https://godoc.org/github.com/prometheus/client_golang/prometheus#CounterVec) in `metrics`?