适用于 .NET 的 AWS X-Ray 开发工具包 - AWS X-Ray
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

适用于 .NET 的 AWS X-Ray 开发工具包

X-Ray SDK for .NET是用于在 AWS Lambda 上分析 C# .NET Web 应用程序、.NET Core Web 应用程序和 .NET Core 函数的库。它提供用于生成跟踪数据并将其发送到 X-Ray 守护程序的类及方法。这包括有关由应用程序提供服务的传入请求的信息,以及应用程序对下游 AWS 服务、HTTP Web API 和 SQL 数据库的调用。

注意

X-Ray SDK for .NET 是一个开源项目。您可以跟踪该项目并在 GitHub 上提交问题和提取请求:github.com/aws/aws-xray-sdk-dotnet

对于 Web 应用程序,首先通过添加消息处理程序到 Web 配置来跟踪传入请求。消息处理程序为每个被跟踪的请求创建一个分段并在发送响应时完成该分段。当分段打开时,您可以使用开发工具包客户端的方法将信息添加到分段,并创建子分段以跟踪下游调用。开发工具包还会自动记录在分段打开时应用程序引发的异常。

对于由已分析应用程序或服务调用的 Lambda 函数,Lambda 自动读取跟踪标头并跟踪采样的请求。对于其他函数,您可以配置 Lambda 以采样和跟踪传入请求。无论哪种情况,Lambda 都会创建分段并将其提供给 X-Ray 开发工具包。

注意

在 Lambda 上,X-Ray 开发工具包是可选的。如果您不将它用于您的函数,则您的服务地图仍将为 Lambda 服务包含节点,每个 Lambda 函数各一个。通过添加开发工具包,您可以分析您的函数代码,以将子分段添加到 Lambda 所记录的函数分段。请参阅 AWS Lambda 和 AWS X-Ray 以了解更多信息。

接下来,使用X-Ray SDK for .NET分析您的 适用于 .NET 的 AWS 开发工具包 客户端。当您使用分析过的客户端调用下游 AWS 服务或资源时,开发工具包会在子分段中记录有关调用的信息。您访问的 AWS 服务及其资源将在服务地图中显示为下游节点,帮助您标识单个连接上的错误和限制问题。

X-Ray SDK for .NET还为对 HTTP Web APISQL 数据库的下游调用提供分析。System.Net.HttpWebRequestGetResponseTraced 扩展方法跟踪传出 HTTP 调用。您可以使用 SqlCommand 的X-Ray SDK for .NET版本来分析 SQL 查询。

一旦您开始使用该开发工具包,则应通过配置记录器和消息处理程序来自定义其行为。您可以添加插件来记录有关应用程序上运行的计算资源的数据,通过定义采样规则来自定义采样行为,设置日志级别以在应用程序日志中查看来自开发工具包的更多或更少的信息。

记录有关请求以及应用程序在注释和元数据中所做的工作的其他信息。注释是简单的键值对,已为这些键值对编制索引以用于筛选条件表达式,以便您能够搜索包含特定数据的跟踪。元数据条目的限制性较低,并且可以记录整个对象和数组 — 可序列化为 JSON 的任何项目。

注释和元数据

注释和元数据是您用 X-Ray 开发工具包添加到分段中的任意文本。会对注释编制索引,用于与筛选表达式一同使用。不会对元数据编制索引,但是可以在原始分段中通过 X-Ray 控制台或 API 查看。您授予对 X-Ray 读取权限的人都可以查看此数据。

当代码中具有大量分析的客户端时,一个请求分段可包含大量子分段,分析的客户端发起的每个调用均对应一个子分段。您可以通过将客户端调用包含在自定义子分段中来整理子分段并为其分组。您可以为整个函数或任何代码部分创建自定义子分段,并记录子分段的元数据和注释,而不是编写父分段的所有内容。

有关开发工具包的类和方法的参考文档,请参阅以下内容:

同一个程序包同时支持 .NET 和 .NET Core,但使用的类不同。本章中的示例与 .NET API 参考相关,除非该类特定于 .NET Core。

要求

X-Ray SDK for .NET需要 .NET Framework 4.5 或更高版本以及 适用于 .NET 的 AWS 开发工具包。

对于 .NET Core 应用程序和函数,开发工具包需要 .NET Core 2.0 或更高版本。

添加 X-Ray SDK for .NET 到应用程序

使用 NuGet 添加 X-Ray SDK for .NET 到您的应用程序。

在 Visual Studio 中安装 X-Ray SDK for .NET 和 NuGet Package Manager

  1. 选择工具NuGet 包管理器管理解决方案的 NuGet 包

  2. 搜索 AWSXRayRecorder

  3. 依次选择此程序包和 Install