View a markdown version of this page

Grafana の接続 - AWS DevOps エージェント
Grafana の要件Grafana の登録 (アカウントレベル)エージェントスペースへの Grafana の追加Grafana アラートウェブフックの設定制限事項Grafana 接続の管理

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Grafana の接続

Grafana 統合により、 AWS DevOps Agent はインシデント調査中に Grafana インスタンスからメトリクス、ダッシュボード、アラートデータをクエリできます。この統合は、Grafana のアカウントレベルの登録と、個々のエージェントスペースへの接続という 2 つのステップのプロセスに従います。

セキュリティを向上させるために、Grafana 統合は読み取り専用ツールのみを有効にします。書き込みツールは無効になっており、有効にすることはできません。つまり、エージェントは Grafana インスタンスからデータをクエリおよび読み取ることができますが、ダッシュボード、アラート、注釈などの Grafana リソースを作成、変更、または削除することはできません。詳細については、「Security in AWS DevOps Agent」を参照してください。

Grafana の要件

Grafana を接続する前に、以下を確認してください。

  • Grafana バージョン 9.0 以降。一部の機能、特にデータソース関連のオペレーションは、API エンドポイントがないため、以前のバージョンでは正しく動作しない場合があります。

  • HTTPS 経由でアクセス可能な Grafana インスタンス。パブリックネットワークエンドポイントとプライベートネットワークエンドポイントの両方がサポートされています。プライベートネットワーク接続では、Grafana インスタンスをパブリックインターネットアクセスなしで VPC 内でホストできます。詳細については、「プライベートにホストされたツールへの接続」を参照してください。

  • 適切な読み取りアクセス許可を持つアクセストークンを持つ Grafana サービスアカウント

Grafana の登録 (アカウントレベル)

Grafana は AWS アカウントレベルで登録され、そのアカウントのすべてのエージェントスペース間で共有されます。

ステップ 1: Grafana を設定する

  1. AWS マネジメントコンソールにサインインする

  2. AWS DevOps エージェントコンソールに移動する

  3. 機能プロバイダーページに移動する (サイドナビゲーションからアクセス可能)

  4. Telemetry の「利用可能なプロバイダー」セクションで Grafana を検索し、登録をクリックします

  5. Grafana の設定ページで、次の情報を入力します。

    • サービス名 (必須) – 英数字、ハイフン、アンダースコアのみを使用して、Grafana サーバーのわかりやすい名前を入力します。例えば、my-grafana-server。

    • Grafana URL (必須) – Grafana インスタンスの完全な HTTPS URL を入力します。例えば、https://myinstance.grafana.net。

    • サービスアカウントアクセストークン (必須) – Grafana サービスアカウントアクセストークンを入力します。トークンは通常、 で始まりますglsa_。サービスアカウントトークンを作成するには、Grafana インスタンスに移動し、管理 > サービスアカウントに移動し、ビューワーロールを使用してサービスアカウントを作成し、トークンを生成します。

    • 説明 (オプション) – サーバーの目的を特定するのに役立つ説明を追加します。例えば、Production Grafana server for monitoring。

  6. (オプション) 組織の目的で登録に AWS タグを追加します。

  7. [次へ] をクリックします。

ステップ 2: Grafana 登録を確認して送信する

  1. Grafana 設定の詳細をすべて確認する

  2. 送信をクリックして登録を完了します

  3. 登録が成功すると、Grafana は機能プロバイダーページの現在登録されているセクションに表示されます。

エージェントスペースへの Grafana の追加

アカウントレベルで Grafana を登録したら、個々のエージェントスペースに接続できます。

  1. AWS DevOps エージェントコンソールで、エージェントスペースを選択します。

  2. 機能タブに移動する

  3. テレメトリセクションで、追加 をクリックします。

  4. 利用可能なプロバイダーのリストから Grafana を選択する

  5. 保存 をクリックします。

Grafana アラートウェブフックの設定

Grafana コンタクトポイントを介してウェブフックを送信することで、アラートが発生したときに AWS DevOps エージェント調査を自動的にトリガーするように Grafana を設定できます。ウェブフック認証方法と認証情報管理の詳細については、「」を参照してくださいWebhook による DevOps エージェントの呼び出し。

ステップ 1: カスタム通知テンプレートを作成する

