Server memory pool metrics updates

Author: JamesNK

src/Servers/Connections.Abstractions/src/IMemoryPoolFactory.cs

@@ -13,6 +13,7 @@ public interface IMemoryPoolFactory<T>
     /// <summary>
     /// Creates a new instance of a memory pool.
     /// </summary>
+    /// <param name="options">Options for configuring the memory pool.</param>
     /// <returns>A new memory pool instance.</returns>
-    MemoryPool<T> Create();
+    MemoryPool<T> Create(MemoryPoolOptions options);
 }

src/Servers/Connections.Abstractions/src/MemoryPoolOptions.cs

@@ -0,0 +1,15 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Microsoft.AspNetCore.Connections;
+
+/// <summary>
+/// Options for configuring a memory pool.
+/// </summary>
+public sealed class MemoryPoolOptions
+{
+    /// <summary>
+    /// Gets or sets the owner of the memory pool. This is used for logging and diagnostics purposes.
+    /// </summary>
+    public string? Owner { get; set; }
+}

src/Servers/Connections.Abstractions/src/PublicAPI/net10.0/PublicAPI.Unshipped.txt

@@ -1,3 +1,7 @@
 #nullable enable
 Microsoft.AspNetCore.Connections.IMemoryPoolFactory<T>
-Microsoft.AspNetCore.Connections.IMemoryPoolFactory<T>.Create() -> System.Buffers.MemoryPool<T>!
+Microsoft.AspNetCore.Connections.IMemoryPoolFactory<T>.Create(Microsoft.AspNetCore.Connections.MemoryPoolOptions! options) -> System.Buffers.MemoryPool<T>!
+Microsoft.AspNetCore.Connections.MemoryPoolOptions
+Microsoft.AspNetCore.Connections.MemoryPoolOptions.MemoryPoolOptions() -> void
+Microsoft.AspNetCore.Connections.MemoryPoolOptions.Owner.get -> string?
+Microsoft.AspNetCore.Connections.MemoryPoolOptions.Owner.set -> void

src/Servers/Connections.Abstractions/src/PublicAPI/net462/PublicAPI.Unshipped.txt

@@ -1,3 +1,7 @@
 #nullable enable
 Microsoft.AspNetCore.Connections.IMemoryPoolFactory<T>
-Microsoft.AspNetCore.Connections.IMemoryPoolFactory<T>.Create() -> System.Buffers.MemoryPool<T>!
+Microsoft.AspNetCore.Connections.IMemoryPoolFactory<T>.Create(Microsoft.AspNetCore.Connections.MemoryPoolOptions! options) -> System.Buffers.MemoryPool<T>!
+Microsoft.AspNetCore.Connections.MemoryPoolOptions
+Microsoft.AspNetCore.Connections.MemoryPoolOptions.MemoryPoolOptions() -> void
+Microsoft.AspNetCore.Connections.MemoryPoolOptions.Owner.get -> string?
+Microsoft.AspNetCore.Connections.MemoryPoolOptions.Owner.set -> void

src/Servers/Connections.Abstractions/src/PublicAPI/netstandard2.0/PublicAPI.Unshipped.txt

@@ -1,3 +1,7 @@
 #nullable enable
 Microsoft.AspNetCore.Connections.IMemoryPoolFactory<T>
-Microsoft.AspNetCore.Connections.IMemoryPoolFactory<T>.Create() -> System.Buffers.MemoryPool<T>!
+Microsoft.AspNetCore.Connections.IMemoryPoolFactory<T>.Create(Microsoft.AspNetCore.Connections.MemoryPoolOptions! options) -> System.Buffers.MemoryPool<T>!
+Microsoft.AspNetCore.Connections.MemoryPoolOptions
+Microsoft.AspNetCore.Connections.MemoryPoolOptions.MemoryPoolOptions() -> void
+Microsoft.AspNetCore.Connections.MemoryPoolOptions.Owner.get -> string?
+Microsoft.AspNetCore.Connections.MemoryPoolOptions.Owner.set -> void

