在 AWS Lambda 中检测 Node.js 代码 - AWS Lambda

在 AWS Lambda 中检测 Node.js 代码

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

要将跟踪数据发送到 X-Ray,您可以使用以下两个软件开发工具包 (SDK) 库之一:

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

重要

ADOT 是分析 Lambda 函数的首选方法。我们建议将 ADOT 用于所有新应用程序。但是,由于 OpenTeleMetry 提供的灵活性,Lambda 函数调用可能会遇到冷启动延迟增加的情况。如果您正在针对低延迟进行优化并且不需要 OpenTelemetry 的高级功能(例如遥测关联和动态可配置的后端目标),则可能需要使用基于 ADOT 的 AWS X-Ray SDK。

使用 ADOT 分析您的 Node.js 函数

ADOT 提供完全托管式 Lambda ,这些层使用 OTel SDK,将收集遥测数据所需的一切内容打包起来。通过使用此层,您可以在不必修改任何函数代码的情况下,对您的 Lambda 函数进行分析。您还可以将您的层配置为对 OTel 进行自定义初始化。有关更多信息,请参阅 ADOT 文档中的适用于 Lambda 上的 ADOT 收集器的自定义配置

对于 Node.js 运行时,可以添加 适用于 ADOT Javascript 的 AWS 托管 Lambda 层以自动分析您的函数。有关如何添加此层的详细说明,请参阅 ADOT 文档中的 AWS Distro for OpenTelemetry Lambda 对 JavaScript 的支持

使用 X-Ray SDK 分析您的 Node.js 函数

要记录有关您的 Lambda 函数对应用程序中的其他资源进行调用的详细信息,您还可以使用 AWS X-Ray SDK for Node.js。要获取开发工具包,请将 aws-xray-sdk-core 包添加到应用程序的依赖项中。

blank-nodejs/package.json

{ "name": "blank-nodejs", "version": "1.0.0", "private": true, "devDependencies": { "aws-sdk": "2.631.0", "jest": "25.4.0" }, "dependencies": { "aws-xray-sdk-core": "1.1.2" }, "scripts": { "test": "jest" } }

要检测 AWS 开发工具包客户端,请使用 aws-sdk 方法包装 captureAWS 库。

blank-nodejs/function/index.js – 跟踪AWS开发工具包客户端

const AWSXRay = require('aws-xray-sdk-core') const AWS = AWSXRay.captureAWS(require('aws-sdk')) // Create client outside of handler to reuse const lambda = new AWS.Lambda() // Handler exports.handler = async function(event, context) { event.Records.forEach(record => { ...

Lambda 运行时设置一些环境变量来配置 X-Ray 开发工具包。例如,Lambda 将 AWS_XRAY_CONTEXT_MISSING 设置为 LOG_ERROR,以避免从 X-Ray 开发工具包引发运行时错误。要设置自定义上下文缺失策略,请覆盖函数配置中的环境变量以使其没有值,然后可以通过编程方式设置上下文缺失策略。

例 初始化代码示例

const AWSXRay = require('aws-xray-sdk-core'); // Configure the context missing strategy to do nothing AWSXRay.setContextMissingStrategy(() => {});

有关更多信息,请参阅使用 AWS Lambda 环境变量

在添加正确的依赖项并进行必要的代码更改后,请通过 Lambda 控制台或 API 激活函数配置中的跟踪。

使用 Lambda 控制台激活跟踪

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

打开活跃跟踪

  1. 打开 Lamba 控制台的 Functions page(函数页面)。

  2. 选择函数。

  3. 选择 Configuration(配置),然后选择 Monitoring and operations tools(监控和操作工具)。

  4. 选择 Edit(编辑)。

  5. X-Ray 下方,开启 Active tracing(活动跟踪)。

  6. 选择保存

使用 Lambda API 激活跟踪

借助 AWS CLI 或 AWS SDK 在 Lambda 函数上配置跟踪,请使用以下 API 操作:

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

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

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

使用 AWS CloudFormation 激活跟踪

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

function-inline.yml – 跟踪配置

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

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

template.yml – 跟踪配置

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

解释 X-Ray 跟踪

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

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


        一幅显示 X-Ray 中两个独立应用程序及其各自服务地图的图

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

注意

您无法为您的函数配置此 X-Ray 采样率。

使用活动跟踪时,Lambda 会每个跟踪记录 2 个分段,这些分段将在服务图上创建两个节点。下图突出显示了如上错误处理程序示例中的主函数的这两个节点。


      具有单个函数的 X-Ray 服务地图。

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


        一个 X-Ray 跟踪,它将显示特定 Lambda 调用的每个子分段的延迟。

此示例将展开函数分段,以显示其三个子分段。

  • 初始化 – 表示加载函数和运行初始化代码所花费的时间。此子分段仅对由您的函数的每个实例处理的第一个事件显示。

  • 调用 – 表示执行处理程序代码花费的时间。

  • 开销 – 表示 Lambda 运行时为准备处理下一个事件而花费的时间。

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

定价

作为 AWS 免费套餐的组成部分,您可以每月免费使用 X-Ray 跟踪,但不能超过一定限制。超出该阈值后,X-Ray 会对跟踪存储和检索进行收费。有关更多信息,请参阅 AWS X-Ray 定价

在层中存储运行时依赖项 (X-Ray SDK)

如果您使用 X-Ray 开发工具包来分析AWS开发工具包客户端和您的函数代码,则您的部署程序包可能会变得相当大。为了避免每次更新函数代码时上载运行时依赖项,请将 X-Ray SDK 打包到 Lambda 层中。

以下示例显示存储 AWS X-Ray SDK for Node.js 的 AWS::Serverless::LayerVersion 资源。

template.yml – 依赖项层

Resources: function: Type: AWS::Serverless::Function Properties: CodeUri: function/. Tracing: Active Layers: - !Ref libs ... libs: Type: AWS::Serverless::LayerVersion Properties: LayerName: blank-nodejs-lib Description: Dependencies for the blank sample app. ContentUri: lib/. CompatibleRuntimes: - nodejs12.x

使用此配置,仅在更改运行时依赖项时您才会更新库层。由于函数部署软件包仅包含您的代码,因此可以帮助缩短上传时间。

为依赖项创建层需要更改构建才能在部署之前生成层存档。有关工作示例,请参阅 blank-nodejs 示例应用程序。