View a markdown version of this page

Amazon SNS を直接統合した APM からアラームを取り込む - AWS Incident Detection and Response ユーザーガイド
オプション 1: を使用するCloudFormationオプション 2: 手動の統合

Amazon SNS を直接統合した APM からアラームを取り込む

APM が Amazon SNS トピックへのアラームの送信をサポートしている場合は、このガイドに従って AWS Incident Detection and Response に APM アラームを取り込むことができます。

提供された CloudFormation テンプレートをデプロイすることも、この統合を手動でセットアップすることもできます。統合を設定する前に、AWS のサービスにリンクされたロール (SLR) AWSServiceRoleForHealth_EventProcessor がアカウントに作成されていることを確認します。

オプション 1: を使用するCloudFormation

CloudFormation テンプレートを使用すると、Amazon SNS 統合を使用して APM から AWS Incident Detection and Response にアラームを取り込むために必要な統合インフラストラクチャを作成するプロセスを簡素化できます。

注記

  • この CloudFormation テンプレートを介してデプロイされたリソース (Lambda や EventBridge など) には、追加コストが発生します。これらのサービスの料金の詳細については、「AWS の料金」を参照してください。

  • この CloudFormation テンプレートは、AWS Incident Detection and Response によってアラームを取り込む必要がある各 AWS アカウントとリージョンにデプロイする必要があります。

  • このドキュメントで提供される例は Grafana 用ですが、このテンプレートは Amazon Simple Notification Service と直接統合されているすべての APM に使用できます。

  • セキュリティ上の理由から、AWS では、ペイロードが Amazon CloudWatch Logs に記録されないようにするため、TransformLambdaFunction から logger.info() ステートメントを削除することが推奨されます。

この CloudFormation テンプレートをデプロイするための前提条件:

  • APM からアラームイベントを受信するには、Amazon Simple Notification Service トピックを作成する必要があります。Amazon Simple Notification Service コンソールで SNS トピックを作成します。

  • テンプレートの TransformLambdaFunction を変更して、使用中の APM に基づいて目的の値に ["detail"]["incident-detection-response-identifier"] を設定する必要があります。

前提条件の完了:

  1. Amazon SNS コンソールを開き、[トピック] を選択します。APM からアラームイベントを受信するために作成された SNS トピックの ARN をコピーします。

    • 例:arn:aws:sns:eu-west-1:012345678912:<your-apm-name>-sns

  2. CloudFormation テンプレートをダウンロードして開きます。

    • テンプレートで TransformLambdaFunction を見つける

      • def lambda_handler(event, context) で、event["detail"]["incident-detection-response-identifier"] をアラーム名が SNS レコードの JSON ペイロードに表示される json パスに設定します。

        • SNS 経由で TransformLambdaFunction に送信されるイベントには、親ペイロード構造として event["Records"][n]["Sns"]["Message"] があります。ソース (APM) からの実際のペイロードオリジンは、親構造内にラップされます。

        • Grafana の例: event["Records"][n]["Sns"]["Message"]["alerts"][n]["labels"]["alertname"]

CloudFormation テンプレートのデプロイ:

  1. 統合を設定する必要があるアカウントとリージョンで CloudFormation コンソールに移動します。

  2. CloudFormation に移動します。

    • [スタックの作成] の [新しいリソースを使用 (標準)] を選択します。

      • [既存のテンプレートを選択]、[テンプレートファイルをアップロード]、[ファイルを選択] の順に選択し、ローカルに保存した CloudFormation テンプレートをアップロードします。

  3. スタックの詳細を指定する:

    • スタック名 (例: <your-apm-name>IntegrationForIDR) を入力します。

    • 前提条件の完了時に取得したパラメータ値を指定します。

      • APMNameParameter 例: Grafana

      • TriggerSNSParameter 例: arn:aws:sns:eu-west-1:012345678912:<your-apm-name>-sns

    • [次へ] を選択します。

  4. スタックオプションを設定する:

    • ページの下部までスクロールし、CloudFormation がカスタム名で IAM リソースを作成できるようにするチェックボックスをオンにします。

  5. 確認と作成:

    • パラメータ値が正しく設定されていることを検証し、[送信] を選択します。

  6. CloudFormation スタックは、APM イベントを AWS Incident Detection and Response に統合するために必要なリソースをデプロイします。CloudFormation スタックのステータスが CREATE_COMPLETE になるまで待ちます。

  7. CloudFormation スタックは、サンプル値が Grafana のパラメータに入力され、EU–WEST–1 リージョンで実行されたと仮定して、以下のリソースを作成します。

    • CustomEventBus: Grafana-AWSIncidentDetectionResponse-EventBus

    • SNSSubscription: arn:aws:sns:eu-west-1:012345678912:grafana-sns:[random_string]

    • TransformLambdaExecutionRole: IDR-TransformLambdaExecutionRole-eu-west-1

    • TransformLambdaFunction: Grafana-AWSIncidentDetectionResponse-Lambda-Transform

    • TransformLambdaPermission: GrafanaIntegrationForIDR-TransformLambdaPermission-[random_string]

