Caching Redis: Add option to register profiling session (#31018)

* Add option to register profiling session * Add API change * Fix public API declaration * Cleanup
dotnet · Mar 20, 2021 · 30f376d · 30f376d
1 parent ef0c2fc
commit 30f376d
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 1 deletion.
diff --git a/src/Caching/StackExchangeRedis/src/PublicAPI.Unshipped.txt b/src/Caching/StackExchangeRedis/src/PublicAPI.Unshipped.txt
@@ -1 +1,3 @@
 #nullable enable
+~Microsoft.Extensions.Caching.StackExchangeRedis.RedisCacheOptions.ProfilingSession.get -> System.Func<StackExchange.Redis.Profiling.ProfilingSession>
+~Microsoft.Extensions.Caching.StackExchangeRedis.RedisCacheOptions.ProfilingSession.set -> void
diff --git a/src/Caching/StackExchangeRedis/src/RedisCache.cs b/src/Caching/StackExchangeRedis/src/RedisCache.cs
@@ -199,6 +199,8 @@ private void Connect()
                     {
                         _connection = ConnectionMultiplexer.Connect(_options.Configuration);
                     }
+
+                    TryRegisterProfiler();
                     _cache = _connection.GetDatabase();
                 }
             }
@@ -232,6 +234,7 @@ private void Connect()
                         _connection = await ConnectionMultiplexer.ConnectAsync(_options.Configuration).ConfigureAwait(false);
                     }
 
+                    TryRegisterProfiler();
                     _cache = _connection.GetDatabase();
                 }
             }
@@ -241,6 +244,14 @@ private void Connect()
             }
         }
 
+        private void TryRegisterProfiler()
+        {
+            if (_connection != null && _options.ProfilingSession != null)
+            {
+                _connection.RegisterProfiler(_options.ProfilingSession);
+            }
+        }
+
         private byte[] GetAndRefresh(string key, bool getData)
         {
             if (key == null)

diff --git a/src/Caching/StackExchangeRedis/src/RedisCacheOptions.cs b/src/Caching/StackExchangeRedis/src/RedisCacheOptions.cs
@@ -2,8 +2,10 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
+using System;
 using Microsoft.Extensions.Options;
 using StackExchange.Redis;
+using StackExchange.Redis.Profiling;
 
 namespace Microsoft.Extensions.Caching.StackExchangeRedis
 {
@@ -28,9 +30,14 @@ public class RedisCacheOptions : IOptions<RedisCacheOptions>
         /// </summary>
         public string InstanceName { get; set; }
 
+        /// <summary>
+        /// The Redis profiling session
+        /// </summary>
+        public Func<ProfilingSession> ProfilingSession { get; set; }
+
         RedisCacheOptions IOptions<RedisCacheOptions>.Value
         {
             get { return this; }
         }
     }
-}
+}