Amazon OpenSearch Service でのアラートの設定

1 つ以上のインデックスのデータが特定の条件を満たしたときに通知を受け取るように Amazon OpenSearch Service のアラートを設定します。例えば、アプリケーションで 1 時間に 5 つを超える HTTP 503 エラーが記録された場合に E メールが届くようにしたり、過去 20 分以内に新しいドキュメントにインデックスが付けられなかった場合にデベロッパーに連絡したりできます。

アラートには、 OpenSearch または Elasticsearch 6.2 以降が必要です。

注記

このドキュメントでは、アラートの概要と、Amazon OpenSearch Service ドメインでのアラートとオープンソース OpenSearch クラスターでのアラートの違いについて説明します。包括的な API リファレンス、複合モニターで使用可能なリクエストフィールドのリスト、使用可能なトリガー変数とアクション変数の説明など、アラートに関する詳細なドキュメントについては、 OpenSearch ドキュメントの「アラート」を参照してください。

アラートの許可

アラートはきめ細かなアクセスコントロールをサポートしています。ユースケースに合わせたアクセス許可の混在とマッチングの詳細については、 OpenSearch ドキュメントの「アラートセキュリティ」を参照してください。

OpenSearch Dashboards 内のアラートページにアクセスするには、少なくともalerting_read_access事前定義されたロールにマッピングされているか、同等のアクセス許可が付与されている必要があります。このロールは、アラート、送信先、モニターを表示するアクセス許可を付与しますが、アラートの確認や送信先やモニターの変更を行うアクセス許可は付与しません。

アラートの開始方法

アラートを作成するには、モニター を設定します。これは、定義されたスケジュールで実行され、 OpenSearch インデックスをクエリするジョブです。また、1 つまたは複数のトリガーも設定します。イベントを生成する条件をトリガーで定義します。最後に、アクションを設定します。アラートがトリガーされるとアクションが実行されます。

アラートを開始するには

OpenSearch ダッシュボードのメインメニューからアラートを選択し、モニターの作成を選択します。
クエリごと、バケットごと、クラスターごとのメトリクス、またはドキュメントごとのモニターを作成します。手順については、「Create a monitor」 (モニターの作成) を参照してください。
[Triggers] (トリガー) では、1 つまたは複数のトリガーを作成します。手順については、「Create triggers」(トリガーの作成) を参照してください。
[Actions] (アクション) では、アラートの通知チャネルを設定します。Slack、Amazon Chime、カスタム webhook、Amazon SNS のいずれかを選択します。ご想像のとおり、通知にはチャネルへの接続が必要です。例えば、 OpenSearch サービスドメインがインターネットに接続して Slack チャンネルに通知したり、カスタムウェブフックをサードパーティーサーバーに送信したりできる必要があります。 OpenSearch サービスドメインがアラートを送信するには、カスタムウェブフックにパブリック IP アドレスが必要です。

ヒント
アクションが正常にメッセージを送信した後、そのメッセージへのアクセスの保護 (Slack チャネルへのアクセスなど) はユーザーの責任となります。ドメインに機密データが含まれている場合は、アクションなしでトリガーを使用し、Dashboards でアラートを定期的にチェックすることを検討してください。

通知

アラートは、通知用の統合システムである通知と統合されます OpenSearch。通知により、どの通信サービスを使用するかを設定したり、関連する統計やトラブルシューティング情報を確認したりできます。包括的なドキュメントについては、 OpenSearch ドキュメントの「通知」を参照してください。

通知を使用するには、ドメインが OpenSearch バージョン 2.3 以降を実行している必要があります。

注記

OpenSearch 通知は、 OpenSearch サービスソフトウェアの更新、Auto-Tune Amazon OpenSearch Service での通知の機能強化、およびその他の重要なドメインレベルの情報に関する詳細を提供するサービス通知とは別のものです。 OpenSearch 通知はプラグイン固有です。

通知チャネルは、バージョン 2.0 以降の OpenSearchアラート送信先に置き換えられました。送信先は正式に廃止され、今後すべてのアラート通知はチャネルを通じて管理されます。

ドメインをバージョン 2.3 以降にアップグレードすると (2.x のサービス OpenSearch サポートは 2.3 で始まるため）、既存の送信先は自動的に通知チャネルに移行されます。送信先が移行できなかった場合、モニターは通知チャネルに移行されるまでその送信先を使用し続けます。詳細については、 OpenSearch ドキュメントの「送信先に関する質問」を参照してください。

通知を開始するには、 OpenSearch Dashboards にサインインし、通知、チャネル 、チャネル の作成 を選択します。

Amazon Simple Notification Service (Amazon SNS ) は、通知でサポートされているチャネルタイプです。ユーザーを認証するには、Amazon SNS へのフルアクセス権をユーザーに付与するか、Amazon SNS へのアクセス許可を持つ IAM ロールをユーザーに割り当てる必要があります。手順については、[Amazon SNS as a channel type] (チャネルタイプとしての Amazon SNS) を参照してください。

差異

のオープンソースバージョンと比較して OpenSearch、Amazon OpenSearch Service でのアラートにはいくつかの大きな違いがあります。

アラート設定

OpenSearch サービスでは、次のアラート設定を変更できます。

plugins.scheduled_jobs.enabled
plugins.alerting.alert_history_enabled
plugins.alerting.alert_history_max_age
plugins.alerting.alert_history_max_docs
plugins.alerting.alert_history_retention_period
plugins.alerting.alert_history_rollover_period
plugins.alerting.filter_by_backend_roles

他のすべての設定では、変更できないデフォルト値が使用されます。

アラートを無効にするには、次のリクエストを送信します。


PUT _cluster/settings
{
  "persistent" : {
    "plugins.scheduled_jobs.enabled" : false
  }
}

次のリクエストは、デフォルトの 30 日ではなく、7 日後に履歴インデックスを自動的に削除するようにアラートを設定します。


PUT _cluster/settings
{
  "persistent": {
    "plugins.alerting.alert_history_retention_period": "7d"
  }
}

以前にモニターを作成し、毎日のアラートインデックスの作成を停止する場合は、すべてのアラート履歴インデックスを削除します。


DELETE .plugins-alerting-alert-history-*

履歴インデックスのシャード数を減らすには、インデックステンプレートを作成します。次のリクエストは、1 つのシャードと 1 つのレプリカにアラートを送信するための履歴インデックスを設定します。


PUT _index_template/template-name
{
  "index_patterns": [".opendistro-alerting-alert-history-*"],
  "template": {
    "settings": {
      "number_of_shards": 1,
      "number_of_replicas": 1
    }
  }
}

データ損失の許容値によっては、ゼロレプリカの使用を検討することもできます。インデックステンプレートの作成と管理の詳細については、 OpenSearch ドキュメントの「インデックステンプレート」を参照してください。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

データのモニタリング

異常検出