Datadog は、サーバーレスフレームワークを使用してサーバーレスアプリケーションをデプロイする開発者向けに、サーバーレスフレームワークプラグインを推奨しています。 プラグインは、アプリケーションのインスツルメンテーションを自動的に有効にして、次の方法でメトリクス、トレース、ログを収集します。

• Datadog Lambda ライブラリを Lambda にインストールすると、Lambda レイヤーとして機能します。
• Datadog Lambda 拡張機能を Lambda 関数に Lambda レイヤーとしてインストールするか (addExtension)、Datadog Forwarder を Lambda 関数のロググループにサブスクライブします (forwarderArn)。
• Lambda 関数に環境変数やトレースレイヤーを追加するなど、必要なコンフィギュレーション変更を行います。

はじめに

すぐに開始するには、Python、Node.js、Ruby、Java、Go、または .NET のインストール手順に従い、Datadog で関数の拡張メトリクス、トレース、ログを表示します。

インストールが完了したら、詳細オプションを監視の目的に合わせて設定します。

アップグレード

プラグインの各バージョンは、Datadog Lambda レイヤーの特定のバージョンのセットで公開されています。Datadog Lambda レイヤーの最新バージョンによって提供される新機能とバグ修正を取得するには、サーバーレスフレームワークプラグインをアップグレードします。新しいバージョンを本番アプリケーションに適用する前にテストしてください。

コンフィギュレーションパラメーター

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

custom:
  datadog:
    apiKeySecretArn: "{Datadog_API_Key_Secret_ARN}"
    enableXrayTracing: false
    enableDDTracing: true
    enableDDLogs: true
    subscribeToAccessLogs: true
    forwarderArn: arn:aws:lambda:us-east-1:000000000000:function:datadog-forwarder
    exclude:
      - dd-excluded-function

Webpack

webpack などのバンドラーを使用している場合は、サーバーレストレーシングと Webpack を参照してください。

TypeScript

タイプ定義が見つからないというエラーに遭遇することがあります。このエラーを解決するには、プロジェクトの package.json の devDependencies リストに datadog-lambda-js と dd-trace を追加してください。

serverless-typescript を使用している場合は、serverless-datadog が serverless.yml の serverless-typescript エントリの上にあることを確認してください。プラグインは自動的に .ts ファイルを検出します。

plugins:
  - serverless-plugin-datadog
  - serverless-typescript

特定の環境にプラグインを無効にする

環境に基づき（--stage を通じて渡された場合など）プラグインを無効にするには、以下の例のような構文を使用できます。

provider:
  stage: ${self:opt.stage, 'dev'}

custom:
  staged: ${self:custom.stageVars.${self:provider.stage}, {}}

  stageVars:
    dev:
      dd_enabled: false

  datadog:
    enabled: ${self:custom.staged.dd_enabled, true}

サーバーレスモニター

デフォルト値が事前構成された 7 つの推奨モニターがあります。

推奨されるサーバーレスモニターを有効にして構成するには

推奨モニターを作成するには、それぞれのサーバーレスモニター ID を使用する必要があります。ご使用の環境に、DATADOG_API_KEY および DATADOG_APP_KEY も設定する必要があることにご注意ください。

推奨モニターのパラメーターをさらに構成する場合は、サーバーレスモニター ID の下にパラメーター値を直接定義できます。推奨モニターで指定されていないパラメーターは、デフォルトの推奨値を使用します。推奨モニターの query パラメーターは直接変更できず、デフォルトで上記で定義された値の query を使用します。ただし、options パラメーター内で再定義することにより、query のしきい値を変更できます。モニターを削除するには、serverless.yml テンプレートからモニターを削除します。モニターパラメーターの定義方法の詳細については、Datadog Monitors API を参照してください。

モニターの作成は、関数がデプロイされた後に行われます。モニターの作成に失敗した場合でも、関数は正常にデプロイされます。

デフォルト値で推奨モニターを作成するには

パラメーター値を指定せずに、適切なサーバーレスモニター ID を定義します

custom:
  datadog:
    addLayers: true
    monitors:
      - high_error_rate:

推奨モニターを構成するには

custom:
  datadog:
    addLayers: true
    monitors:
      - high_error_rate:
          name: "High Error Rate with Modified Warning Threshold"
          message: "More than 10% of the function’s invocations were errors in the selected time range. Notify @data.dog@datadoghq.com @slack-serverless-monitors"
          tags: ["modified_error_rate", "serverless", "error_rate"]
          require_full_window: true
          priority: 2
          options:
            include_tags: true
            notify_audit: true
            thresholds:
              warning: 0.05
              critical: 0.1

モニターを削除するには

サーバーレスモニター ID とそのパラメーターを削除すると、モニターが削除されます。

カスタムモニターを有効にして構成するには

カスタムモニターを定義するには、環境で API キーとアプリケーションキー (DATADOG_API_KEY と DATADOG_APP_KEY) を渡すことに加えて、一意のサーバーレスモニター ID 文字列を定義する必要があります。query パラメーターは必須ですが、他のすべてのパラメーターはオプションです。一意のサーバーレスモニター ID 文字列を定義し、以下に必要なパラメーターを指定します。モニターパラメーターの詳細については、Datadog Monitors API を参照してください。

custom:
  datadog:
    addLayers: true
    monitors:
      - custom_monitor_id:
          name: "Custom Monitor"
          query: "max(next_1w):forecast(avg:system.load.1{*}, 'linear', 1, interval='60m', history='1w', model='default') >= 3"
          message: "Custom message for custom monitor. Notify @data.dog@datadoghq.com @slack-serverless-monitors"
          tags: ["custom_monitor", "serverless"]
          priority: 3
          options:
            enable_logs_sample: true
            require_full_window: true
            include_tags: false
            notify_audit: true
            notify_no_data: false
            thresholds:
              warning: 2
              critical: 3

変更の分割

v5.0.0

• Datadog 拡張機能と併用することで、Lambda のリソースタグではなく、環境変数を通して service と env タグを設定するプラグインです。
• enableTags パラメーターは、新しい service、env パラメーターに置き換わりました。

v4.0.0

• Datadog Lambda 拡張機能は、Datadog へテレメトリーを送信するメカニズムのデフォルトになりました。

serverless-plugin-warmup との連携

このライブラリは serverless-plugin-warmup とベストエフォートで互換性があります。Datadog から warmer 関数を除外したい場合は、このライブラリの exclude 機能を使用します。

アプリケーションを適切にパッケージするために、このプラグインは serverless.yml ファイルの serverless-plugin-warmup の_後_に記述する必要があります。

plugins:
  - serverless-plugin-warmup
  - serverless-plugin-datadog

問題を開く

このパッケージでバグが発生した場合は、問題を登録してお知らせください。新しい問題を開く前に、重複を避けるために既存の問題を検索してください。

問題を開くときは、Serverless Framework のバージョン、Python/Node.js のバージョン、および取得できる場合はスタックトレースを含めてください。さらに、必要に応じて再現手順を含めてください。

機能リクエストの問題を開くこともできます。

寄稿

このパッケージに問題が見つかり、修正された場合は、手順に従ってプルリクエストを開いてください。

コミュニティ

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

ライセンス

特に明記されていない限り、このリポジトリ内のすべてのファイルは、Apache License Version 2.0 の下でライセンスされます。

この製品には、Datadog(https://www.datadoghq.com/) で開発されたソフトウェアが含まれています。Copyright 2021 Datadog, Inc.