ASP.NET Web API 接口执行时间监控

最新推荐文章于 2024-07-23 21:21:14 发布

转载最新推荐文章于 2024-07-23 21:21:14 发布 · 256 阅读

本文介绍了一种利用ASP.NET WebAPI筛选器监控接口执行时间的方法。通过自定义的TimingActionFilter类，可以记录每个服务接口的调用时间、延迟及故障率等信息，为项目运营团队提供重要的性能分析数据。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

软件产品常常会出现这样的情况：产品性能因某些无法预料的瓶颈而受到干扰，导致程序的处理效率降低，性能得不到充分的发挥。如何快速有效地找到软件产品的性能瓶颈，则是我们感兴趣的内容之一。

在本文中，我将解释我如何清理和替换重复、混乱遍布许多方法在应用程序中的代码使用ASP.NET Web API 的筛选器来完成ASP.NET Web API 接口执行时间监控。我们的项目中有如下的需求：我的工作相关的项目（使用 ASP.NET Web API 框架）要求记录下服务接口的调用执行时间以及请求延迟、故障率每秒的请求总数，以帮助运营团队。

Web API 筛选器是你放到Action上的自定义属性方法（或Controller）添加常用功能。 Web API 筛选使您得以添加预处理和后处理的行为,本文的代码来自于How to intercept all the ASP.NET WebApi controller action methods calls with Ninject interception for logging? 和 Log duration of an ASP Web API action 。

下面是详细代码：

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Web;
using System.Web.Http.Controllers;
using System.Web.Http.Filters;

namespace ContactManager.Filters
{
    public class TimingActionFilter : ActionFilterAttribute
    {
        private const string Key = "__action_duration__";

        public override void OnActionExecuting(HttpActionContext actionContext)
        {
            if (SkipLogging(actionContext))
            {
                return;
            }
            var stopWatch = new Stopwatch();
            actionContext.Request.Properties[Key] = stopWatch;
            stopWatch.Start();
        }

        public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
        {
            if (!actionExecutedContext.Request.Properties.ContainsKey(Key))
            {
                return;
            }

}

        private static bool SkipLogging(HttpActionContext actionContext)
        {
            return actionContext.ActionDescriptor.GetCustomAttributes<NoLogAttribute>().Any() ||
                    actionContext.ControllerContext.ControllerDescriptor.GetCustomAttributes<NoLogAttribute>().Any();
        }

}

    [AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, Inherited = true)]
    public class NoLogAttribute : Attribute
    {

}
}

然后在代码里注册 GlobalConfiguration.Configuration.Filters.Add(new TimingActionFilter());