Datadog のサーバーレスマクロ

Datadog では、AWS SAM をご利用のお客様のサーバーレスアプリケーションのデプロイに、サーバーレスの CloudFormation マクロをおすすめしています。

以下を行うことで、サーバーレスアプリケーションからのメトリクス、トレース、ログの収集をマクロで自動的に構成できます。

• Python および Node.js Lambda 関数用に Datadog Lambda ライブラリおよび Lambda 拡張機能をインストールし構成。
• Lambda 関数からの拡張 Lambda メトリクスおよびカスタムメトリクスの収集を有効化。
• 必要に応じて、Datadog Forwarder から Lambda 関数ロググループへのサブスクリプションを管理。

インストール

AWS アカウントで Datadog サーバーレスマクロを使用可能にするには、Datadog のテンプレートで CloudFormation スタックをデプロイします。このデプロイには、CloudFormation マクロリソースと、マクロを実行したときに呼び出される Lambda 関数が含まれます。このスタックを有効にすると、同じアカウントにデプロイされた他の CloudFormation スタックにマクロを使用できるようになります。アカウントのマクロ定義に関する詳細は、CloudFormation ドキュメントページを参照してください。

注: Datadog サーバーレスマクロは、変換したいスタックを含む各リージョンで一度だけ作成する必要があります。

オプション 1: AWS Console

上記の Launch Stack テンプレートリンクを使用して、AWS アカウントで Datadog サーバーレスマクロスタックを作成します。

オプション 2: AWS CLI

初めてインストールする場合は、以下のようにデプロイします。

aws cloudformation create-stack \
  --stack-name datadog-serverless-macro \
  --template-url https://datadog-cloudformation-template.s3.amazonaws.com/aws/serverless-macro/latest.yml \
  --capabilities CAPABILITY_AUTO_EXPAND CAPABILITY_IAM

AWS SAM での使用

SAM を使用してサーバーレスアプリケーションをデプロイするには、必要な SAM 変換の後に Datadog Serverless CloudFormation マクロを template.yml ファイルの Transform セクションに追加します。また、パラメーターを追加してマクロに渡すことで、Datadog ソースコードインテグレーションを有効化します。

Transform:
  - AWS::Serverless-2016-10-31
  - Name: DatadogServerless
    Parameters:
      stackName: !Ref "AWS::StackName"
      apiKey: "<DATADOG_API_KEY>"
      pythonLayerVersion: "<LAYER_VERSION>" # Node.js には nodeLayerVersion を使用
      extensionLayerVersion: "<LAYER_VERSION>"
      service: "<SERVICE>" # オプション
      env: "<ENV>" # オプション
      version: "<VERSION>" # オプション
      tags: "<TAGS>" # オプション
      # ソースコードインテグレーションのタグ付けを有効にするには、ここで DDGitData を渡す
      gitData: !Ref DDGitData
      # その他のパラメーターについては、コンフィギュレーションセクションを参照

Parameters:
  DDGitData:
    Type: String
    Default: ""
    Description: "The output of $(git rev-parse HEAD),$(git config --get remote.origin.url). Used for Datadog Source Code Integration tagging"

Datadog のソースコードインテグレーションで DDGitData パラメーターを設定するには、SAM の --parameter-overrides オプションを使用します。

sam deploy --parameter-overrides  DDGitData="$(git rev-parse HEAD),$(git config --get remote.origin.url)"

注: マクロをインストールしたときに、提供された template.yml ファイルを変更しないと、アカウントに定義されたマクロ名は DatadogServerless になります。オリジナルのテンプレートを変更する場合は、個々に追加する変換の名前が AWS::CloudFormation::Macro リソースの Name プロパティと一致するようにしてください。

注: 構成の一部を一度だけ指定したい場合は、template.yml を修正して、そのリージョンに設定したい環境変数を追加することができます。これは、追加のデフォルト値を制御するための方法です。以下の例では、DD_API_KEY_SECRET_ARN と DD_ENV を設定していますが、マクロはこれをデフォルト値として扱います。