src/Servers/Connections.Abstractions/src/PublicAPI/netstandard2.1/PublicAPI.Unshipped.txt

@@ -1,3 +1,7 @@
 #nullable enable
 Microsoft.AspNetCore.Connections.IMemoryPoolFactory<T>
-Microsoft.AspNetCore.Connections.IMemoryPoolFactory<T>.Create() -> System.Buffers.MemoryPool<T>!
+Microsoft.AspNetCore.Connections.IMemoryPoolFactory<T>.Create(Microsoft.AspNetCore.Connections.MemoryPoolOptions! options) -> System.Buffers.MemoryPool<T>!
+Microsoft.AspNetCore.Connections.MemoryPoolOptions
+Microsoft.AspNetCore.Connections.MemoryPoolOptions.MemoryPoolOptions() -> void
+Microsoft.AspNetCore.Connections.MemoryPoolOptions.Owner.get -> string?
+Microsoft.AspNetCore.Connections.MemoryPoolOptions.Owner.set -> void

src/Servers/IIS/IIS/src/Core/IISHttpServer.cs

@@ -66,7 +66,7 @@ public IISHttpServer(
         ILogger<IISHttpServer> logger
         )
     {
-        _memoryPool = memoryPoolFactory.Create();
+        _memoryPool = memoryPoolFactory.Create(new MemoryPoolOptions { Owner = "iis" });
         _nativeApplication = nativeApplication;
         _applicationLifetime = applicationLifetime;
         _logger = logger;

src/Servers/IIS/IIS/src/WebHostBuilderIISExtensions.cs

@@ -57,6 +57,7 @@ public static IWebHostBuilder UseIIS(this IWebHostBuilder hostBuilder)
                     );
 
                     services.TryAddSingleton<IMemoryPoolFactory<byte>, DefaultMemoryPoolFactory>();
+                    services.TryAddSingleton<MemoryPoolMetrics>();
                 });
         }
 

src/Servers/Kestrel/Core/src/Internal/PinnedBlockMemoryPoolFactory.cs

@@ -3,7 +3,6 @@
 
 using System.Buffers;
 using System.Collections.Concurrent;
-using System.Diagnostics.Metrics;
 using Microsoft.AspNetCore.Connections;
 using Microsoft.AspNetCore.Server.Kestrel.Core.Internal.Infrastructure;
 using Microsoft.Extensions.Logging;
