Merge pull request #352 from prom-client-net/delete-add-legacy-metrics

phnx47 · web-flow · commit 81c8bf6540f5 · 2025-05-23T21:55:15.000+07:00
delete addLegacyMetrics
diff --git a/src/Prometheus.Client/Collectors/DefaultCollectors.cs b/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, addLegacyMetrics);
-
-        return registry;
-    }
 }
diff --git a/src/Prometheus.Client/Collectors/DotNetStats/CollectorRegistryExtensions.cs b/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;
-    }
 }
diff --git a/src/Prometheus.Client/Collectors/DotNetStats/GCCollectionCountCollector.cs b/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();
diff --git a/src/Prometheus.Client/Collectors/DotNetStats/GCTotalMemoryCollector.cs b/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();
-        }
     }
 }
diff --git a/src/Prometheus.Client/Collectors/ProcessStats/CollectorRegistryExtensions.cs b/src/Prometheus.Client/Collectors/ProcessStats/CollectorRegistryExtensions.cs
@@ -1,4 +1,3 @@
-using System;
 using System.Diagnostics;
 
 namespace Prometheus.Client.Collectors.ProcessStats;
@@ -16,18 +15,4 @@ public static ICollectorRegistry UseProcessStats(this ICollectorRegistry registr
 
         return registry;
     }
-
-    [Obsolete("'addLegacyMetrics' will be removed in future versions")]
-    public static ICollectorRegistry UseProcessStats(this ICollectorRegistry registry, bool addLegacyMetrics)
-    {
-        return UseProcessStats(registry, string.Empty, addLegacyMetrics);
-    }
-
-    [Obsolete("'addLegacyMetrics' will be removed in future versions")]
-    public static ICollectorRegistry UseProcessStats(this ICollectorRegistry registry, string prefixName, bool addLegacyMetrics)
-    {
-        registry.Add(new ProcessCollector(Process.GetCurrentProcess(), prefixName, addLegacyMetrics));
-
-        return registry;
-    }
 }
diff --git a/src/Prometheus.Client/Collectors/ProcessStats/ProcessCollector.cs b/src/Prometheus.Client/Collectors/ProcessStats/ProcessCollector.cs
@@ -3,13 +3,10 @@
 using System.Diagnostics;
 using Prometheus.Client.MetricsWriter;
 
-#pragma warning disable CS0618
-
 namespace Prometheus.Client.Collectors.ProcessStats;
 
-/// <inheritdoc />
 /// <summary>
-///     Collects metrics on .net without performance counters
+/// Collector for .NET runtime metrics without performance counters.
 /// </summary>
 public class ProcessCollector : ICollector
 {
@@ -22,13 +19,10 @@ public class ProcessCollector : ICollector
     private const string _startTimeSecondsHelp = "Start time of the process since unix epoch in seconds";
 
     private readonly string _virtualMemoryBytesName;
-    private readonly string _legacyVirtualMemoryBytesName;
     private const string _virtualMemoryBytesHelp = "Process virtual memory size in bytes";
     private readonly string _workingSetBytesName;
-    private readonly string _legacyWorkingSetBytesName;
     private const string _workingSetBytesHelp = "Process working set in bytes";
     private readonly string _privateMemoryBytesName;
-    private readonly string _legacyPrivateMemoryBytesName;
     private const string _privateMemoryBytesHelp = "Process private memory size in bytes";
 
     private readonly string _numThreadsName;
@@ -38,7 +32,6 @@ public class ProcessCollector : ICollector
 
     private readonly Process _process;
     private readonly double _processStartTime;
-    private readonly bool _addLegacyMetrics;
 
     public CollectorConfiguration Configuration { get; }
 
@@ -50,52 +43,35 @@ public ProcessCollector(Process process)
     }
 
     public ProcessCollector(Process process, string prefixName)
-        : this(process, prefixName, false)
-    {
-    }
-
-    [Obsolete("'addLegacyMetrics' will be removed in future versions")]
-    public ProcessCollector(Process process, bool addLegacyMetricNames)
-        : this(process, string.Empty, addLegacyMetricNames)
-    {
-    }
-
-    [Obsolete("'addLegacyMetrics' will be removed in future versions")]
-    public ProcessCollector(Process process, string prefixName, bool addLegacyMetrics)
     {
         _processIdName = prefixName + "process_processid";
 
         _cpuSecondsTotalName = prefixName + "process_cpu_seconds_total";
         _startTimeSecondsName = prefixName + "process_start_time_seconds";
 
         _virtualMemoryBytesName = prefixName + "process_virtual_memory_bytes";
-        _legacyVirtualMemoryBytesName = prefixName + "process_virtual_bytes";
         _workingSetBytesName = prefixName + "process_working_set_bytes";
-        _legacyWorkingSetBytesName = prefixName + "process_working_set";
         _privateMemoryBytesName = prefixName + "process_private_memory_bytes";
-        _legacyPrivateMemoryBytesName = prefixName + "process_private_bytes";
 
         _numThreadsName = prefixName + "process_num_threads";
         _openHandlesName = prefixName + "process_open_handles";
 
         _process = process;
 
-        _addLegacyMetrics = addLegacyMetrics;
-
         Configuration = new CollectorConfiguration(nameof(ProcessCollector));
 
         _processStartTime = ((DateTimeOffset)_process.StartTime.ToUniversalTime()).ToUnixTimeSeconds();
-        MetricNames = _addLegacyMetrics
-            ? new[]
-            {
-                _processIdName, _cpuSecondsTotalName, _startTimeSecondsName, _legacyVirtualMemoryBytesName, _virtualMemoryBytesName, _legacyWorkingSetBytesName,
-                _workingSetBytesName, _legacyPrivateMemoryBytesName, _privateMemoryBytesName, _numThreadsName, _openHandlesName
-            }
-            : new[]
-            {
-                _processIdName, _cpuSecondsTotalName, _startTimeSecondsName, _virtualMemoryBytesName, _workingSetBytesName, _privateMemoryBytesName, _numThreadsName,
-                _openHandlesName
-            };
+        MetricNames =
+        [
+            _processIdName,
+            _cpuSecondsTotalName,
+            _startTimeSecondsName,
+            _virtualMemoryBytesName,
+            _workingSetBytesName,
+            _privateMemoryBytesName,
+            _numThreadsName,
+            _openHandlesName
+        ];
     }
 
     public void Collect(IMetricsWriter writer)
