AWS Lambda Native Tracing for Node.js

针对 Node.js 的 Instana AutoTrace 配置，可让您通过 Instana Lambda 层和自定义函数处理程序来追踪 AWS Lambda 函数。

此方法不需要修改 Lambda 函数代码，完全通过配置完成。 它也适合自动化或包含在 Lambda 部署管道中。

要启用 Node.js Lambda 函数的跟踪，请执行以下步骤：

1. 将 Instana Lambda 层添加到您的函数中。
   1. 在 Lambda 函数的配置页面中，单击Layers框，然后单击Add a layer。

      

   2. 在弹出的窗口中，选择“提供图层版本 ARN”，然后复制并粘贴与您所在区域对应的“ Instana ”Lambda 图层的 ARN；您可以在“ Instana ”Lambda 图层部分中找到“ Instana ”Lambda 图层的正确 ARN。

      

2. 配置 Lambda 处理程序。

   如果使用 instana-aws-lambda-auto-wrap.handlerCommonJS ，请将处理程序设置为。

   如果使用 ES 模块（ ES6instana-aws-lambda-auto-wrap-esm.handler ），请将处理程序设置为 （自 layer 版本 223 起可用）。

   要更改 Lambda 处理程序的设置，请在配置页面上找到“基本设置”部分。

   

   单击“编辑”，并将instana-aws-lambda-auto-wrap.handler插入到标注为“处理程序”的字段中。

   

   Instana 的Lambda层会自动触发默认的 Node.js 运行时处理程序 index.handler。 如果您使用自定义处理程序，请在环境变量 LAMBDA_HANDLER 中指定该处理程序，以通知“ Instana ”Lambda 层。 请参阅下一节以了解需要设置的所有环境变量。

   注意： Lambda 配置页面可能会显示一条警告，例如“Lambda 无法找到文件 instana-aws-lambda-auto-wrap.js ”。稍后返回配置页面时，也可能再次显示此警告。 不要让这个警告分散您的注意力。 处理程序包含在 Instana Lambda 层中，但 AWS Lambda 配置页面未考虑这一点。
3. 配置环境变量。

   添加以下环境变量：

   • INSTANA_ENDPOINT_URL: 此变量是您的无服务器监控端点。 对于以 https://serverless- 开头的区域，请确保使用正确的值。
   • INSTANA_AGENT_KEY：您的 代理程序密钥。
   • LAMBDA_HANDLER: 设置定制处理程序。 如果主文件是 myModule.js(导出函数 myHandler) ，请将环境变量设置为 myModule.myHandler。 缺省值为 index.handler。

   在下面的示例中，原始的主 Lambda 处理程序是 index.js，因此您无需设置环境变量 LAMBDA_HANDLER。

   

   在下面的示例中，原始的主 Lambda 处理程序是 server.js，因此您需要将环境变量 LAMBDA_HANDLER 设置为 server.handler。

   

   您还可以通过访问 Instana 的安装目录，点击……来获取这些环境变量的正确值。 更多 -> 代理 -> 安装 Instana 代理 -> 平台： AWS -> 技术： AWS Lambda。

4. 保存 Lambda 函数定义。

   

前面概述的所有步骤均可通过 AWS 网页控制台或任何常用的 AWS 管理工具完成，例如：

• aws 命令行界面
• 无服务器框架 cli
• AWS 云开发包

以下是一个示例 aws CLI 命令，如果想要自动执行 AWS Lambda 表达式的 Instana 集成，那么该命令可能用作起始点：

# Do not copy and paste this verbatim!
# It will overwrite any previously defined collection of layers and
# environment variables.
aws --region $YOUR_REGION lambda update-function-configuration \
  --function-name $YOUR_LAMBDA_FUNCTION_NAME \
  --layers $INSTANA_LAYER_ARN \
  --handler instana-aws-lambda-auto-wrap.handler \
  --environment "Variables={INSTANA_ENDPOINT_URL=... , INSTANA_AGENT_KEY=... , ...}"

