Add tests and ability to disable scope info

open-telemetry · Dec 7, 2023 · d452ab2 · d452ab2
1 parent 6753ad9
commit d452ab2
Show file tree

Hide file tree

Showing 14 changed files with 237 additions and 55 deletions.
diff --git a/examples/AspNetCore/Instrumentation.cs b/examples/AspNetCore/Instrumentation.cs
@@ -35,7 +35,7 @@ public Instrumentation()
         string? version = typeof(Instrumentation).Assembly.GetName().Version?.ToString();
         this.ActivitySource = new ActivitySource(ActivitySourceName, version);
         this.meter = new Meter(MeterName, version);
-        this.FreezingDaysCounter = this.meter.CreateCounter<long>("weather.days.freezing", "The number of days where the temperature is below freezing");
+        this.FreezingDaysCounter = this.meter.CreateCounter<long>("weather.days.freezing", description: "The number of days where the temperature is below freezing");
     }
 
     public ActivitySource ActivitySource { get; }

diff --git a/src/OpenTelemetry.Exporter.Prometheus.AspNetCore/.publicApi/PublicAPI.Unshipped.txt b/src/OpenTelemetry.Exporter.Prometheus.AspNetCore/.publicApi/PublicAPI.Unshipped.txt
@@ -2,6 +2,8 @@ Microsoft.AspNetCore.Builder.PrometheusExporterApplicationBuilderExtensions
 Microsoft.AspNetCore.Builder.PrometheusExporterEndpointRouteBuilderExtensions
 OpenTelemetry.Exporter.PrometheusAspNetCoreOptions
 OpenTelemetry.Exporter.PrometheusAspNetCoreOptions.PrometheusAspNetCoreOptions() -> void
+OpenTelemetry.Exporter.PrometheusAspNetCoreOptions.ScopeInfoEnabled.get -> bool
+OpenTelemetry.Exporter.PrometheusAspNetCoreOptions.ScopeInfoEnabled.set -> void
 OpenTelemetry.Exporter.PrometheusAspNetCoreOptions.ScrapeEndpointPath.get -> string
 OpenTelemetry.Exporter.PrometheusAspNetCoreOptions.ScrapeEndpointPath.set -> void
 OpenTelemetry.Exporter.PrometheusAspNetCoreOptions.ScrapeResponseCacheDurationMilliseconds.get -> int

diff --git a/src/OpenTelemetry.Exporter.Prometheus.AspNetCore/PrometheusAspNetCoreOptions.cs b/src/OpenTelemetry.Exporter.Prometheus.AspNetCore/PrometheusAspNetCoreOptions.cs
@@ -42,5 +42,14 @@ public int ScrapeResponseCacheDurationMilliseconds
         set => this.ExporterOptions.ScrapeResponseCacheDurationMilliseconds = value;
     }
 
+    /// <summary>
+    /// Gets or sets a value indicating whether to export scope info. Default value: true.
+    /// </summary>
+    public bool ScopeInfoEnabled
+    {
+        get => this.ExporterOptions.ScopeInfoEnabled;
+        set => this.ExporterOptions.ScopeInfoEnabled = value;
+    }
+
     internal PrometheusExporterOptions ExporterOptions { get; } = new();
 }
diff --git a/src/OpenTelemetry.Exporter.Prometheus.HttpListener/.publicApi/PublicAPI.Unshipped.txt b/src/OpenTelemetry.Exporter.Prometheus.HttpListener/.publicApi/PublicAPI.Unshipped.txt
@@ -1,4 +1,6 @@
 OpenTelemetry.Exporter.PrometheusHttpListenerOptions
+OpenTelemetry.Exporter.PrometheusHttpListenerOptions.ScopeInfoEnabled.get -> bool
+OpenTelemetry.Exporter.PrometheusHttpListenerOptions.ScopeInfoEnabled.set -> void
 OpenTelemetry.Exporter.PrometheusHttpListenerOptions.UriPrefixes.get -> System.Collections.Generic.IReadOnlyCollection<string>
 OpenTelemetry.Exporter.PrometheusHttpListenerOptions.UriPrefixes.set -> void
 OpenTelemetry.Exporter.PrometheusHttpListenerOptions.PrometheusHttpListenerOptions() -> void