@@ -114,35 +90,14 @@ public void Collect(IMetricsWriter writer)
         writer.WriteSample(_processStartTime);
         writer.EndMetric();
 
-        if (_addLegacyMetrics)
-        {
-            writer.WriteMetricHeader(_legacyVirtualMemoryBytesName, MetricType.Gauge, _virtualMemoryBytesHelp);
-            writer.WriteSample(_process.VirtualMemorySize64);
-            writer.EndMetric();
-        }
-
         writer.WriteMetricHeader(_virtualMemoryBytesName, MetricType.Gauge, _virtualMemoryBytesHelp);
         writer.WriteSample(_process.VirtualMemorySize64);
         writer.EndMetric();
 
-        if (_addLegacyMetrics)
-        {
-            writer.WriteMetricHeader(_legacyWorkingSetBytesName, MetricType.Gauge, _workingSetBytesHelp);
-            writer.WriteSample(_process.WorkingSet64);
-            writer.EndMetric();
-        }
-
         writer.WriteMetricHeader(_workingSetBytesName, MetricType.Gauge, _workingSetBytesHelp);
         writer.WriteSample(_process.WorkingSet64);
         writer.EndMetric();
 
-        if (_addLegacyMetrics)
-        {
-            writer.WriteMetricHeader(_legacyPrivateMemoryBytesName, MetricType.Gauge, _privateMemoryBytesHelp);
-            writer.WriteSample(_process.PrivateMemorySize64);
-            writer.EndMetric();
-        }
-
         writer.WriteMetricHeader(_privateMemoryBytesName, MetricType.Gauge, _privateMemoryBytesHelp);
         writer.WriteSample(_process.PrivateMemorySize64);
         writer.EndMetric();
diff --git a/tests/Prometheus.Client.Tests/CollectorTests/GCTotalMemoryCollectorTests.cs b/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")]
diff --git a/tests/Prometheus.Client.Tests/CollectorTests/ProcessCollectorTests.cs b/tests/Prometheus.Client.Tests/CollectorTests/ProcessCollectorTests.cs
@@ -27,27 +27,6 @@ public void Check_MetricNames(string prefixName)
         Assert.Contains(prefixName + "process_start_time_seconds", collector.MetricNames);
     }
 
-    [Theory]
-    [InlineData("")]
-    [InlineData("123")]
-    [InlineData("promitor_")]
-    [InlineData("myprefix_")]
-    public void Check_MetricNames_WithAddLegacy(string prefixName)
-    {
-        var collector = new ProcessCollector(Process.GetCurrentProcess(), prefixName, true);
-
-        Assert.Contains(prefixName + "process_cpu_seconds_total", collector.MetricNames);
-        Assert.Contains(prefixName + "process_virtual_bytes", collector.MetricNames);
-        Assert.Contains(prefixName + "process_virtual_memory_bytes", collector.MetricNames);
-        Assert.Contains(prefixName + "process_working_set", collector.MetricNames);
-        Assert.Contains(prefixName + "process_working_set_bytes", collector.MetricNames);
-        Assert.Contains(prefixName + "process_private_bytes", collector.MetricNames);
-        Assert.Contains(prefixName + "process_private_memory_bytes", collector.MetricNames);
-        Assert.Contains(prefixName + "process_num_threads", collector.MetricNames);
-        Assert.Contains(prefixName + "process_processid", collector.MetricNames);
-        Assert.Contains(prefixName + "process_start_time_seconds", collector.MetricNames);
-    }
-
     [Fact]
     public void Check_Collect_NoPrefix()
     {
@@ -68,29 +47,6 @@ public void Check_Collect_NoPrefix()
         Assert.Contains("# TYPE process_start_time_seconds gauge", response);
     }
 
-    [Fact]
-    public void Check_Collect_NoPrefix_WithAddLegacy()
-    {
-        using var stream = new MemoryStream();
-        var metricWriter = new MetricsTextWriter(stream);
-        var collector = new ProcessCollector(Process.GetCurrentProcess(), true);
-        collector.Collect(metricWriter);
-        metricWriter.FlushAsync();
-
-        var response = Encoding.UTF8.GetString(stream.ToArray());
-
-        Assert.Contains("# TYPE process_cpu_seconds_total counter", response);
-        Assert.Contains("# TYPE process_virtual_bytes gauge", response);
-        Assert.Contains("# TYPE process_virtual_memory_bytes gauge", response);
-        Assert.Contains("# TYPE process_working_set gauge", response);
-        Assert.Contains("# TYPE process_working_set_bytes gauge", response);
-        Assert.Contains("# TYPE process_private_bytes gauge", response);
-        Assert.Contains("# TYPE process_private_memory_bytes gauge", response);
-        Assert.Contains("# TYPE process_num_threads gauge", response);
-        Assert.Contains("# TYPE process_processid gauge", response);
-        Assert.Contains("# TYPE process_start_time_seconds gauge", response);
-    }
-
     [Theory]
     [InlineData(null)]
     [InlineData("")]
