AWS XRay配置ASP.NET WebAPI：自定义CloudWatch事务搜索操作名

问题背景 #

你在ASP.NET WebAPI中通过AWS XRay SDK集成CloudWatch Application Signals后，所有带版本号的API请求（如https://api.mycompany.com/1.0/Products/1234）被自动归类到名为"1.0"的操作组，无法按资源路径（如Products、Customers）区分操作；同时对CloudWatch中操作名的生成逻辑存在疑问。

解决方案：自定义XRay Trace命名策略 #

传统ASP.NET的XRay自动Instrumentation默认使用请求路径的第一分段作为操作名，你可以通过实现ITraceNamingStrategy接口自定义命名规则，按控制器/动作或资源路径生成有逻辑的操作名。

1. 实现自定义命名策略类 #

创建类继承ITraceNamingStrategy，根据WebAPI的路由信息或URL路径生成操作名：

using Amazon.XRay.Recorder.Core.Strategies;
using System.Web;

public class CustomApiTraceNamingStrategy : ITraceNamingStrategy
{
    public string GetName(HttpRequest request)
    {
        if (request == null)
            return "UnknownRequest";

        var httpMethod = request.HttpMethod;
        var routeData = HttpContext.Current.RouteData;

        // 优先从路由数据获取控制器和动作名（最精准）
        var controller = routeData.Values["controller"]?.ToString();
        var action = routeData.Values["action"]?.ToString();
        if (!string.IsNullOrEmpty(controller) && !string.IsNullOrEmpty(action))
        {
            return $"{httpMethod} {controller}/{action}";
        }

        // fallback：从URL路径提取资源段（跳过版本号）
        var pathSegments = request.Path.Trim('/').Split('/');
        if (pathSegments.Length >= 2)
        {
            var resource = pathSegments[1];
            return $"{httpMethod} {resource}";
        }

        // 最终 fallback：使用完整请求路径
        return $"{httpMethod} {request.Path}";
    }
}

2. 注册XRay时指定自定义策略 #

修改WebApiApplication的Init方法，注册XRay时传入自定义策略：

public class WebApiApplication : System.Web.HttpApplication
{
    public override void Init()
    {
        base.Init();
        var customNamingStrategy = new CustomApiTraceNamingStrategy();
        AWSXRayASPNET.RegisterXRay(this, "MyAPI", customNamingStrategy); 
    }
}

操作名生成逻辑说明 #

1. XRay SDK侧：传统ASP.NET的默认命名策略仅提取URL路径的第一分段作为Span的name字段，这就是所有请求被归类到"1.0"的原因；而ASP.NET Core的XRay Instrumentation会自动结合路由信息生成更详细的操作名（如GET /WeatherForecast）。
2. CloudWatch侧：CloudWatch Application Signals会将XRay Span的name字段作为操作名的核心来源，aws.local.operation字段是CloudWatch基于Span数据衍生的字段，无需手动修改，只要控制XRay发送的Spanname即可。

验证与注意事项 #

• 部署后发送测试请求，查看CloudWatch Application Signals的操作列表，确认是否按预期分组。
• 若使用[Route]属性定义路由，确保RouteData能正确解析控制器和动作信息（需确保WebAPI路由配置正确）。
• 可开启XRay调试日志（在配置文件中设置XRay日志级别为Debug），验证Span的name字段是否符合自定义规则。

内容的提问来源于stack exchange，提问作者Tom