Ruby サーバーレスアプリケーションのインスツルメンテーション

Datadog CLI は、既存の Lambda 関数のコンフィギュレーションを修正し、新しいデプロイを必要とせずにインスツルメンテーションを可能にします。Datadog のサーバーレスモニタリングをすばやく開始するための最適な方法です。

1. Lambda 関数を構成する

   Datadog APM を有効にし、Datadog Lambda ライブラリが提供するラッパーを使用して Lambda ハンドラー関数をラップします。

   require 'datadog/lambda'
   
   Datadog::Lambda.configure_apm do |c|
   # Enable the instrumentation
   end
   
   def handler(event:, context:)
       Datadog::Lambda.wrap(event, context) do
           return { statusCode: 200, body: 'Hello World' }
       end
   end
   

2. Datadog CLI クライアントをインストールする

   npm install -g @datadog/datadog-ci
   

3. Datadog サーバーレスモニタリングに慣れていない場合は、クイックスタートとして最初のインストールを導くためにインタラクティブモードで Datadog CLI を起動し、残りのステップを無視することができます。本番アプリケーションに Datadog を恒久的にインストールするには、このステップをスキップし、残りのステップに従って通常のデプロイの_後に_ CI/CD パイプラインで Datadog CLI コマンドを実行します。

   datadog-ci lambda instrument -i
   

4. AWS の認証情報を構成する

   Datadog CLI は、AWS Lambda サービスへのアクセスを必要とし、AWS JavaScript SDK に依存して資格情報を解決します。AWS CLI を呼び出すときに使用するのと同じ方法を使用して、AWS の資格情報が構成されていることを確認します。

5. Datadog サイトを構成する

   export DATADOG_SITE="<DATADOG_SITE>"
   

   <DATADOG_SITE> を に置き換えます。(右側で正しい SITE が選択されていることを確認してください)。

6. Datadog API キーを構成する

   Datadog は、セキュリティと簡単なローテーションのために、AWS Secrets Manager に Datadog API キーを保存することを推奨します。キーはプレーンテキスト文字列として保存する必要があります (JSON blob ではありません)。Lambda 関数に必要な secretsmanager:GetSecretValue IAM 権限があることを確認します。

   export DATADOG_API_KEY_SECRET_ARN="<DATADOG_API_KEY_SECRET_ARN>"
   

   迅速なテスト目的のために、Datadog API キーをプレーンテキストで設定することも可能です。

   export DATADOG_API_KEY="<DATADOG_API_KEY>"
   

7. Lambda 関数をインスツルメントする

   注: Lambda 関数は、まず開発環境またはステージング環境でインスツルメントしてください。インスツルメンテーションの結果が思わしくない場合は、同じ引数で uninstrument を実行し、変更を元に戻してください。

   Lambda 関数をインスツルメントするには、次のコマンドを実行します。

   datadog-ci lambda instrument -f <functionname> -f <another_functionname> -r <aws_region> -v 20 -e 48
   

   プレースホルダーを埋めるには

   • <functionname> と <another_functionname> は Lambda 関数の名前に置き換えます。また、--functions-regex を使用すると、指定した正規表現にマッチする名前を持つ複数の関数を自動的にインスツルメントすることができます。
   • <aws_region> を AWS リージョン名に置き換えます。

   その他のパラメーターは、CLI ドキュメントに記載されています。

Datadog Serverless Plugin は、Datadog Lambda 拡張機能 を介してメトリクス、トレース、ログを Datadog に送信するように関数を自動的に構成します。

Datadog サーバーレスプラグインをインストールして構成するには、次の手順に従います。

1. Lambda 関数を構成する

   Datadog APM を有効にし、Datadog Lambda ライブラリが提供するラッパーを使用して Lambda ハンドラー関数をラップします。

   require 'datadog/lambda'
   
   Datadog::Lambda.configure_apm do |c|
   # Enable the instrumentation
   end
   
   def handler(event:, context:)
       Datadog::Lambda.wrap(event, context) do
           return { statusCode: 200, body: 'Hello World' }
       end
   end
   

2. Datadog サーバーレスプラグインをインストールします。

   serverless plugin install --name serverless-plugin-datadog
   

