Documentation that the prefix should be terminated with a separator c…

…haracter (#2745) This fixes #1376.
google · May 26, 2022 · a3e9d0a · a3e9d0a
1 parent 645f54a
commit a3e9d0a
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/monitoring/prometheus/metrics.go b/monitoring/prometheus/metrics.go
@@ -27,6 +27,10 @@ import (
 
 // MetricFactory allows the creation of Prometheus-based metrics.
 type MetricFactory struct {
+	// Prefix is an identifier that will be used before local metric names that
+	// are reported. It is strongly recommended that this ends with a valid
+	// separator (e.g. "_") in order to improve readability; no separator is
+	// added by this library.
 	Prefix string
 }