delete AddLegacyMetrics from GCTotalMemoryCollector

Author: phnx47

src/Prometheus.Client/Collectors/DefaultCollectors.cs

@@ -1,4 +1,3 @@
-using System;
 using Prometheus.Client.Collectors.DotNetStats;
 using Prometheus.Client.Collectors.ProcessStats;
 
@@ -18,19 +17,4 @@ public static ICollectorRegistry UseDefaultCollectors(this ICollectorRegistry re
 
         return registry;
     }
-
-    [Obsolete("'addLegacyMetrics' will be removed in future versions")]
-    public static ICollectorRegistry UseDefaultCollectors(this ICollectorRegistry registry, bool addLegacyMetrics)
-    {
-        return UseDefaultCollectors(registry, string.Empty, addLegacyMetrics);
-    }
-
-    [Obsolete("'addLegacyMetrics' will be removed in future versions")]
-    public static ICollectorRegistry UseDefaultCollectors(this ICollectorRegistry registry, string prefixName, bool addLegacyMetrics)
-    {
-        registry.UseDotNetStats(prefixName, addLegacyMetrics);
-        registry.UseProcessStats(prefixName);
-
-        return registry;
-    }
 }

src/Prometheus.Client/Collectors/DotNetStats/CollectorRegistryExtensions.cs

@@ -16,19 +16,4 @@ public static ICollectorRegistry UseDotNetStats(this ICollectorRegistry registry
 
         return registry;
     }
-
-    [Obsolete("'addLegacyMetrics' will be removed in future versions")]
-    public static ICollectorRegistry UseDotNetStats(this ICollectorRegistry registry, bool addLegacyMetrics)
-    {
-        return UseDotNetStats(registry, string.Empty, addLegacyMetrics);
-    }
-
-    [Obsolete("'addLegacyMetrics' will be removed in future versions")]
-    public static ICollectorRegistry UseDotNetStats(this ICollectorRegistry registry, string prefixName, bool addLegacyMetrics)
-    {
-        registry.Add(new GCCollectionCountCollector(prefixName));
-        registry.Add(new GCTotalMemoryCollector(prefixName, addLegacyMetrics));
-
-        return registry;
-    }
 }

src/Prometheus.Client/Collectors/DotNetStats/GCCollectionCountCollector.cs

@@ -4,6 +4,9 @@
 
 namespace Prometheus.Client.Collectors.DotNetStats;
 
+/// <summary>
+/// Collector for GC collection count.
+/// </summary>
 public class GCCollectionCountCollector : ICollector
 {
     private const string _help = "GC collection count";
@@ -23,7 +26,7 @@ public GCCollectionCountCollector(string prefixName)
     {
         _name = prefixName + "dotnet_collection_count_total";
         Configuration = new CollectorConfiguration(nameof(GCCollectionCountCollector));
-        MetricNames = new[] { _name };
+        MetricNames = [_name];
         _genNames = new string[GC.MaxGeneration + 1];
         for (var gen = 0; gen <= GC.MaxGeneration; gen++)
             _genNames[gen] = gen.ToString();

src/Prometheus.Client/Collectors/DotNetStats/GCTotalMemoryCollector.cs

@@ -2,16 +2,15 @@
 using System.Collections.Generic;
 using Prometheus.Client.MetricsWriter;
 
-#pragma warning disable CS0618
-
 namespace Prometheus.Client.Collectors.DotNetStats;
 
+/// <summary>
+/// Collector for GC total known allocated memory.
+/// </summary>
 public class GCTotalMemoryCollector : ICollector
 {
     private const string _help = "Total known allocated memory in bytes";
     private readonly string _name;
-    private readonly string _legacyName;
-    private readonly bool _addLegacyMetrics;
 
     public CollectorConfiguration Configuration { get; }
     public IReadOnlyList<string> MetricNames { get; }
@@ -22,39 +21,17 @@ public GCTotalMemoryCollector()
     }
 
     public GCTotalMemoryCollector(string prefixName)
-        : this(prefixName, false)
     {
-    }
-
-    [Obsolete("'addLegacyMetrics' will be removed in future versions")]
-    public GCTotalMemoryCollector(bool addLegacyMetrics)
-        : this(string.Empty, addLegacyMetrics)
-    {
-    }
-
-    [Obsolete("'addLegacyMetrics' will be removed in future versions")]
-    public GCTotalMemoryCollector(string prefixName, bool addLegacyMetrics)
-    {
-        _legacyName = prefixName + "dotnet_totalmemory";
         _name = prefixName + "dotnet_total_memory_bytes";
 
-        _addLegacyMetrics = addLegacyMetrics;
-
         Configuration = new CollectorConfiguration(nameof(GCTotalMemoryCollector));
-        MetricNames = _addLegacyMetrics ? new[] { _legacyName, _name } : new[] { _name };
+        MetricNames = [_name];
     }
 
     public void Collect(IMetricsWriter writer)
     {
         writer.WriteMetricHeader(_name, MetricType.Gauge, _help);
         writer.WriteSample(GC.GetTotalMemory(false));
         writer.EndMetric();
-
-        if (_addLegacyMetrics)
-        {
-            writer.WriteMetricHeader(_legacyName, MetricType.Gauge, _help);
-            writer.WriteSample(GC.GetTotalMemory(false));
-            writer.EndMetric();
-        }
     }
 }

tests/Prometheus.Client.Tests/CollectorTests/GCTotalMemoryCollectorTests.cs

@@ -21,22 +21,6 @@ public void Check_MetricNames(string prefixName)
         Assert.Equal(prefixName + "dotnet_total_memory_bytes", collector.MetricNames.First());
     }
 
-    [Theory]
-    [InlineData("")]
-    [InlineData("123")]
-    [InlineData("promitor_")]
-    [InlineData("myprefix_")]
-    public void Check_MetricNames_WithAddLegacy(string prefixName)
-    {
-        var collector = new GCTotalMemoryCollector(prefixName, true);
-
-        var legacyMetric = collector.MetricNames[0];
-        var metric = collector.MetricNames[1];
-
-        Assert.Equal(prefixName + "dotnet_totalmemory", legacyMetric);
-        Assert.Equal(prefixName + "dotnet_total_memory_bytes", metric);
-    }
-
     [Fact]
     public void Check_Collect_NoPrefix()
     {
@@ -51,20 +35,6 @@ public void Check_Collect_NoPrefix()
         Assert.Contains("# TYPE dotnet_total_memory_bytes gauge", response);
     }
 
-    [Fact]
-    public void Check_Collect_NoPrefix_WithAddLegacy()
-    {
-        using var stream = new MemoryStream();
-        var metricWriter = new MetricsTextWriter(stream);
-        var collector = new GCTotalMemoryCollector(true);
-        collector.Collect(metricWriter);
-        metricWriter.FlushAsync();
-
-        var response = Encoding.UTF8.GetString(stream.ToArray());
-
-        Assert.Contains("# TYPE dotnet_totalmemory gauge", response);
-    }
-
     [Theory]
     [InlineData("")]
     [InlineData("123")]