prometheus / client_golang

Prometheus instrumentation library for Go applications
https://pkg.go.dev/github.com/prometheus/client_golang
Apache License 2.0
5.4k stars 1.18k forks source link

Check help string consistency for standard metrics. #171

Closed beorn7 closed 8 years ago

beorn7 commented 9 years ago

Not only the name, also the help string (and obviously type) of standard metrics exposed by every library (like process_open_fds) should be consistent. There are deviations at the moment, only detected by the pushgateway so far.

Check consistency and fix either here in client_golang or in the affected other library.

njohns-grovo commented 9 years ago

@beorn7 I started working on this (see the linked PR). Correct me if I'm wrong, here are the places in which help text is provided by the library

client_golang

client_python

client_java

beorn7 commented 9 years ago

Looks good in general. Currently traveling and at Velocity, so in no shape to to pedantic checks. Any increase in consistency will be a win.

brian-brazil commented 9 years ago

In Java it's only StandardExports, the rest are unique to java.

beorn7 commented 8 years ago

Since the help strings in https://prometheus.io/docs/instrumenting/writing_clientlibs/ are now modeled after client_golang, we are in sync by definition.