Prometheus Exporter should have an option to export using OpenMetrics format

[paivagustavo]

Problem Statement

Prometheus exporter only expose metrics using the Prometheus format, which is a subset of the OpenMetrics format. Ideally, we should be able to specify an option to export metrics using the OpenMetrics format.

Given that we don't expose an OpenMetrics format, we lose information about metric's units, which make some required processing of Prometheus metric to OTLP as the specs define to be skipped, e..g, unit suffixes added by the otel-go are not able to be removed due to the lack of unit information as a limitation of the prometheus format.

Proposed Solution

A prometheus.WithOpenMetrics() option to enable the OpenMetrics format, which should contains unit metadata and implement the OTLP Metric points to Prometheus.

The Unit of an OTLP metric point MUST be added as OpenMetrics UNIT metadata. Additionally, the unit MUST be added as a suffix to the metric name, and SHOULD be converted to base units recommended by OpenMetrics when possible. The unit suffix comes before any type-specific suffixes.

Alternatives

Another alternative would always enable this behavior, but having an option to enable/disabled can be useful.

[MadVikingGod]

I explored trying to get prometheus to expose the Unit types, and it looks like the library doesn't do this yet prometheus/client_golang#684.

[MrAlias]

This doesn't look to be required for GA, moving to the post-GA project.

[MrAlias]

Note from SIG meeting: this will likely depend on the underlying Prometheus library supporting OpenMetrics before we want to also support it.

[dashpole]

You can use OpenMetrics today with the prometheus exporter. In the example, you can change this line:

opentelemetry-go/example/prometheus/main.go

Line 93 in 0e874c3

http.Handle("/metrics", promhttp.Handler())

To:

http.Handle("/metrics", HandlerFor(prometheus.DefaultGatherer, HandlerOpts{EnableOpenMetrics: true})) 

[dashpole]

I don't think this blocks the prometheus exporter GA. Adding UNIT metadata to the exporter after the go client has support can be done as an addition later.

[dashpole]

Blocked by prometheus/client_golang#684