在 Amazon Lambda 中检测 C# 代码

Lambda 与 Amazon X-Ray 集成，以帮助您跟踪、调试和优化 Lambda 应用程序。您可以在某个请求遍历应用程序中的资源（其中可能包括 Lambda 函数和其他 Amazon 服务）时，使用 X-Ray 跟踪该请求。

要将跟踪数据发送到 X-Ray，您可以使用以下三个开发工具包库之一：

每个开发工具包均提供了将遥测数据发送到 X-Ray 服务的方法。然后，您可以使用 X-Ray 查看、筛选和获得对应用程序性能指标的洞察，从而发现问题和优化机会。

将 Powertools for Amazon Lambda（.NET）和 Amazon SAM 用于跟踪

请按照以下步骤使用 Amazon SAM，通过集成的 Powertools for Amazon Lambda（.NET）模块来下载、构建和部署示例 Hello World C# 应用程序。此应用程序实现了基本的 API 后端，并使用 Powertools 发送日志、指标和跟踪。它由 Amazon API Gateway 端点和 Lambda 函数组成。在向 API Gateway 端点发送 GET 请求时，Lambda 函数会使用嵌入式指标格式向 CloudWatch 调用、发送日志和指标，并向 Amazon X-Ray 发送跟踪。该函数将返回一条 hello world 消息。

X-Ray 无法跟踪对应用程序的所有请求。X-Ray 将应用采样算法确保跟踪有效，同时仍会提供所有请求的一个代表性样本。采样率是每秒 1 个请求和 5% 的其他请求。您无法为函数配置此 X-Ray 采样率。

使用 X-Ray SDK 分析 .NET 函数

您可以使用函数代码来记录元数据并跟踪下游调用。要记录有关您的函数对其他资源和服务进行调用的详细信息，请使用 Amazon X-Ray SDK for .NET。要获取开发工具包，请将 AWSXRayRecorder 程序包添加到您的项目文件中。

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>net8.0</TargetFramework>
    <GenerateRuntimeConfigurationFiles>true</GenerateRuntimeConfigurationFiles>
    <AWSProjectType>Lambda</AWSProjectType>
  </PropertyGroup>
  <ItemGroup>
    <PackageReference Include="Amazon.Lambda.Core" Version="2.1.0" />
    <PackageReference Include="Amazon.Lambda.SQSEvents" Version="2.1.0" />
    <PackageReference Include="Amazon.Lambda.Serialization.Json" Version="2.1.0" />
    <PackageReference Include="AWSSDK.Core" Version="3.7.103.24" />
    <PackageReference Include="AWSSDK.Lambda" Version="3.7.104.3" />
    <PackageReference Include="AWSXRayRecorder.Core" Version="2.13.0" />
    <PackageReference Include="AWSXRayRecorder.Handlers.AwsSdk" Version="2.11.0" />
  </ItemGroup>
</Project>

有一系列 Nuget 软件包可以为 Amazon SDK、实体框架和 HTTP 请求提供自动分析。要查看完整的配置选项集，请参阅《Amazon X-Ray 开发人员指南》中的适用于 .NET 的 Amazon X-Ray SDK。

添加所需的 Nuget 软件包后，请配置自动分析。最佳实践是在函数的处理函数之外执行此配置。这样一来，您可以利用执行环境重用来提高函数性能。在以下代码示例中，在函数构造函数中调用 RegisterXRayForAllServices 方法，为所有 Amazon SDK 调用添加分析。

[assembly: LambdaSerializer(typeof(Amazon.Lambda.Serialization.SystemTextJson.DefaultLambdaJsonSerializer))]

namespace GetProductHandler;

public class Function
{
    private readonly IDatabaseRepository _repo;
    
    public Function()
    {
        // Add auto instrumentation for all AWS SDK calls
        // It is important to call this method before initializing any SDK clients
        AWSSDKHandler.RegisterXRayForAllServices();
        this._repo = new DatabaseRepository();
    }
    
