Node.js 用の AWS Lambda ネイティブ・トレース

Node.js 向けの Instana （ AutoTrace ）の設定により、 Instana のLambdaレイヤーとカスタム関数ハンドラーを使用して、 AWS Lambda の関数をトレースできるようになります。

この方法では、Lambda 関数コードを変更する必要はなく、構成だけを使用して行います。 この方法は、自動化するのにも、Lambda デプロイメント・パイプラインに組み込むのにも適しています。

Node.js Lambda 関数のトレースを有効にするには、以下のステップを実行します。

1. Instana Lambda レイヤーを関数に追加します。
   1. ラムダ関数の構成ページで、 Layers ボックスをクリックし、次に Add a layerをクリックします。

      

   2. 表示されるポップアップで、「レイヤーバージョンのARNを指定」を選択し、ご利用のリージョンに対応する「 Instana 」LambdaレイヤーのARNをコピーして貼り付けてください。「 Instana 」Lambdaレイヤーの正しいARNは、「 Instana 」の「Lambdaレイヤー」セクションで確認できます。

      

2. Lambda ハンドラーを構成します。

   CommonJS を使用する場合は、ハンドラー instana-aws-lambda-auto-wrap.handler を に設定してください。

   ESモジュール（ ES6 ） を使用する場合は、ハンドラー instana-aws-lambda-auto-wrap-esm.handler を に設定してください（レイヤーバージョン223以降で利用可能）。

   ラムダハンドラーの設定を変更するには、構成ページで「基本設定」セクションを見つけます。

   

   「編集」をクリックし、「ハンドラー」というラベルのフィールドに 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. ラムダ関数定義を保存します。

   

前述の手順はすべて、 AWS のWebコンソール、または次のような一般的な AWS 管理ツールのいずれかを使用して実行できます

• aws コマンド行インターフェース
• サーバーレス・フレームワーク CLI
• AWS Cloud Development Kit

以下に、AWS Lambdas の Instana 統合を自動化する場合に開始点として役立つ、aws CLI コマンドの例を示します。

# 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 .

Instana のトレース機能をServerless Frameworkに統合 serverless.yml するために、を編集します。 以下の手順に従います。

1. リストから 「層 ARN」 をコピーし、ターゲット関数定義の 層セクション に ARN を追加します。
2. 環境変数 INSTANA_AGENT_KEY、 INSTANA_ENDPOINT_URL 、および LAMBDA_HANDLERを追加します。 詳細については、 Instana AutoTrace 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