インテグレーションテスト

CloudFormation スタックが正常にデプロイされたら、APM からテストペイロードを送信して統合を検証できます。APM からテストペイロードが送信されると、次のようになります。

  1. Lambda コンソールに移動して、APMNameParameter-AWSIncidentDetectionResponse-Lambda-Transform 関数を選択します。[モニタリング] タブを選択します。

  2. 成功した呼び出しは、メトリクスグラフで確認する必要があります。

  3. [Amazon CloudWatch Logs を表示する] を選択します。ログストリームのログイベントから検証して、APM から送信されたテストペイロードが存在するか、またはエラーが発生したかどうかを確認できます。

AWS Incident Detection and Response へのイベントバス ARN の共有

  1. Amazon EventBridge コンソールにサインインします。イベントバスを選択します。

  2. CloudFormation スタックの一部としてデプロイされた [カスタムイベントバス] の ARN を記録します (例: arn:aws:events:eu-west-1:012345678912:event-bus/Grafana-AWSIncidentDetectionResponse-EventBus)。

    • アラーム取り込みのアンケート – 概要 の [サードパーティー APM アラーム] セクションの [EventBridge イベントバス ARN] フィールドで、このカスタムイベントバスの ARN を AWS Incident Detection and Response に提供します。

  3. オンボーディングプロセス中、AWS Incident Detection and Response は、このカスタムイベントバスにマネージド EventBridge ルールを作成して APM アラームを取り込みます。

オプション 2: 手動の統合

Amazon SNS を使用した統合の例を示す図。

  1. Amazon SNS コンソールを開き、[apm_name]-sns という名前の SNS トピックを Amazon Simple Notification Service コンソールで作成して、APM からアラームイベントを受け取ります。作成された SNS トピックの ARN を書き留めます。

  2. 次のいずれかを実行します。

    • (推奨) [apm_name]-AWSIncidentDetectionResponse-EventBus という名前の EventBridge カスタムイベントバスを作成します。

    • (代替方法) カスタムイベントバスの代わりにデフォルトの EventBridge イベントバスを使用します。

    AWS Incident Detection and Response は、AWSServiceRoleForHealth_EventProcessor SLR を介してカスタムイベントバスまたはデフォルトのイベントバスにマネージドルール (AWSHealthEventProcessorEventSource-DO-NOT-DELETE) をインストールします。ルールソースはカスタムイベントバスまたはデフォルトのイベントバスとなり、ルールの送信先は AWS Incident Detection and Response となります。また、ルールはサードパーティーの APM イベントを取り込むパターンと一致します。

  3. $YourApmName-AWSIncidentDetectionResponse-LambdaFunction という名前の Lambda 関数を作成して、SNS ペイロードを変換します。

  4. SNS トピックを Lambda 関数 $YourApmName-AWSIncidentDetectionResponse-LambdaFunction のトリガーとして設定します。

    • [トリガーを追加] ページで「SNS」を検索します。

    • ステップ 1 で作成した専用 SNS トピックの ARN を追加します。

    • [追加] を選択します。

  5. APM ドキュメントに従って、AWS Incident Detection and Response が取り込む必要がある APM ペイロードの SNS 送信先を設定します。

AWS Incident Detection and Response は、AWSServiceRoleForHealth_EventProcessor SLR を介してカスタムイベントバスまたはデフォルトのイベントバスにマネージドルール (AWSHealthEventProcessorEventSource-DO-NOT-DELETE) をインストールします。ルールソースはカスタムイベントバスまたはデフォルトのイベントバスとなり、ルールの送信先は AWS Incident Detection and Response となります。また、ルールはサードパーティーの APM イベントを取り込むパターンと一致します。