性能分析

StackExchange.Redis 公开了少量的方法和类型来开启性能分析。由于其异步性和多路复用行为，性能分析是一个有点复杂的话题。

接口

性能分析接口是由这些组成的：IProfiler，ConnectionMultiplexer.RegisterProfiler(IProfiler)，ConnectionMultiplexer.BeginProfiling(object)， ConnectionMultiplexer.FinishProfiling(object) 还有 IProfiledCommand。

你可以用 ConnectionMultiplexer 的实例来注册一个 IProfiler 接口，注册后它不能被更改。通过调用 BeginProfiling(object) 方法开始分析一个给定的上下文(例如：Thread，HttpRequest等等)，然后调用 FinishProfiling(object) 方法完成分析；FinishProfiling(object) 方法返回一个 IProfiledCommand 的集合，该集合包含计时信息的所有命令都被发送到Redis；使用给定的上下文参数，通过已配置的 ConnectionMultiplexer 对像来调用 (Begin|Finish)Profiling (也就是BeginProfiling & FinishProfiling) 方法。

在具体的应用中什么样的 “上下文” 对象应该使用。

Available Timings

StackExchange.Redis公共的信息有：

  • 涉及的Redis服务器
  • 对Redis数据库的查询
  • 运行的Redis命令
  • 路由命令的使用标志
  • 命令的初始化创建时间
  • 用了多长时间来排队命令
  • 在排队之后，用了多长时间来发送命令
  • 在命令被发送后，用了多长时间接受来自Redis的响应
  • 在接受响应后，用了多长时间来处理响应
  • 如果命令被发送以回应一个集群 ASK 或 MOVED 的响应
    • 如果这样，那么原始的命令的 TimeSpan 是高精确度的， 如果运行时支持。DateTime 和 DateTime.UtcNow 精确度是一样的。

选择上下文

由于StackExchange.Redis的异步接口，分析需要外部协助来组织相关的命令。开始分析和结束分析都是通过给定的上下文对象来实现的(通过 BeginProfiling(object) & FinishProfiling(object) 方法实现)，通过 IProfiler 接口的 GetContext 方法取得上下文对象。

下面是一个从很多不同的线程发出相关命令的示例：

  1. class ToyProfiler : IProfiler
  2. {
  3.     public ConcurrentDictionary<Thread, object> Contexts = new ConcurrentDictionary<Thread, object>();
  5.     public object GetContext()
  6.     {
  7.         object ctx;
  8.         if(!Contexts.TryGetValue(Thread.CurrentThread, out ctx)) ctx = null;
  10.         return ctx;
  11.     }
  12. }
  14. // ...
  16. ConnectionMultiplexer conn = /* initialization */;
  17. var profiler = new ToyProfiler();
  18. var thisGroupContext = new object();
  20. //注册实现了IProfiler接口的对象
  21. conn.RegisterProfiler(profiler);
  23. var threads = new List<Thread>();
  25. for (var i = 0; i < 16; i++)
  26. {
  27.     var db = conn.GetDatabase(i);
  29.     var thread =
  30.         new Thread(
  31.             delegate()
  32.             {
  33.                 var threadTasks = new List<Task>();
  35.                 for (var j = 0; j < 1000; j++)
  36.                 {
  37.                     var task = db.StringSetAsync("" + j, "" + j);
  38.                     threadTasks.Add(task);
  39.                 }
  41.                 Task.WaitAll(threadTasks.ToArray());
  42.             }
  43.         );
  45.     profiler.Contexts[thread] = thisGroupContext;
  47.     threads.Add(thread);
  48. }
  50. //分析开始
  51. conn.BeginProfiling(thisGroupContext);
  53. threads.ForEach(thread => thread.Start());
  54. threads.ForEach(thread => thread.Join());
  56. //分析结束，并且返回了含定时信息的所有命令集合
  57. IEnumerable<IProfiledCommand> timings = conn.FinishProfiling(thisGroupContext);

在结束后，timings 包含了16,000个 IProfiledCommand 对象：每一个命令都会被发送到Redis。

替代方案，你可以按照如下做：

  1. ConnectionMultiplexer conn = /* initialization */;
  2. var profiler = new ToyProfiler();
  4. conn.RegisterProfiler(profiler);
  6. var threads = new List<Thread>();
  8. var perThreadTimings = new ConcurrentDictionary<Thread, List<IProfiledCommand>>();
  10. for (var i = 0; i < 16; i++)
  11. {
  12.     var db = conn.GetDatabase(i);
  14.     var thread =
  15.         new Thread(
  16.             delegate()
  17.             {
  18.                 var threadTasks = new List<Task>();
  20.                 conn.BeginProfiling(Thread.CurrentThread);
  22.                 for (var j = 0; j < 1000; j++)
  23.                 {
  24.                     var task = db.StringSetAsync("" + j, "" + j);
  25.                     threadTasks.Add(task);
  26.                 }
  28.                 Task.WaitAll(threadTasks.ToArray());
  30.                 perThreadTimings[Thread.CurrentThread] = conn.FinishProfiling(Thread.CurrentThread).ToList();
  31.             }
  32.         );
  34.     profiler.Contexts[thread] = thread;
  36.     threads.Add(thread);
  37. }
  39. threads.ForEach(thread => thread.Start());
  40. threads.ForEach(thread => thread.Join());

perThreadTimings 最终会包含16项1,000个 IProfilingCommand 记录，以线程作为键来获取perThreadTimings集合中的值来发送它们。

让我们忘记玩具示例，这里展示的是一个在MVC5应用中配置StackExchange.Redis的示例：

首先注册 IProfiler 接口，而不是 ConnectionMultiplexer ：

  1. public class RedisProfiler : IProfiler
  2. {
  3.     const string RequestContextKey = "RequestProfilingContext";
  5.     public object GetContext()
  6.     {
  7.         var ctx = HttpContext.Current;
  8.         if (ctx == null) return null;
  10.         return ctx.Items[RequestContextKey];
  11.     }
  13.     public object CreateContextForCurrentRequest()
  14.     {
  15.         var ctx = HttpContext.Current;
  16.         if (ctx == null) return null;
  18.         object ret;
  19.         ctx.Items[RequestContextKey] = ret = new object();
  21.         return ret;
  22.     }
  23. }

那么，添加下面的代码到你的Global.asax.cs文件中：

  1. protected void Application_BeginRequest()
  2. {
  3.     var ctxObj = RedisProfiler.CreateContextForCurrentRequest();
  4.     if (ctxObj != null)
  5.     {
  6.         RedisConnection.BeginProfiling(ctxObj);
  7.     }
  8. }
  10. protected void Application_EndRequest()
  11. {
  12.     var ctxObj = RedisProfiler.GetContext();
  13.     if (ctxObj != null)
  14.     {
  15.         var timings = RedisConnection.FinishProfiling(ctxObj);
  17.         // 在这里你可以使用`timings`做你想做的
  18.     }
  19. }

这些实现会组织所有的Redis命令，包括 async/await 并随着http请求初始化它们。