Export OpenMetrics format for prometheus exporters by robertcoltheart · Pull Request #5107 · open-telemetry/opentelemetry-dotnet

robertcoltheart · 2023-12-01T00:57:06Z

Fixes #
First part to addressing #3972

Changes

Export OpenMetrics format for Prometheus. See here.

Add Accept parser and set correct Content-Type
Write metric timestamps in OpenMetric format

Merge requirement checklist

CONTRIBUTING guidelines followed (nullable enabled, static analysis, etc.)
Unit tests added/updated
Appropriate CHANGELOG.md files updated for non-trivial changes
Changes in public API reviewed (if applicable)

…b.com/robertcoltheart/opentelemetry-dotnet into feature/export-prometheus-openmetrics

reyang

LGTM with one suggestion https://github.com/open-telemetry/opentelemetry-dotnet/pull/5107/files#r1414630802.

codecov · 2023-12-05T00:01:55Z

Codecov Report

Merging #5107 (015ad3b) into main (a963ec8) will increase coverage by 0.06%.
Report is 1 commits behind head on main.
The diff coverage is 96.66%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5107      +/-   ##
==========================================
+ Coverage   83.06%   83.13%   +0.06%     
==========================================
  Files         296      297       +1     
  Lines       12320    12369      +49     
==========================================
+ Hits        10234    10283      +49     
  Misses       2086     2086