Resources:
  MacroFunction:
    Type: AWS::Serverless::Function
    DependsOn: MacroFunctionZip
    Properties:
      FunctionName:
        Fn::If:
          - SetFunctionName
          - Ref: FunctionName
          - Ref: AWS::NoValue
      Description: Processes a CloudFormation template to install Datadog Lambda layers for Python and Node.js Lambda functions.
      Handler: src/index.handler
      ...
      Environment:
        Variables:
          DD_API_KEY_SECRET_ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:DdApiKeySecret-e1v5Yn7TvIPc-d1Qc4E"
          DD_ENV: "dev"

更新

新リリース後にマクロを更新する場合は、update-stack メソッドを使用します。

aws cloudformation update-stack \
  --stack-name datadog-serverless-macro \
  --template-url https://datadog-cloudformation-template.s3.amazonaws.com/aws/serverless-macro/latest.yml \
  --capabilities CAPABILITY_AUTO_EXPAND CAPABILITY_IAM

また、最新の リリースからマクロのバージョンを指定することもできます。それには、latest.yml をリリースバージョンに置き換えます (例: 0.1.2.yml)。

コンフィギュレーション

プラグインをさらに構成するには、以下のカスタムパラメーターを使用します。

UDS の仕組み

このマクロにより CloudFormation テンプレートが変更され、Node.js および Python 用の Lambda レイヤーを関数にアタッチすることで Datadog Lambda ライブラリがインストールされます。そして、コードの変更を必要とせずに、Lambda ライブラリを初期化する置換ハンドラーへリダイレクトされます。

トラブルシューティング

デバッグログ

デバッグの問題が発生した場合は、CloudWatch ログでマクロ Lambda 関数を確認することができます。CloudWatch ログへのアクセス方法:

• マクロ CloudFormation スタック (手順に従ってコマンドをコピーした場合、名称は datadog-serverless-macro となります) を検索します
• 「Resources」タブをクリックして、論理 ID がMacroFunctionLogGroup のCloudWatch ロググループを見つけます

エラーメッセージ: ‘FunctionName’ プロパティが未定義です…

このエラーは、forwarderArn を提供し、Lambda 関数を初めてデプロイする場合に発生します。ロググループが存在せず、マクロはこのロググループの作成または Forwarder へのサブスクライブができません。この問題を修正する一つの方法は、Lambda で FunctionName プロパティを明示的に定義することです（下記の例を参照）。

Resources:
  MyLambda:
    Type: AWS::Serverless::Function
    Properties:
      Handler: index.handler
      Runtime: nodejs12.x
      FunctionName: MyFunctionName # このプロパティを Lambda に追加します

FunctionName を明示的に定義できない（または定義しない）場合は、SAM テンプレートまたは CDK ソースコードから forwarderArn パラメーターを削除し、以下のように AWS::Logs::SubscriptionFilter リソースを使用してサブスクリプションフィルターを定義します。

Resources:
  MyLogSubscriptionFilter:
    Type: "AWS::Logs::SubscriptionFilter"
    Properties:
      DestinationArn: "<DATADOG_FORWARDER_ARN>"
      LogGroupName: "<CLOUDWATCH_LOG_GROUP_NAME>"
      FilterPattern: ""

エラーメッセージ: ’logGroupNamePrefix’ は制約を満たせませんでした…

FunctionName に、!Sub などの CloudFormation 関数が含まれる場合、forwarderArn オプションは機能しません。この場合、マクロは実際の関数名にアクセスできません（CloudFormation は変換後に関数を実行します）。そのため、関数にロググループやサブスクリプションフィルターを作成できません。

SAM テンプレートまたは CDK ソースコードから forwarderArn パラメーターを削除し、以下のように AWS::Logs::SubscriptionFilter リソースを使用してサブスクリプションフィルターを定義します。

Resources:
  MyLogSubscriptionFilter:
    Type: "AWS::Logs::SubscriptionFilter"
    Properties:
      DestinationArn: "<DATADOG_FORWARDER_ARN>"
      LogGroupName: "<CLOUDWATCH_LOG_GROUP_NAME>"
      FilterPattern: ""

エラーメッセージ: ‘Failed to execute transform DatadogServerless’

このエラーは、コマンドを実行する IAM ユーザーに lambda:InvokeFunction 権限がない場合に発生する可能性があります。そのユーザーの IAM ロールに権限を追加してください。

コミュニティ

製品のフィードバックや質問については、Slack の Datadog コミュニティの #serverless チャンネルに参加してください。