PR Comments

Author: evgenyfedorov2

src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Linux/LinuxUtilizationProvider.cs

@@ -120,8 +120,8 @@ public LinuxUtilizationProvider(IOptions<ResourceMonitoringOptions> options, ILi
             unit: "1");
 
         _ = meter.CreateObservableUpDownCounter(
-            name: ResourceUtilizationInstruments.ContainerMemoryUtilization,
-            observeValues: () => GetMeasurementWithRetry(() => (long)MemoryUtilization()),
+            name: ResourceUtilizationInstruments.ContainerMemoryUsage,
+            observeValues: () => GetMeasurementWithRetry(() => (long)MemoryUsage()),
             unit: "By",
             description: "Memory usage of the container.");
 
@@ -222,7 +222,7 @@ public double CpuUtilization()
         return _cpuPercentage;
     }
 
-    public ulong MemoryUtilization()
+    public ulong MemoryUsage()
     {
         DateTimeOffset now = _timeProvider.GetUtcNow();
 
@@ -270,7 +270,7 @@ public Snapshot GetSnapshot()
 
     private double MemoryPercentage()
     {
-        ulong memoryUsage = MemoryUtilization();
+        ulong memoryUsage = MemoryUsage();
         double memoryPercentage = Math.Min(One, (double)memoryUsage / _memoryLimit);
 
         _logger.MemoryPercentageData(memoryUsage, _memoryLimit, memoryPercentage);

src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Linux/Log.cs

@@ -57,7 +57,7 @@ public static partial void HandleDiskStatsException(
         string errorMessage);
 
     [LoggerMessage(6, LogLevel.Debug,
-        "Computed memory usage with MemoryUsedInBytes = {memoryUsed}.")]
+        "Computed memory usage = {memoryUsed}.")]
     public static partial void MemoryUsageData(
         this ILogger logger,
         ulong memoryUsed);

src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Windows/Log.cs

@@ -26,7 +26,7 @@ public static partial void CpuUsageData(
         double cpuPercentage);
 
     [LoggerMessage(4, LogLevel.Debug,
-        "Computed memory usage with CurrentMemoryUsage = {currentMemoryUsage}, TotalMemory = {totalMemory}, MemoryPercentage = {memoryPercentage}.")]
+        "Computed memory usage with MemoryUsed = {memoryUsed}, MemoryLimit = {memoryLimit}, MemoryPercentage = {memoryPercentage}.")]
     public static partial void MemoryPercentageData(
         this ILogger logger,
         ulong currentMemoryUsage,

src/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring/Windows/WindowsContainerSnapshotProvider.cs

@@ -131,7 +131,7 @@ internal WindowsContainerSnapshotProvider(
             observeValue: () => MemoryPercentage(() => _processInfo.GetMemoryUsage()));
 
         _ = meter.CreateObservableUpDownCounter(
-            name: ResourceUtilizationInstruments.ContainerMemoryUtilization,
+            name: ResourceUtilizationInstruments.ContainerMemoryUsage,
             observeValue: () => (long)MemoryUsage(() => _processInfo.GetMemoryUsage()),
             unit: "By",
             description: "Memory usage of the container.");

src/Shared/Instruments/ResourceUtilizationInstruments.cs

@@ -51,12 +51,12 @@ internal static class ResourceUtilizationInstruments
     public const string ContainerMemoryLimitUtilization = "container.memory.limit.utilization";
 
     /// <summary>
-    /// The name of an instrument to retrieve memory consumption of all processes running inside a container or control group in range <c>[0, 1]</c>.
+    /// The name of an instrument to retrieve memory usage measured in bytes of all processes running inside a container or control group.
     /// </summary>
     /// <remarks>
-    /// The type of an instrument is <see cref="System.Diagnostics.Metrics.ObservableGauge{T}"/>.
+    /// The type of an instrument is <see cref="System.Diagnostics.Metrics.ObservableUpDownCounter{T}"/>.
     /// </remarks>
-    public const string ContainerMemoryUtilization = "container.memory.utilization";
+    public const string ContainerMemoryUsage = "container.memory.usage";
 
     /// <summary>
     /// The name of an instrument to retrieve CPU consumption share of the running process in range <c>[0, 1]</c>.

test/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring.Tests/Linux/AcceptanceTest.cs

@@ -223,7 +223,13 @@ public Task ResourceUtilizationTracker_And_Metrics_Report_Same_Values_With_Cgrou
         listener.InstrumentPublished = (Instrument instrument, MeterListener meterListener)
             => OnInstrumentPublished(instrument, meterListener, meterScope);
         listener.SetMeasurementEventCallback<double>((m, f, tags, _)
-            => OnMeasurementReceived(m, f, tags, ref cpuUserTime, ref cpuKernelTime, ref cpuFromGauge, ref cpuLimitFromGauge,
+            => OnMeasurementReceived(m,
+                f,
+                tags,
+                ref cpuUserTime,
+                ref cpuKernelTime,
+                ref cpuFromGauge,
+                ref cpuLimitFromGauge,
             ref cpuRequestFromGauge, ref memoryFromGauge, ref memoryLimitFromGauge));
         listener.Start();
 
@@ -310,13 +316,20 @@ public Task ResourceUtilizationTracker_And_Metrics_Report_Same_Values_With_Cgrou
         listener.InstrumentPublished = (Instrument instrument, MeterListener meterListener)
             => OnInstrumentPublished(instrument, meterListener, meterScope);
         listener.SetMeasurementEventCallback<double>((m, f, tags, _)
-            => OnMeasurementReceived(
-                m, f, tags, ref cpuUserTime, ref cpuKernelTime, ref cpuFromGauge, ref cpuLimitFromGauge,
-                ref cpuRequestFromGauge, ref memoryFromGauge, ref memoryLimitFromGauge));
+            => OnMeasurementReceived(m,
+                f,
+                tags,
+                ref cpuUserTime,
+                ref cpuKernelTime,
+                ref cpuFromGauge,
+                ref cpuLimitFromGauge,
+                ref cpuRequestFromGauge,
+                ref memoryFromGauge,
+                ref memoryLimitFromGauge));
         listener.SetMeasurementEventCallback<long>((instrument, value, tags, _)
             =>
         {
-            if (instrument.Name == ResourceUtilizationInstruments.ContainerMemoryUtilization)
+            if (instrument.Name == ResourceUtilizationInstruments.ContainerMemoryUsage)
             {
                 memoryUsageFromGauge = value;
             }
@@ -469,7 +482,7 @@ private static void OnInstrumentPublished(Instrument instrument, MeterListener m
             instrument.Name == ResourceUtilizationInstruments.ContainerCpuRequestUtilization ||
             instrument.Name == ResourceUtilizationInstruments.ContainerCpuLimitUtilization ||
             instrument.Name == ResourceUtilizationInstruments.ContainerMemoryLimitUtilization ||
-            instrument.Name == ResourceUtilizationInstruments.ContainerMemoryUtilization)
+            instrument.Name == ResourceUtilizationInstruments.ContainerMemoryUsage)
         {
             meterListener.EnableMeasurementEvents(instrument);
         }

test/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring.Tests/Linux/LinuxUtilizationProviderTests.cs

@@ -94,8 +94,8 @@ public void Provider_Registers_Instruments()
         Assert.Contains(samples, x => x.instrument.Name == ResourceUtilizationInstruments.ContainerMemoryLimitUtilization);
         Assert.Equal(0.5, samples.Single(i => i.instrument.Name == ResourceUtilizationInstruments.ContainerMemoryLimitUtilization).value);
 
-        Assert.Contains(samples, x => x.instrument.Name == ResourceUtilizationInstruments.ContainerMemoryUtilization);
-        Assert.Equal(524288, samples.Single(i => i.instrument.Name == ResourceUtilizationInstruments.ContainerMemoryUtilization).value);
+        Assert.Contains(samples, x => x.instrument.Name == ResourceUtilizationInstruments.ContainerMemoryUsage);
+        Assert.Equal(524288, samples.Single(i => i.instrument.Name == ResourceUtilizationInstruments.ContainerMemoryUsage).value);
 
         Assert.Contains(samples, x => x.instrument.Name == ResourceUtilizationInstruments.ProcessCpuUtilization);
         Assert.True(double.IsNaN(samples.Single(i => i.instrument.Name == ResourceUtilizationInstruments.ProcessCpuUtilization).value));

test/Libraries/Microsoft.Extensions.Diagnostics.ResourceMonitoring.Tests/Windows/WindowsContainerSnapshotProviderTests.cs

@@ -403,7 +403,7 @@ public void SnapshotProvider_EmitsMemoryUsageMetric()
         var meterFactoryMock = new Mock<IMeterFactory>();
         meterFactoryMock.Setup(x => x.Create(It.IsAny<MeterOptions>()))
             .Returns(meter);
-        using var metricCollector = new MetricCollector<long>(meter, ResourceUtilizationInstruments.ContainerMemoryUtilization, fakeClock);
+        using var metricCollector = new MetricCollector<long>(meter, ResourceUtilizationInstruments.ContainerMemoryUsage, fakeClock);
 
         var options = new ResourceMonitoringOptions
         {
@@ -422,22 +422,22 @@ public void SnapshotProvider_EmitsMemoryUsageMetric()
         // Step #0 - state in the beginning:
         metricCollector.RecordObservableInstruments();
         Assert.NotNull(metricCollector.LastMeasurement?.Value);
-        Assert.Equal(200, metricCollector.LastMeasurement.Value); // Consuming 200MB initially.
+        Assert.Equal(200, metricCollector.LastMeasurement.Value); // Consuming 200 bytes initially.
 
         // Step #1 - simulate 1 millisecond passing and collect metrics again:
         fakeClock.Advance(options.MemoryConsumptionRefreshInterval - TimeSpan.FromMilliseconds(1));
         metricCollector.RecordObservableInstruments();
-        Assert.Equal(200, metricCollector.LastMeasurement.Value); // Still consuming 200MB as gauge wasn't updated.
+        Assert.Equal(200, metricCollector.LastMeasurement.Value); // Still consuming 200 bytes as metric wasn't updated.
 
         // Step #2 - simulate 2 milliseconds passing and collect metrics again:
         fakeClock.Advance(TimeSpan.FromMilliseconds(2));
         metricCollector.RecordObservableInstruments();
-        Assert.Equal(600, metricCollector.LastMeasurement.Value); // Consuming 600MB of the memory afterward.
+        Assert.Equal(600, metricCollector.LastMeasurement.Value); // Consuming 600 bytes.
 
         // Step #3 - simulate 2 milliseconds passing and collect metrics again:
         fakeClock.Advance(TimeSpan.FromMilliseconds(2));
         metricCollector.RecordObservableInstruments();
-        Assert.Equal(300, metricCollector.LastMeasurement.Value); // Consuming 300MB of the memory afterward.
+        Assert.Equal(300, metricCollector.LastMeasurement.Value); // Consuming 300 bytes.
     }
 
     [Fact]