Grafana インスタンスで、アラート > コンタクトポイント > 通知テンプレートに移動し、次の内容の新しいテンプレートを作成します。

{{ define "devops-agent-payload" }}
{
  "eventType": "incident",
  "incidentId": "{{ (index .Alerts 0).Labels.alertname }}-{{ (index .Alerts 0).Fingerprint }}",
  "action": "{{ if eq .Status "resolved" }}resolved{{ else }}created{{ end }}",
  "priority": "{{ if eq .Status "resolved" }}MEDIUM{{ else }}HIGH{{ end }}",
  "title": "{{ (index .Alerts 0).Labels.alertname }}",
  "description": "{{ (index .Alerts 0).Annotations.summary }}",
  "service": "{{ if (index .Alerts 0).Labels.job }}{{ (index .Alerts 0).Labels.job }}{{ else }}grafana{{ end }}",
  "timestamp": "{{ (index .Alerts 0).StartsAt }}",
  "data": {
    "metadata": {
      {{ range $k, $v := (index .Alerts 0).Labels }}
      "{{ $k }}": "{{ $v }}",
      {{ end }}
      "_source": "grafana"
    }
  }
}
{{ end }}

このテンプレートは、Grafana アラートを AWS DevOps Agent が期待するウェブフックペイロード構造にフォーマットします。アラートラベル、注釈、ステータスを適切なフィールドにマッピングし、すべてのアラートラベルをメタデータとして含めます。

ステップ 2: ウェブフックコンタクトポイントを作成する

  1. Grafana でアラート > コンタクトポイントに移動し、コンタクトポイントの追加をクリックします

  2. 統合タイプとして Webhook を選択する

  3. AWS DevOps Agent ウェブフックエンドポイントへの URL の設定

  4. オプションのウェブフック設定で、ウェブフックタイプに基づいて認証ヘッダーを設定します。詳細については、「Webhook 認証方法」を参照してください。

  5. カスタムテンプレートを使用するように Message フィールドを設定します。 {{ template "devops-agent-payload" . }}

  6. コンタクトポイントの保存 をクリックします。

ステップ 3: コンタクトポイントを通知ポリシーに割り当てる

  1. アラート > 通知ポリシーに移動する

  2. 既存のポリシーを編集するか、新しいポリシーを作成します。

  3. 作成したウェブフックコンタクトポイントにコンタクトポイントを設定する

  4. ポリシーの保存 をクリックします。

一致するアラートが発生すると、Grafana はフォーマットされたペイロードを AWS DevOps エージェントに送信し、これにより自動的に調査が開始されます。

制限事項

  • ClickHouse データソースツール – ClickHouse データソースツールは現在サポートされていません。

  • プロアクティブインシデント防止 – は現在 Grafana ツールを使用しプロアクティブインシデント防止ません。サポートは今後のリリースが予定されています。

Amazon Managed Grafana に関する考慮事項

Amazon Managed Grafana (AMG) を使用している場合は、次の制限に注意してください。

  • Webhook コンタクトポイントはサポートされていません – AMG は現在、アラート設定で Webhook コンタクトポイントをサポートしていません。AMG を使用してアラートウェブフックを AWS DevOps エージェントに直接送信することはできません。詳細については、「Amazon Managed Grafana でのコンタクトポイントのアラート」を参照してください。

  • サービスアカウントトークンの有効期限 – AMG サービスアカウントトークンの最大有効期限は 30 日です。トークンをローテーションし、有効期限が切れる前に AWS DevOps Agent で Grafana 登録を更新する必要があります。認証情報を更新する方法については、「Grafana 接続の管理」を参照してください。AMG トークンの制限の詳細については、「Amazon Managed Grafana のサービスアカウント」を参照してください。

Grafana 接続の管理

  • 認証情報の更新 – サービスアカウントトークンの有効期限が切れるか、更新する必要がある場合は、機能プロバイダーページから Grafana を登録解除し、新しいトークンに再登録します。

  • 接続されたインスタンスの表示 – AWS DevOps エージェントコンソールで、エージェントスペースを選択し、機能タブに移動して、接続されたテレメトリソースを表示します。

  • Grafana の削除 – エージェントスペースから Grafana を切断するには、テレメトリセクションでそれを選択し、削除をクリックします。登録を完全に削除するには、まずすべてのエージェントスペースから削除してから、機能プロバイダーページから登録を解除します。