Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SPEC: add section on how to format Prometheus output for Micrometer impls #672

Closed
donbourne opened this issue Jul 6, 2022 · 1 comment
Closed
Assignees
Milestone

Comments

@donbourne
Copy link
Member

donbourne commented Jul 6, 2022

To enhance consistency between MP Metrics implementations based on Micrometer, we should add a section to the spec detailing how prometheus-formatted output should look for each of the Metric types

Histograms

# TYPE metricHistogram_bytes_max gauge
# HELP metricHistogram_bytes_max  
metricHistogram_bytes_max{scope="application"} 1000.0
# TYPE metricHistogram_bytes summary
# HELP metricHistogram_bytes  
metricHistogram_bytes{scope="application",quantile="0.5"} 1000.0
metricHistogram_bytes{scope="application",quantile="0.75"} 1000.0
metricHistogram_bytes{scope="application",quantile="0.95"} 1000.0
metricHistogram_bytes{scope="application",quantile="0.98"} 1000.0
metricHistogram_bytes{scope="application",quantile="0.99"} 1000.0
metricHistogram_bytes{scope="application",quantile="0.999"} 1000.0
metricHistogram_bytes_count{scope="application"} 1.0
metricHistogram_bytes_sum{scope="application"} 1000.0

Timers

# TYPE metricTimer_seconds summary
# HELP metricTimer_seconds  
metricTimer_seconds{scope="application",quantile="0.5"} 1.946157056
metricTimer_seconds{scope="application",quantile="0.75"} 1.946157056
metricTimer_seconds{scope="application",quantile="0.95"} 1.946157056
metricTimer_seconds{scope="application",quantile="0.98"} 1.946157056
metricTimer_seconds{scope="application",quantile="0.99"} 1.946157056
metricTimer_seconds{scope="application",quantile="0.999"} 1.946157056
metricTimer_seconds_count{scope="application"} 1.0
metricTimer_seconds_sum{scope="application"} 2.0071254
# TYPE metricTimer_seconds_max gauge
# HELP metricTimer_seconds_max  
metricTimer_seconds_max{scope="application"} 2.0071254
@donbourne donbourne added this to the 5.0 milestone Jul 6, 2022
@donbourne donbourne self-assigned this Jul 26, 2022
@donbourne
Copy link
Member Author

I updated the REST endpoint section in #690 to leave the Prometheus/OpenMetrics formatting details to the Prometheus/OpenMetrics docs/specs. Given that, I don't think we need a separate section on formatting for Micrometer impls. If we choose to, we can still add TCK tests that are implementation-specific, as part of #669 .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant