Scope info should only be exported for Prometheus if OpenMetrics is r…

…equested (#5182)
open-telemetry · Dec 15, 2023 · 7eeae5b · 7eeae5b
1 parent 3c986e8
commit 7eeae5b
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 29 deletions.
diff --git a/src/OpenTelemetry.Exporter.Prometheus.AspNetCore/CHANGELOG.md b/src/OpenTelemetry.Exporter.Prometheus.AspNetCore/CHANGELOG.md
@@ -3,7 +3,9 @@
 ## Unreleased
 
 * Export OpenMetrics format from Prometheus exporters ([#5107](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5107))
-* For requests with OpenMetrics format, scope info is automatically added ([#5086](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5086))
+* For requests with OpenMetrics format, scope info is automatically added
+ ([#5086](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5086)
+ [#5182](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5182))
 
 ## 1.7.0-rc.1
 

diff --git a/src/OpenTelemetry.Exporter.Prometheus.HttpListener/CHANGELOG.md b/src/OpenTelemetry.Exporter.Prometheus.HttpListener/CHANGELOG.md
@@ -3,7 +3,9 @@
 ## Unreleased
 
 * Export OpenMetrics format from Prometheus exporters ([#5107](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5107))
-* For requests with OpenMetrics format, scope info is automatically added ([#5086](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5086))
+* For requests with OpenMetrics format, scope info is automatically added
+ ([#5086](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5086)
+ [#5182](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5182))
 
 ## 1.7.0-rc.1
 

diff --git a/src/OpenTelemetry.Exporter.Prometheus.HttpListener/Internal/PrometheusCollectionManager.cs b/src/OpenTelemetry.Exporter.Prometheus.HttpListener/Internal/PrometheusCollectionManager.cs
@@ -172,31 +172,34 @@ private ExportResult OnCollect(Batch<Metric> metrics)
 
  try
  {
- this.scopes.Clear();
-
- foreach (var metric in metrics)
+ if (this.exporter.OpenMetricsRequested)
  {
- if (PrometheusSerializer.CanWriteMetric(metric))
+ this.scopes.Clear();
+
+ foreach (var metric in metrics)
  {
- if (this.scopes.Add(metric.MeterName))
+ if (PrometheusSerializer.CanWriteMetric(metric))
  {
- try
+ if (this.scopes.Add(metric.MeterName))
  {
- cursor = PrometheusSerializer.WriteScopeInfo(this.buffer, cursor, metric.MeterName);
+ try
+ {
+ cursor = PrometheusSerializer.WriteScopeInfo(this.buffer, cursor, metric.MeterName);
 
- break;
- }
- catch (IndexOutOfRangeException)
- {
- if (!this.IncreaseBufferSize())
+ break;
+ }
+ catch (IndexOutOfRangeException)
  {
- // there are two cases we might run into the following condition:
- // 1. we have many metrics to be exported - in this case we probably want
- // to put some upper limit and allow the user to configure it.
- // 2. we got an IndexOutOfRangeException which was triggered by some other
- // code instead of the buffer[cursor++] - in this case we should give up
- // at certain point rather than allocating like crazy.
- throw;
+ if (!this.IncreaseBufferSize())
+ {
+ // there are two cases we might run into the following condition:
+ // 1. we have many metrics to be exported - in this case we probably want
+ // to put some upper limit and allow the user to configure it.
+ // 2. we got an IndexOutOfRangeException which was triggered by some other
+ // code instead of the buffer[cursor++] - in this case we should give up
+ // at certain point rather than allocating like crazy.
+ throw;
+ }
  }
  }
  }

diff --git a/test/OpenTelemetry.Exporter.Prometheus.AspNetCore.Tests/PrometheusExporterMiddlewareTests.cs b/test/OpenTelemetry.Exporter.Prometheus.AspNetCore.Tests/PrometheusExporterMiddlewareTests.cs
@@ -328,10 +328,7 @@ private static async Task RunPrometheusExporterMiddlewareIntegrationTest(
  + "# TYPE counter_double_total counter\n"
  + $"counter_double_total{{otel_scope_name='{MeterName}',otel_scope_version='{MeterVersion}',key1='value1',key2='value2'}} 101.17 (\\d+\\.\\d{{3}})\n"
  + "# EOF\n"
- : "# TYPE otel_scope_info info\n"
- + "# HELP otel_scope_info Scope metadata\n"
- + $"otel_scope_info{{otel_scope_name='{MeterName}'}} 1\n"
- + "# TYPE counter_double_total counter\n"
+ : "# TYPE counter_double_total counter\n"
  + $"counter_double_total{{otel_scope_name='{MeterName}',otel_scope_version='{MeterVersion}',key1='value1',key2='value2'}} 101.17 (\\d+)\n"
  + "# EOF\n";
 

diff --git a/test/OpenTelemetry.Exporter.Prometheus.HttpListener.Tests/PrometheusHttpListenerTests.cs b/test/OpenTelemetry.Exporter.Prometheus.HttpListener.Tests/PrometheusHttpListenerTests.cs
@@ -176,10 +176,7 @@ private async Task RunPrometheusExporterHttpServerIntegrationTest(bool skipMetri
  + "# TYPE counter_double_total counter\n"
  + $"counter_double_total{{otel_scope_name='{MeterName}',otel_scope_version='{MeterVersion}',key1='value1',key2='value2'}} 101.17 (\\d+\\.\\d{{3}})\n"
  + "# EOF\n"
- : "# TYPE otel_scope_info info\n"
- + "# HELP otel_scope_info Scope metadata\n"
- + $"otel_scope_info{{otel_scope_name='{MeterName}'}} 1\n"
- + "# TYPE counter_double_total counter\n"
+ : "# TYPE counter_double_total counter\n"
  + $"counter_double_total{{otel_scope_name='{MeterName}',otel_scope_version='{MeterVersion}',key1='value1',key2='value2'}} 101.17 (\\d+)\n"
  + "# EOF\n";