diff --git a/src/OpenTelemetry.Exporter.Prometheus.HttpListener/Internal/PrometheusCollectionManager.cs b/src/OpenTelemetry.Exporter.Prometheus.HttpListener/Internal/PrometheusCollectionManager.cs
@@ -185,7 +185,7 @@ private ExportResult OnCollect(Batch<Metric> metrics)
 
         try
         {
-            if (this.exporter.OpenMetricsRequested)
+            if (this.exporter.ScopeInfoEnabled && this.exporter.OpenMetricsRequested)
             {
                 this.scopes.Clear();
 
@@ -237,7 +237,8 @@ private ExportResult OnCollect(Batch<Metric> metrics)
                             cursor,
                             metric,
                             this.GetPrometheusMetric(metric),
-                            this.exporter.OpenMetricsRequested);
+                            this.exporter.OpenMetricsRequested,
+                            this.exporter.ScopeInfoEnabled);
 
                         break;
                     }

diff --git a/src/OpenTelemetry.Exporter.Prometheus.HttpListener/Internal/PrometheusExporter.cs b/src/OpenTelemetry.Exporter.Prometheus.HttpListener/Internal/PrometheusExporter.cs
@@ -38,6 +38,7 @@ public PrometheusExporter(PrometheusExporterOptions options)
         Guard.ThrowIfNull(options);
 
         this.ScrapeResponseCacheDurationMilliseconds = options.ScrapeResponseCacheDurationMilliseconds;
+        this.ScopeInfoEnabled = options.ScopeInfoEnabled;
 
         this.CollectionManager = new PrometheusCollectionManager(this);
     }
@@ -65,6 +66,8 @@ public PrometheusExporter(PrometheusExporterOptions options)
 
     internal bool OpenMetricsRequested { get; set; }
 
+    internal bool ScopeInfoEnabled { get; set; }
+
     /// <inheritdoc/>
     public override ExportResult Export(in Batch<Metric> metrics)
     {

diff --git a/src/OpenTelemetry.Exporter.Prometheus.HttpListener/Internal/PrometheusExporterOptions.cs b/src/OpenTelemetry.Exporter.Prometheus.HttpListener/Internal/PrometheusExporterOptions.cs
@@ -41,4 +41,9 @@ public int ScrapeResponseCacheDurationMilliseconds
             this.scrapeResponseCacheDurationMilliseconds = value;
         }
     }
+
+    /// <summary>
+    /// Gets or sets a value indicating whether to export scope info. Default value: true.
+    /// </summary>
+    public bool ScopeInfoEnabled { get; set; } = true;
 }
