Amazon OpenSearch サービスでのアラートの設定

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

アラートには Elasticsearch OpenSearch 6.2 以降が必要です。API の説明を含む詳細なドキュメントについては、ドキュメントの「アラート」を参照してください。 OpenSearch このトピックでは、 OpenSearch Service のアラートとオープンソースバージョンとの違いについて説明します。

アラートの許可

アラートはきめ細かなアクセスコントロールをサポートしています。ユースケースに合わせて権限を組み合わせる方法について詳しくは、ドキュメントの「アラートセキュリティ」を参照してください。 OpenSearch

OpenSearch ダッシュボード内の Alerting ページにアクセスするには、alerting_read_access少なくとも定義済みのロールにマップされているか、同等の権限が付与されている必要があります。このロールでは、アラート、宛先、モニターを表示する権限が付与されますが、アラートを確認したり、送信先やモニターを変更したりすることはできません。

アラートの開始方法

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

アラートを開始するには

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

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

通知

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

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

注記

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

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

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

通知を使い始めるには、 OpenSearch ダッシュボードにログインして [通知]、[チャネル]、[チャネルの作成] を選択します。

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 を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

データのモニタリング

異常検出