要手动安装 Instana Node.js 收集器，请运行以下命令：

npm install --save @instana/aws-lambda@latest

请根据 “手动包装处理程序 ”一节的内容修改该函数的代码。

如果您的团队使用基于容器的 Lambda 部署，您可以使用 Instana 上的基础容器 icr.io/instana/aws-lambda-nodejs ，或在 Dockerfile 中包含以下代码片段， 并将构建时参数设置为相应的版本。

Instana 目前仅支持该 x86_64 架构。

# This is the container image that delivers Instana's monitoring capabilities.
# It will not become the base image for your Lambda container image, it just provides a few files.
FROM icr.io/instana/aws-lambda-nodejs:latest as instana-layer

# This is the actual base image for your Lambda container image. You can also use any other base image that is suitable
# for container image based Lambda functions.
FROM public.ecr.aws/lambda/nodejs:22

# Copy Instana's Node.js monitoring components into your Lambda container image.
COPY --from=instana-layer /opt/extensions/ /opt/extensions/
COPY --from=instana-layer /opt/nodejs/ /opt/nodejs/

# The remainder of your Dockerfile, as it was without adding the Instana layer. The following is just an example:
COPY index.js package.json package-lock.json /var/task/
WORKDIR /var/task
RUN npm install

# Override the CMD. This can also be done as a parameter override outside of the Dockerfile, for example in the AWS console.
# If you use ES modules, use CMD [ "instana-aws-lambda-auto-wrap-esm.handler" ] instead.
CMD [ "instana-aws-lambda-auto-wrap.handler" ]

curl -s https://icr.io/v2/instana/aws-lambda-nodejs/tags/list | jq .

编辑 以 serverless.yml 将 Instana 追踪功能与 Serverless Framework 集成。 请执行以下步骤：

1. 从列表中复制 层 ARN ，并将 ARN 添加到目标函数定义的 层部分 。
2. 添加环境变量 INSTANA_AGENT_KEY， INSTANA_ENDPOINT_URL 和 LAMBDA_HANDLER。 如需了解更多信息，请访问 InstanaAutoTrace setup。

请参阅以下示例 serverless.yml:

service: service-a

provider:
  name: aws
  runtime: nodejs16.x
  stage: dev
  region: us-east-2

functions:
  with-layer:
    environment:
      INSTANA_ENDPOINT_URL: INSTANA_ENDPOINT_URL
      INSTANA_AGENT_KEY: INSTANA_AGENT_KEY
      LAMBDA_HANDLER: src/index.handler
    layers:
      - arn:aws:lambda:us-east-2:410797082306:layer:instana-nodejs:111
    handler: instana-aws-lambda-auto-wrap.handler

service: service-b

provider:
  name: aws
  runtime: nodejs12.x
  stage: dev
  region: us-east-2

plugins:
  - serverless-offline

custom:
  serverless-offline:
    useDocker: true

functions:
  with-serverless-offline:
    environment:
      NODE_PATH: $NODE_PATH:/opt/nodejs/node_modules
      INSTANA_ENDPOINT_URL: INSTANA_ENDPOINT_URL
      INSTANA_AGENT_KEY: INSTANA_AGENT_KEY
      LAMBDA_HANDLER: src/index.handler
    layers:
      - arn:aws:lambda:us-east-2:410797082306:layer:instana-nodejs:111
    handler: instana-aws-lambda-auto-wrap.handler

service: service-c

provider:
  name: aws
  runtime: nodejs12.x
  stage: dev
  region: us-east-2

plugins:
  - serverless-webpack

package:
  individually: true

functions:
  with-serverless-webpack:
    environment:
      INSTANA_ENDPOINT_URL: INSTANA_ENDPOINT_URL
      INSTANA_AGENT_KEY: INSTANA_AGENT_KEY
      LAMBDA_HANDLER: src/index.handler
    layers:
      - arn:aws:lambda:us-east-2:410797082306:layer:instana-nodejs:110
    handler: instana-aws-lambda-auto-wrap.handler
    entrypoint: src/index.handler