    public async Task<APIGatewayProxyResponse> FunctionHandler(APIGatewayProxyRequest request)
    {
        var id = request.PathParameters["id"];
        
        var databaseRecord = await this._repo.GetById(id);
        
        return new APIGatewayProxyResponse 
        {
            StatusCode = (int)HttpStatusCode.OK,
            Body = JsonSerializer.Serialize(databaseRecord)
        };
    }
}

使用 Lambda 控制台激活跟踪

要使用控制台切换 Lambda 函数的活动跟踪，请按照以下步骤操作：

使用 Lambda API 激活跟踪

借助 Amazon CLI 或 Amazon SDK 在 Lambda 函数上配置跟踪，请使用以下 API 操作：

以下示例 Amazon CLI 命令对名为 my-function 的函数启用活跃跟踪。

aws lambda update-function-configuration --function-name my-function \
--tracing-config Mode=Active

跟踪模式是发布函数版本时版本特定配置的一部分。您无法更改已发布版本上的跟踪模式。

使用 Amazon CloudFormation 激活跟踪

要对 Amazon CloudFormation 模板中的 AWS::Lambda::Function 资源激活跟踪，请使用 TracingConfig 属性。

Resources:
  function:
    Type: AWS::Lambda::Function
    Properties:
      TracingConfig:
        Mode: Active
      ...

对于 Amazon Serverless Application Model (Amazon SAM) AWS::Serverless::Function 资源，请使用 Tracing 属性。

Resources:
  function:
    Type: AWS::Serverless::Function
    Properties:
      Tracing: Active
      ...

解释 X-Ray 跟踪

您的函数需要权限才能将跟踪数据上载到 X-Ray。在 Lambda 控制台中激活跟踪后，Lambda 会将所需权限添加到函数的执行角色。如果没有，请将 AWSXRayDaemonWriteAccess 策略添加到执行角色。

在配置活跃跟踪后，您可以通过应用程序观察特定请求。X-Ray 服务图将显示有关应用程序及其所有组件的信息。以下示例显示了具有两个函数的应用程序。主函数处理事件，有时会返回错误。位于顶部的第二个函数将处理第一个函数的日志组中显示的错误，并使用 Amazon SDK 调用 X-Ray、Amazon Simple Storage Service (Amazon S3) 和 Amazon CloudWatch Logs。

X-Ray 无法跟踪对应用程序的所有请求。X-Ray 将应用采样算法确保跟踪有效，同时仍会提供所有请求的一个代表性样本。采样率是每秒 1 个请求和 5% 的其他请求。您无法为函数配置此 X-Ray 采样率。

在 X-Ray 中，跟踪记录有关由一个或多个服务处理的请求的信息。Lambda 会每个跟踪记录 2 个分段，这些分段将在服务图上创建两个节点。下图突出显示了这两个节点：

位于左侧的第一个节点表示接收调用请求的 Lambda 服务。第二个节点表示特定的 Lambda 函数。以下示例显示了一个包含这 2 个分段的跟踪。两者都命名为 my-function，但其中一个函数具有 AWS::Lambda 源，另一个则具有 AWS::Lambda::Function 源。如果 AWS::Lambda 分段显示错误，则表示 Lambda 服务存在问题。如果 AWS::Lambda::Function 分段显示错误，则说明函数存在问题。

此示例将展开 AWS::Lambda::Function 分段，以显示其三个子分段。

旧样式函数分段包含以下子分段：

新样式函数分段不包含 Invocation 子分段。而是将客户子分段直接附加到函数分段。有关新旧样式函数分段结构的更多信息，请参阅 了解 X-Ray 跟踪。

您还可以分析 HTTP 客户端、记录 SQL 查询以及使用注释和元数据创建自定义子段。有关更多信息，请参阅 Amazon X-Ray 开发人员指南中的 Amazon X-Ray SDK for .NET。