From 96a67ce905b8103ec8d0ec3cae00f254b9997e14 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Wed, 20 Jul 2022 12:50:27 +0300 Subject: [PATCH] README.md: add a link to Prometheus metric naming convention --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5eef96a..23c1155 100644 --- a/README.md +++ b/README.md @@ -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? 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 -or in other suitable place explaining each metric exposed from your application. +Just give [meaningful names to the exported metrics](https://prometheus.io/docs/practices/naming/#metric-names) +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`?