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

Node.js 用の Instana AutoTrace セットアップでは、 Instana Lambda 層 およびカスタム関数ハンドラーを使用する AWS ラムダ関数をトレースできます。 この方法では、Lambda 関数コードを変更する必要はなく、構成だけを使用して行います。 この方法は、自動化するのにも、Lambda デプロイメント・パイプラインに組み込むのにも適しています。

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

1. Instana Lambda レイヤーを関数に追加します。

   1. Lambda関数の設定ページで、ボックス Layers をクリックし、次にをクリックします Add a layer。
   2. 表示されるポップアップで「レイヤーバージョンのARNを提供」を選択し、ご自身のリージョンに対応する Instana LambdaレイヤーのARNをコピーして貼り付けます。 Instana Lambdaレイヤーの適切なARNは、 Instana Lambda レイヤーセクションで確認できます。

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

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

   

   「編集」をクリックし、「ハンドラー」というラベルのフィールドに instana-aws-lambda-auto-wrap.handler を挿入します。

   

   Instana のLambdaレイヤーは、デフォルトの Node.js ランタイムハンドラーを自動的に index.handlerトリガーします。 カスタムハンドラーを使用する場合は、 Instana Lambda Layer に通知するため、環境変数 LAMBDA_HANDLER でハンドラーを指定してください。 設定が必要なすべての環境変数については、次のセクションを参照してください。

   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です。

   以下の例では、元のメインのラムダハンドラーは であるため index.js、環境変数 LAMBDA_HANDLER を設定する必要はありません。

   以下の例では、元のメインのLambdaハンドラーは であるため server.js、環境変数LAMBDA_HANDLER を に設定する必要があります server.handler。

   これらの環境変数の正しい値は、 Instana のインストール先へ移動し、...をクリックすることで取得することもできます。 詳細 -> エージェント -> Instana エージェントのインストール -> プラットフォーム: AWS -> テクノロジー: AWS Lambda.

4. Lambda関数の定義を保存します。

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

• the aws コマンドラインインターフェース
• サーバーレスフレームワーク CLI
• AWS クラウド開発キット

以下に、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

関数のコードを 「ハンドラを手動でラップする」 セクションに従って修正してください。

チームがコンテナベースのLambdaデプロイを使用している場合、当社のベースコンテナを Docker Hub で icr.io/instana/aws-lambda-nodejs 利用するか、Dockerfile に以下のスニペットを含め、 ビルド時の引数を適切なバージョンに設定できます。

Instana 現在、 x86_64 アーキテクチャのみをサポートしています。

この画像は、 FedRAMP-compliant 環境での使用を意図したものではありません。

# 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:14

# 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" ]
 

icr.io/instana/aws-lambda-nodejs:latestの代わりに、 @instana/aws-lambda 1.137.2 以上の特定のバージョンの Instana npm モジュールを使用することもできます ( ログの変更を参照)。以下に例を示します。

FROM icr.io/instana/aws-lambda-nodejs:1.140.1 as instana-layer
 

あるいは、最新のマイナー/パッチ・リリースを考慮しながら、メジャー・バージョンのみをピン留めすることができます。

FROM icr.io/instana/aws-lambda-nodejs:1 as instana-layer
 

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

1. リストからレイヤーARN をコピーし、対象の関数定義の layersセクションに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
 

サポート対象ランタイムに記載されているLambdaランタイム向けの AWS Lambda レイヤーの最新バージョンのARNは、リージョンごとに以下の通りです：

つまり、そのパターンは (中国における arn:aws:lambda:${region}:410797082306:layer:instana-nodejs:${layer-version}AWS 地域 arn:aws-cn:lambda:${region}:107998019096:layer:instana-nodejs:${layer-version} の場合は) である。

常に最新バージョンを使用し、レイヤーのバージョンを定期的に更新してください。これにより、レイヤーの新バージョン公開時に提供する新機能や修正の恩恵を受けられます。