@@ -12,22 +11,22 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Core.Internal;
 
 internal sealed class PinnedBlockMemoryPoolFactory : IMemoryPoolFactory<byte>, IHeartbeatHandler
 {
-    private readonly IMeterFactory _meterFactory;
+    private readonly MemoryPoolMetrics _metrics;
     private readonly ILogger? _logger;
     private readonly TimeProvider _timeProvider;
     // micro-optimization: Using nuint as the value type to avoid GC write barriers; could replace with ConcurrentHashSet if that becomes available
     private readonly ConcurrentDictionary<PinnedBlockMemoryPool, nuint> _pools = new();
 
-    public PinnedBlockMemoryPoolFactory(IMeterFactory meterFactory, TimeProvider? timeProvider = null, ILogger<PinnedBlockMemoryPoolFactory>? logger = null)
+    public PinnedBlockMemoryPoolFactory(MemoryPoolMetrics metrics, TimeProvider? timeProvider = null, ILogger<PinnedBlockMemoryPoolFactory>? logger = null)
     {
         _timeProvider = timeProvider ?? TimeProvider.System;
-        _meterFactory = meterFactory;
+        _metrics = metrics;
         _logger = logger;
     }
 
-    public MemoryPool<byte> Create()
+    public MemoryPool<byte> Create(MemoryPoolOptions options)
     {
-        var pool = new PinnedBlockMemoryPool(_meterFactory, _logger);
+        var pool = new PinnedBlockMemoryPool(options.Owner, _metrics, _logger);
 
         _pools.TryAdd(pool, nuint.Zero);
 

src/Servers/Kestrel/Core/test/PinnedBlockMemoryPoolFactoryTests.cs

@@ -4,6 +4,7 @@
 using System.Buffers;
 using System.Collections.Concurrent;
 using System.Reflection;
+using Microsoft.AspNetCore.Connections;
 using Microsoft.AspNetCore.InternalTesting;
 using Microsoft.AspNetCore.Server.Kestrel.Core.Internal;
 using Microsoft.Extensions.Time.Testing;
@@ -15,18 +16,18 @@ public class PinnedBlockMemoryPoolFactoryTests
     [Fact]
     public void CreatePool()
     {
-        var factory = new PinnedBlockMemoryPoolFactory(new TestMeterFactory());
-        var pool = factory.Create();
+        var factory = CreateMemoryPoolFactory();
+        var pool = factory.Create(new MemoryPoolOptions());
         Assert.NotNull(pool);
         Assert.IsType<PinnedBlockMemoryPool>(pool);
     }
 
     [Fact]
     public void CreateMultiplePools()
     {
-        var factory = new PinnedBlockMemoryPoolFactory(new TestMeterFactory());
-        var pool1 = factory.Create();
-        var pool2 = factory.Create();
+        var factory = CreateMemoryPoolFactory();
+        var pool1 = factory.Create(new MemoryPoolOptions());
+        var pool2 = factory.Create(new MemoryPoolOptions());
 
         Assert.NotNull(pool1);
         Assert.NotNull(pool2);
@@ -36,8 +37,8 @@ public void CreateMultiplePools()
     [Fact]
     public void DisposePoolRemovesFromFactory()
     {
-        var factory = new PinnedBlockMemoryPoolFactory(new TestMeterFactory());
-        var pool = factory.Create();
+        var factory = CreateMemoryPoolFactory();
+        var pool = factory.Create(new MemoryPoolOptions());
         Assert.NotNull(pool);
 
         var dict = (ConcurrentDictionary<PinnedBlockMemoryPool, nuint>)(typeof(PinnedBlockMemoryPoolFactory)
@@ -53,11 +54,11 @@ public void DisposePoolRemovesFromFactory()
     public async Task FactoryHeartbeatWorks()
     {
         var timeProvider = new FakeTimeProvider(DateTimeOffset.UtcNow.AddDays(1));
-        var factory = new PinnedBlockMemoryPoolFactory(new TestMeterFactory(), timeProvider);
+        var factory = CreateMemoryPoolFactory(timeProvider);
 
         // Use 2 pools to make sure they all get triggered by the heartbeat
-        var pool = Assert.IsType<PinnedBlockMemoryPool>(factory.Create());
-        var pool2 = Assert.IsType<PinnedBlockMemoryPool>(factory.Create());
+        var pool = Assert.IsType<PinnedBlockMemoryPool>(factory.Create(new MemoryPoolOptions()));
+        var pool2 = Assert.IsType<PinnedBlockMemoryPool>(factory.Create(new MemoryPoolOptions()));
 
         var blocks = new List<IMemoryOwner<byte>>();
         for (var i = 0; i < 10000; i++)
@@ -110,4 +111,11 @@ static async Task VerifyPoolEviction(PinnedBlockMemoryPool pool, int previousCou
             Assert.InRange(pool.BlockCount(), previousCount - (previousCount / 10), previousCount - (previousCount / 30));
         }
     }
+
+    private static PinnedBlockMemoryPoolFactory CreateMemoryPoolFactory(TimeProvider timeProvider = null)
+    {
+        return new PinnedBlockMemoryPoolFactory(
+            new MemoryPoolMetrics(new TestMeterFactory()),
+            timeProvider: timeProvider);
+    }
 }