diff --git a/src/OpenTelemetry.Exporter.Prometheus.HttpListener/Internal/PrometheusSerializer.cs b/src/OpenTelemetry.Exporter.Prometheus.HttpListener/Internal/PrometheusSerializer.cs
@@ -379,16 +379,16 @@ public static int WriteTimestamp(byte[] buffer, int cursor, long value, bool use
     }
 
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
-    public static int WriteTags(byte[] buffer, int cursor, Metric metric, ReadOnlyTagCollection tags, bool openMetricsRequested, bool writeEnclosingBraces = true)
+    public static int WriteTags(byte[] buffer, int cursor, Metric metric, ReadOnlyTagCollection tags, bool scopeInfoEnabled, bool writeEnclosingBraces = true)
     {
-        if (tags.Count > 0 || openMetricsRequested)
+        if (tags.Count > 0 || scopeInfoEnabled)
         {
             if (writeEnclosingBraces)
             {
                 buffer[cursor++] = unchecked((byte)'{');
             }
 
-            if (openMetricsRequested)
+            if (scopeInfoEnabled)
             {
                 cursor = WriteLabel(buffer, cursor, "otel_scope_name", metric.MeterName);
                 buffer[cursor++] = unchecked((byte)',');

diff --git a/src/OpenTelemetry.Exporter.Prometheus.HttpListener/Internal/PrometheusSerializerExt.cs b/src/OpenTelemetry.Exporter.Prometheus.HttpListener/Internal/PrometheusSerializerExt.cs
@@ -35,7 +35,7 @@ public static bool CanWriteMetric(Metric metric)
         return true;
     }
 
-    public static int WriteMetric(byte[] buffer, int cursor, Metric metric, PrometheusMetric prometheusMetric, bool openMetricsRequested = false)
+    public static int WriteMetric(byte[] buffer, int cursor, Metric metric, PrometheusMetric prometheusMetric, bool openMetricsRequested = false, bool scopeInfoEnabled = true)
     {
         cursor = WriteTypeMetadata(buffer, cursor, prometheusMetric);
         cursor = WriteUnitMetadata(buffer, cursor, prometheusMetric);
@@ -49,7 +49,7 @@ public static int WriteMetric(byte[] buffer, int cursor, Metric metric, Promethe
 
                 // Counter and Gauge
                 cursor = WriteMetricName(buffer, cursor, prometheusMetric);
-                cursor = WriteTags(buffer, cursor, metric, metricPoint.Tags, openMetricsRequested);
+                cursor = WriteTags(buffer, cursor, metric, metricPoint.Tags, scopeInfoEnabled);
 
                 buffer[cursor++] = unchecked((byte)' ');
 
@@ -100,7 +100,7 @@ public static int WriteMetric(byte[] buffer, int cursor, Metric metric, Promethe
 
                     cursor = WriteMetricName(buffer, cursor, prometheusMetric);
                     cursor = WriteAsciiStringNoEscape(buffer, cursor, "_bucket{");
-                    cursor = WriteTags(buffer, cursor, metric, tags, openMetricsRequested, writeEnclosingBraces: false);
+                    cursor = WriteTags(buffer, cursor, metric, tags, scopeInfoEnabled, writeEnclosingBraces: false);
 
                     cursor = WriteAsciiStringNoEscape(buffer, cursor, "le=\"");
 
@@ -126,7 +126,7 @@ public static int WriteMetric(byte[] buffer, int cursor, Metric metric, Promethe
                 // Histogram sum
                 cursor = WriteMetricName(buffer, cursor, prometheusMetric);
                 cursor = WriteAsciiStringNoEscape(buffer, cursor, "_sum");
-                cursor = WriteTags(buffer, cursor, metric, metricPoint.Tags, openMetricsRequested);
+                cursor = WriteTags(buffer, cursor, metric, metricPoint.Tags, scopeInfoEnabled);
 
                 buffer[cursor++] = unchecked((byte)' ');
 
@@ -140,7 +140,7 @@ public static int WriteMetric(byte[] buffer, int cursor, Metric metric, Promethe
                 // Histogram count
                 cursor = WriteMetricName(buffer, cursor, prometheusMetric);
                 cursor = WriteAsciiStringNoEscape(buffer, cursor, "_count");
-                cursor = WriteTags(buffer, cursor, metric, metricPoint.Tags, openMetricsRequested);
+                cursor = WriteTags(buffer, cursor, metric, metricPoint.Tags, scopeInfoEnabled);
 
                 buffer[cursor++] = unchecked((byte)' ');
 

diff --git a/....Exporter.Prometheus.HttpListener/PrometheusHttpListenerMeterProviderBuilderExtensions.cs b/....Exporter.Prometheus.HttpListener/PrometheusHttpListenerMeterProviderBuilderExtensions.cs
@@ -78,7 +78,11 @@ public static MeterProviderBuilder AddPrometheusHttpListener(this MeterProviderB
     private static MetricReader BuildPrometheusHttpListenerMetricReader(
         PrometheusHttpListenerOptions options)
     {
-        var exporter = new PrometheusExporter(new PrometheusExporterOptions { ScrapeResponseCacheDurationMilliseconds = 0 });
+        var exporter = new PrometheusExporter(new PrometheusExporterOptions
+        {
+            ScrapeResponseCacheDurationMilliseconds = 0,
+            ScopeInfoEnabled = options.ScopeInfoEnabled,
+        });
 
         var reader = new BaseExportingMetricReader(exporter)
         {

diff --git a/src/OpenTelemetry.Exporter.Prometheus.HttpListener/PrometheusHttpListenerOptions.cs b/src/OpenTelemetry.Exporter.Prometheus.HttpListener/PrometheusHttpListenerOptions.cs
@@ -31,9 +31,9 @@ public class PrometheusHttpListenerOptions
     public string ScrapeEndpointPath { get; set; } = "/metrics";
 
     /// <summary>
-    /// Gets or sets a value indicating whether to export OpenMetrics compatible scrape responses. Default value: true.
+    /// Gets or sets a value indicating whether to export scope info. Default value: true.
     /// </summary>
-    public bool OpenMetricsEnabled { get; set; } = true;
+    public bool ScopeInfoEnabled { get; set; } = true;
 
     /// <summary>
     /// Gets or sets the URI (Uniform Resource Identifier) prefixes to use for the http listener.

diff --git a/test/OpenTelemetry.Exporter.Prometheus.AspNetCore.Tests/PrometheusExporterMiddlewareTests.cs b/test/OpenTelemetry.Exporter.Prometheus.AspNetCore.Tests/PrometheusExporterMiddlewareTests.cs
@@ -32,6 +32,8 @@ namespace OpenTelemetry.Exporter.Prometheus.AspNetCore.Tests;
 
 public sealed class PrometheusExporterMiddlewareTests
 {
+    private const string MeterVersion = "1.0.1";
+
     private static readonly string MeterName = Utils.GetCurrentMethodName();
 
     [Fact]
@@ -247,6 +249,16 @@ public Task PrometheusExporterMiddlewareIntegration_TextPlainResponse()
             acceptHeader: "text/plain");
     }
 
+    [Fact]
+    public Task PrometheusExporterMiddlewareIntegration_TextPlainResponse_NoScopeInfo()
+    {
+        return RunPrometheusExporterMiddlewareIntegrationTest(
+            "/metrics",
+            app => app.UseOpenTelemetryPrometheusScrapingEndpoint(),
+            acceptHeader: "text/plain",
+            scopeInfoEnabled: false);
+    }
+
     [Fact]
     public Task PrometheusExporterMiddlewareIntegration_UseOpenMetricsVersionHeader()
     {
@@ -256,6 +268,15 @@ public Task PrometheusExporterMiddlewareIntegration_UseOpenMetricsVersionHeader(
             acceptHeader: "application/openmetrics-text; version=1.0.0");
     }
 
+    [Fact]
+    public Task PrometheusExporterMiddlewareIntegration_NoScopeInfo()
+    {
+        return RunPrometheusExporterMiddlewareIntegrationTest(
+            "/metrics",
+            app => app.UseOpenTelemetryPrometheusScrapingEndpoint(),
+            scopeInfoEnabled: false);
+    }
+
     private static async Task RunPrometheusExporterMiddlewareIntegrationTest(
         string path,
         Action<IApplicationBuilder> configure,
@@ -264,7 +285,8 @@ public Task PrometheusExporterMiddlewareIntegration_UseOpenMetricsVersionHeader(
         bool registerMeterProvider = true,
         Action<PrometheusAspNetCoreOptions> configureOptions = null,
         bool skipMetrics = false,
-        string acceptHeader = "application/openmetrics-text")
+        string acceptHeader = "application/openmetrics-text",
+        bool scopeInfoEnabled = true)
     {
         var requestOpenMetrics = acceptHeader.StartsWith("application/openmetrics-text");
 
@@ -279,6 +301,7 @@ public Task PrometheusExporterMiddlewareIntegration_UseOpenMetricsVersionHeader(
                             .AddMeter(MeterName)
                             .AddPrometheusExporter(o =>
                             {
+                                o.ScopeInfoEnabled = scopeInfoEnabled;
                                 configureOptions?.Invoke(o);
                             }));
                    }
@@ -294,7 +317,7 @@ public Task PrometheusExporterMiddlewareIntegration_UseOpenMetricsVersionHeader(
             new KeyValuePair<string, object>("key2", "value2"),
         };
 
-        using var meter = new Meter(MeterName);
+        using var meter = new Meter(MeterName, MeterVersion);
 
         var beginTimestamp = DateTimeOffset.Now.ToUnixTimeMilliseconds();
 
@@ -331,14 +354,7 @@ public Task PrometheusExporterMiddlewareIntegration_UseOpenMetricsVersionHeader(
             }
 
             string content = await response.Content.ReadAsStringAsync();
-
-            string expected = requestOpenMetrics
-                ? "# TYPE counter_double_total counter\n"
-                  + "counter_double_total{key1='value1',key2='value2'} 101.17 (\\d+\\.\\d{3})\n"
-                  + "# EOF\n"
-                : "# TYPE counter_double_total counter\n"
-                  + "counter_double_total{key1='value1',key2='value2'} 101.17 (\\d+)\n"
-                  + "# EOF\n";
+            string expected = GetExpectedContent(requestOpenMetrics, scopeInfoEnabled);
 
             var matches = Regex.Matches(content, ("^" + expected + "$").Replace('\'', '"'));
 
@@ -357,5 +373,36 @@ public Task PrometheusExporterMiddlewareIntegration_UseOpenMetricsVersionHeader(
 
         await host.StopAsync();
     }
+
+    private static string GetExpectedContent(bool requestedOpenMetrics, bool scopeInfoEnabled)
+    {
+        if (requestedOpenMetrics && scopeInfoEnabled)
+        {
+            return "# 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"
+                   + $"counter_double_total{{otel_scope_name='{MeterName}',otel_scope_version='{MeterVersion}',key1='value1',key2='value2'}} 101.17 (\\d+\\.\\d{{3}})\n"
+                   + "# EOF\n";
+        }
+
+        if (!requestedOpenMetrics && scopeInfoEnabled)
+        {
+            return "# 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";
+        }
+
+        if (requestedOpenMetrics && !scopeInfoEnabled)
+        {
+            return "# TYPE counter_double_total counter\n"
+                   + "counter_double_total{key1='value1',key2='value2'} 101.17 (\\d+\\.\\d{3})\n"
+                   + "# EOF\n";
+        }
+
+        return "# TYPE counter_double_total counter\n"
+               + "counter_double_total{key1='value1',key2='value2'} 101.17 (\\d+)\n"
+               + "# EOF\n";
+    }
 }
 #endif