Make metrics names compatible with Prometheus Java library #9740
Conversation
6201c0d to
c62de5f
Compare
|
In zio logging we have some metrics for logging too. There we can configure the names of the metrics if we like. I think I would like to have a such a constructor as well. |
|
Well right now the names of the metrics are just function parameters. That is OK for a private method but unsuitable as a public API because a new parameter would have to be added every time we add a new metric, breaking binary compatibility. So we'd need some configuration object with all the metrics names, and I'm not sure if it's worth the hassle. Maybe we should add that feature when somebody actually has a use case for it. |
| "This app exposes JVM metrics with the non-OpenMetrics-compliant names used in prometheus client_java 0.16: https://github.com/prometheus/client_java/blob/main/docs/content/migration/simpleclient.md#jvm-metrics. Use `appV2` instead, it uses names compatible with the client_java 1.0 library" | ||
| ) | ||
| lazy val app = withMetrics(live) | ||
| lazy val appV2 = withMetrics(liveV2) |
There was a problem hiding this comment.
Should we use a name like OpenMetricsApp? v2 doesn't have much meaning.
There was a problem hiding this comment.
V2 does indeed have a meaning: it means that this is the direct successor to live that you should switch to as soon as you've adapted your monitoring. openMetrics does not convey this. And actually the OpenMetrics project has been archived because it was merged into Prometheus:
https://horovits.medium.com/openmetrics-is-archived-
8000
merged-into-prometheus-d555598d2d04
And prometheus would also not be a good name because the previous version was also designed to be compatible with an earlier Prometheus library (the simpleclient library which was replaced by the client_java library).
For these reasons, I think that the V2 name is better overall.
Hi there,
When the Default JVM metrics were initially added to ZIO, they were written to be compatible with the metrics in the Prometheus simpleclient library.
That library has since been replaced by the Prometheus client_java library, which has changed the names of a dozen metrics:
https://github.com/prometheus/client_java/blob/main/docs/content/migration/simpleclient.md#jvm-metrics
This PR intends to make ZIO compatible with the Prometheus library and the OpenMetrics specification once more.
Since changing metrics names is an incompatible change that will break everybody's monitoring, I have left the existing layers in place, deprecated them and added new
V2layers that do the same thing but use the new names. I'm open to other suggestions, but I do think it's important to keep the metrics stable.