3. serverless.yml を更新します:

   custom:
     datadog:
       site: <DATADOG_SITE>
       apiKeySecretArn: <DATADOG_API_KEY_SECRET_ARN>
   

   プレースホルダーを埋めるには

   • <DATADOG_SITE> を に置き換えます。(右側で正しい SITE が選択されていることを確認してください)。
   • <DATADOG_API_KEY_SECRET_ARN> を、Datadog API キーが安全に保存されている AWS シークレットの ARN に置き換えます。キーはプレーンテキスト文字列として保存する必要があります (JSON blob ではありません)。また、secretsmanager:GetSecretValue権限が必要です。迅速なテストのために、代わりに apiKey を使用して、Datadog API キーをプレーンテキストで設定することができます。

   詳細および追加設定については、プラグインドキュメントを参照してください。

1. Datadog Lambda ライブラリのインストール

   Lambda 関数をコンテナイメージとしてデプロイする場合は、Datadog Lambda ライブラリを Lambda レイヤーとして使用できません。代わりに、イメージ内に Datadog Lambda とトレーシングライブラリをパッケージ化する必要があります。

   Gemfile に下記を追加します。

   gem 'datadog-lambda'
   gem 'ddtrace'
   

   ddtrace は、Amazon Linux が AWS Lambda で動作するためにコンパイルする必要があるネイティブ拡張機能を含んでいます。

   お使いの関数の Dockerfile で bundle install を実行する前に、gcc、gmp-devel、make をインストールし、ネイティブ拡張機能を正常にコンパイルします。

   FROM <base image>
   
   # assemble your container image
   
   RUN yum -y install gcc gmp-devel make
   RUN bundle config set path 'vendor/bundle'
   RUN bundle install
   

2. Datadog Lambda 拡張機能のインストール

   Dockerfile に以下を追加して、Datadog Lambda 拡張機能をコンテナイメージに追加します。

   COPY --from=public.ecr.aws/datadog/lambda-extension:<TAG> /opt/extensions/ /opt/extensions
   

   <TAG> を特定のバージョン番号 (たとえば 48) または latest に置き換えます。利用可能なタグのリストは、Amazon ECR リポジトリで確認できます。

3. Lambda 関数を構成する

   Datadog APM を有効にし、Datadog Lambda ライブラリが提供するラッパーを使用して Lambda ハンドラー関数をラップします。

   require 'datadog/lambda'
   
   Datadog::Lambda.configure_apm do |c|
   # Enable the instrumentation
   end
   
   def handler(event:, context:)
       Datadog::Lambda.wrap(event, context) do
           return { statusCode: 200, body: 'Hello World' }
       end
   end
   

4. Datadog サイトと API キーの構成

   • 環境変数 DD_SITE に を設定します。(右側で正しい SITE が選択されていることを確認してください)。
   • 環境変数 DD_API_KEY_SECRET_ARN を、Datadog API キーが安全に保存されている AWS シークレットの ARN で設定します。キーはプレーンテキスト文字列として保存する必要があります (JSON blob ではありません)。また、secretsmanager:GetSecretValue権限が必要です。迅速なテストのために、代わりに DD_API_KEY を使用して、Datadog API キーをプレーンテキストで設定することができます。

3. Lambda 関数を構成する

   Datadog APM を有効にし、Datadog Lambda ライブラリが提供するラッパーを使用して Lambda ハンドラー関数をラップします。

   require 'datadog/lambda'
   
   Datadog::Lambda.configure_apm do |c|
   # Enable the instrumentation
   end
   
   def handler(event:, context:)
       Datadog::Lambda.wrap(event, context) do
           return { statusCode: 200, body: 'Hello World' }
       end
   end
   

4. Datadog サイトと API キーの構成

   • 環境変数 DD_SITE に を設定します。(右側で正しい SITE が選択されていることを確認してください)。
   • 環境変数 DD_API_KEY_SECRET_ARN を、Datadog API キーが安全に保存されている AWS シークレットの ARN で設定します。キーはプレーンテキスト文字列として保存する必要があります (JSON blob ではありません)。また、secretsmanager:GetSecretValue権限が必要です。迅速なテストのために、代わりに DD_API_KEY を使用して、Datadog API キーをプレーンテキストで設定することができます。