Flag	Coverage Δ
unittests	`83.13% <96.66%> (+0.06%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
...tpListener/Internal/PrometheusCollectionManager.cs	`79.04% <100.00%> (+1.26%)`	⬆️
...etheus.HttpListener/Internal/PrometheusExporter.cs	`100.00% <100.00%> (ø)`
...s.HttpListener/Internal/PrometheusHeadersParser.cs	`100.00% <100.00%> (ø)`
...s.HttpListener/Internal/PrometheusSerializerExt.cs	`100.00% <100.00%> (ø)`
....Prometheus.HttpListener/PrometheusHttpListener.cs	`81.70% <100.00%> (+1.70%)`	⬆️
...metheus.AspNetCore/PrometheusExporterMiddleware.cs	`70.00% <92.30%> (+7.93%)`	⬆️
...heus.HttpListener/Internal/PrometheusSerializer.cs	`80.80% <90.00%> (+0.79%)`	⬆️

... and 6 files with indirect coverage changes

…orterMiddleware.cs Co-authored-by: Utkarsh Umesan Pillai <66651184+utpilla@users.noreply.github.com>

…ttpListener.cs Co-authored-by: Utkarsh Umesan Pillai <66651184+utpilla@users.noreply.github.com>

utpilla · 2023-12-07T00:18:03Z

-                .AddMeter(meter.Name)
-                .AddPrometheusHttpListener(options => options.UriPrefixes = new string[] { address })
-                .Build();
+            try


nit: It's simpler to not have the try/catch block here. This is a test so it's okay for it to fail with the original exception. Anyone troubleshooting the test failure would realize what the issue was anyway.

In this case, I'm guessing its because there might be a potential conflict with an already open port? I can remove in the next PR in any case.

In this case, I'm guessing its because there might be a potential conflict with an already open port?

The tests within a project are not run in parallel so it shouldn't be the case unless the listener instances are not getting disposed correctly.

robertcoltheart · 2023-12-07T00:19:50Z

Thanks very much! Will crack on with the next PR.

utpilla · 2023-12-07T00:21:12Z

Thanks very much! Will crack on with the next PR.

@robertcoltheart Thanks for your contribution!

robertcoltheart added 2 commits December 1, 2023 11:55

Export openmetrics format for prometheus exporters

1c02405

Update changelog

5a98791

robertcoltheart commented Dec 1, 2023

View reviewed changes

Comment thread src/OpenTelemetry.Exporter.Prometheus.HttpListener/Internal/PrometheusSerializerExt.cs

robertcoltheart and others added 2 commits December 1, 2023 12:07

Add serializer test

36eb712

Merge branch 'main' into feature/export-prometheus-openmetrics

3c39d4c

robertcoltheart marked this pull request as ready for review December 1, 2023 01:11

robertcoltheart requested a review from a team December 1, 2023 01:11

robertcoltheart mentioned this pull request Dec 1, 2023

Add scope info and version to Prometheus exporter #5086

Merged

4 tasks

Merge branch 'main' into feature/export-prometheus-openmetrics

438ce9c

reyang reviewed Dec 1, 2023

View reviewed changes

Comment thread src/OpenTelemetry.Exporter.Prometheus.AspNetCore/PrometheusAspNetCoreOptions.cs Outdated

robertcoltheart and others added 4 commits December 3, 2023 08:35

Decide content type based on accept header

945834a

Merge branch 'feature/export-prometheus-openmetrics' of https://githu…

97a1511

…b.com/robertcoltheart/opentelemetry-dotnet into feature/export-prometheus-openmetrics

Tidy test variable naming

a8374af

Merge branch 'main' into feature/export-prometheus-openmetrics

ee44164

reyang reviewed Dec 4, 2023

View reviewed changes

Comment thread src/OpenTelemetry.Exporter.Prometheus.AspNetCore/PrometheusExporterMiddleware.cs Outdated

reyang approved these changes Dec 4, 2023

View reviewed changes

robertcoltheart and others added 2 commits December 5, 2023 22:44

Use fewer allocations for media type parsing

8b9e72e

Merge branch 'main' into feature/export-prometheus-openmetrics

85ec4a6

utpilla reviewed Dec 6, 2023

View reviewed changes

Comment thread src/OpenTelemetry.Exporter.Prometheus.AspNetCore/PrometheusExporterMiddleware.cs Outdated

robertcoltheart and others added 2 commits December 6, 2023 13:41

Update src/OpenTelemetry.Exporter.Prometheus.AspNetCore/PrometheusExp…

6b4b86f

…orterMiddleware.cs Co-authored-by: Utkarsh Umesan Pillai <66651184+utpilla@users.noreply.github.com>

Fix build

82d1921

utpilla reviewed Dec 6, 2023

View reviewed changes

Comment thread src/OpenTelemetry.Exporter.Prometheus.AspNetCore/PrometheusExporterMiddleware.cs Outdated

robertcoltheart and others added 2 commits December 6, 2023 13:42

Update src/OpenTelemetry.Exporter.Prometheus.AspNetCore/PrometheusExp…

547782f

…orterMiddleware.cs Co-authored-by: Utkarsh Umesan Pillai <66651184+utpilla@users.noreply.github.com>

Fix build

3130372

utpilla reviewed Dec 6, 2023

View reviewed changes

Comment thread src/OpenTelemetry.Exporter.Prometheus.HttpListener/PrometheusHttpListener.cs Outdated

utpilla reviewed Dec 6, 2023

View reviewed changes

Comment thread src/OpenTelemetry.Exporter.Prometheus.HttpListener/PrometheusHttpListener.cs Outdated

Update src/OpenTelemetry.Exporter.Prometheus.HttpListener/PrometheusH…

36df8f8

…ttpListener.cs Co-authored-by: Utkarsh Umesan Pillai <66651184+utpilla@users.noreply.github.com>

utpilla reviewed Dec 6, 2023

View reviewed changes

Comment thread src/OpenTelemetry.Exporter.Prometheus.HttpListener/PrometheusHttpListener.cs Outdated

utpilla reviewed Dec 6, 2023

View reviewed changes

Comment thread src/OpenTelemetry.Exporter.Prometheus.HttpListener/Internal/PrometheusExporter.cs Outdated

robertcoltheart and others added 6 commits December 6, 2023 21:28

Refactor and share more code, fix flaky tests

6558ca0

Merge branch 'main' into feature/export-prometheus-openmetrics

5a939cd

Tidy usings

75e0bbb

Refactor tests

75df04a

Fix build

bff3601

Merge branch 'main' into feature/export-prometheus-openmetrics

5ec4852

utpilla reviewed Dec 6, 2023

View reviewed changes

Comment thread src/OpenTelemetry.Exporter.Prometheus.HttpListener/Internal/PrometheusCollectionManager.cs Outdated

utpilla reviewed Dec 6, 2023

View reviewed changes

Comment thread src/OpenTelemetry.Exporter.Prometheus.HttpListener/Internal/PrometheusHeadersParser.cs Outdated

utpilla reviewed Dec 6, 2023

View reviewed changes

Comment thread src/OpenTelemetry.Exporter.Prometheus.HttpListener/Internal/PrometheusHeadersParser.cs Outdated

utpilla reviewed Dec 6, 2023

View reviewed changes

Comment thread src/OpenTelemetry.Exporter.Prometheus.HttpListener/PrometheusHttpListener.cs Outdated

robertcoltheart added 2 commits December 7, 2023 10:23

Make static and remove redundant set

8dd0cbf

Oops fix build

188d59d

utpilla reviewed Dec 6, 2023

View reviewed changes

Comment thread src/OpenTelemetry.Exporter.Prometheus.AspNetCore/PrometheusExporterMiddleware.cs Outdated

Use foreach instead of linq

015ad3b

utpilla reviewed Dec 7, 2023

View reviewed changes

utpilla approved these changes Dec 7, 2023

View reviewed changes

utpilla merged commit 7419d85 into open-telemetry:main Dec 7, 2023

robertcoltheart deleted the feature/export-prometheus-openmetrics branch December 7, 2023 00:20

vishweshbankwar mentioned this pull request Mar 18, 2024

[Prometheus] Readme fix #5456

Merged

4 tasks

This was referenced May 21, 2024

Problems with prometheus on OTel 1.8 #5613

Closed

After update to 1.8 version and when using the ASP .Net Core Prometheus exporter and /metrics end point I get error on Prometheus some times. #5506

Closed

Conversation

robertcoltheart commented Dec 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Merge requirement checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

reyang left a comment

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented Dec 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

utpilla Dec 7, 2023

Choose a reason for hiding this comment

Uh oh!

robertcoltheart Dec 7, 2023

Choose a reason for hiding this comment

Uh oh!

utpilla Dec 7, 2023

Choose a reason for hiding this comment

Uh oh!

robertcoltheart commented Dec 7, 2023

Uh oh!

utpilla commented Dec 7, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

robertcoltheart commented Dec 1, 2023 •

edited

Loading

codecov Bot commented Dec 5, 2023 •

edited

Loading