翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# Amazon OpenSearch Service ドメインのモニタリング
モニタリングは、Amazon OpenSearch Service およびその他の AWS ソリューションの信頼性、可用性、パフォーマンスを維持する上で重要な部分です。 AWS には、OpenSearch Service リソースをモニタリングし、問題を報告し、必要に応じて自動アクションを実行するための以下のツールが用意されています。
**Amazon CloudWatch**
Amazon CloudWatch は OpenSearch Service リソースをリアルタイムでモニタリングします。メトリクスの収集と追跡、カスタマイズしたダッシュボードの作成、およびメトリクスが特定のしきい値に達したときに通知したりアクションを実行したりするアラームの設定を行うことができます。詳細については、「[Amazon CloudWatch ユーザーガイド](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/)」を参照してください。
**Amazon CloudWatch Logs**
Amazon CloudWatch Logs を使用すると、OpenSearch のログファイルをモニタリング、保存、およびアクセスすることができます。CloudWatch Logs は、ログファイル内の情報をモニタリングし、特定のしきい値が満たされたときに通知できます。詳細については、[Amazon CloudWatch Logs ユーザーガイド](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/)を参照してください。
**Amazon EventBridge**
Amazon EventBridge は、OpenSearch Service ドメインの変更を記述したシステムイベントのストリームをほぼリアルタイムに配信します。特定のイベントを監視するルールを作成し、これらのイベントが発生したときに他の AWS サービスで自動アクションをトリガーできます。詳細については、[Amazon EventBridge ユーザーガイド](https://docs.aws.amazon.com/eventbridge/latest/userguide/)を参照してください。
**AWS CloudTrail**
AWS CloudTrail は、OpenSearch Service に対して行われた設定 API コールをイベントとしてキャプチャします。指定した Amazon S3 バケットにこれらのイベントが渡されます。この情報を使用して、リクエストを行ったユーザーとアカウント、リクエスト元のソース IP アドレス、およびリクエストの発生日時を特定できます。詳細については、[AWS CloudTrail ユーザーガイド](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/)を参照してください。
**Topics**
+ [Amazon CloudWatch を用いた OpenSearch クラスターメトリクスのモニタリング](managedomains-cloudwatchmetrics.md)
+ [Amazon CloudWatch Logs を用いて OpenSearch ログをモニタリングする](createdomain-configure-slow-logs.md)
+ [Amazon OpenSearch Service での監査ログのモニタリング](audit-logs.md)
+ [Amazon EventBridge を用いた OpenSearch Service イベントのモニタリング](monitoring-events.md)
+ [を使用した Amazon OpenSearch Service API コールのモニタリング AWS CloudTrail](managedomains-cloudtrailauditing.md)
# Amazon CloudWatch を用いた OpenSearch クラスターメトリクスのモニタリング
Amazon OpenSearch Service は、ドメインから Amazon CloudWatch にデータを公開します。CloudWatch では、それらのデータポイントについての統計 (*メトリクス*と呼ばれる) を、順序付けられた時系列データのセットとして取得できます。OpenSearch Service は、ほとんどのメトリクスを 60 秒間隔で CloudWatch に送信します。汎用または磁気 EBS ボリュームを使用する場合、EBS ボリュームのメトリクスは 5 分ごとのみに更新されます。すべての累積メトリクス (例: `ThreadpoolWriteRejected`、`ThreadpoolSearchRejected`) はメモリ内であり、状態が失われます。メトリクスは、ノードドロップ、ノードバウンス、ノード交換、ブルー/グリーンデプロイ中にリセットされます。Amazon CloudWatch の詳細については、[Amazon CloudWatch ユーザーガイド](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/)を参照してください。
OpenSearch Service コンソールには、CloudWatch の raw データに基づいて一連のグラフが表示されます。必要に応じて、コンソールでのグラフではなく Amazon CloudWatch にクラスターデータを表示することもできます。サービスは、メトリクスを 2 週間アーカイブし、その後破棄します。このメトリクスに追加料金はかかりませんが、CloudWatch には引き続きダッシュボードとアラームの作成に対して課金されます。詳細については、「[Amazon CloudWatch の料金](https://aws.amazon.com/cloudwatch/pricing/)」を参照してください。
OpenSearch Service は CloudWatch にメトリクスを発行します。
+ [クラスターメトリクス](#managedomains-cloudwatchmetrics-cluster-metrics)
+ [専用マスターノードメトリクス](#managedomains-cloudwatchmetrics-master-node-metrics)
+ [EBS ボリュームメトリクス](#managedomains-cloudwatchmetrics-master-ebs-metrics)
+ [インスタンスメトリクス](#managedomains-cloudwatchmetrics-instance-metrics)
+ [ウォームメトリクス](#managedomains-cloudwatchmetrics-uw)
+ [専用コーディネーターノードメトリクス](#managedomains-dedicated-coordinator-nodes)
+ [コールドストレージのメトリクス](#managedomains-cloudwatchmetrics-coldstorage)
+ [アラートメトリクス](#managedomains-cloudwatchmetrics-alerting)
+ [異常検出のメトリクス](#managedomains-cloudwatchmetrics-anomaly-detection)
+ [非同期検索メトリクス](#managedomains-cloudwatchmetrics-asynchronous-search)
+ [SQL メトリクス](#managedomains-cloudwatchmetrics-sql)
+ [k-NN メトリクス](#managedomains-cloudwatchmetrics-knn)
+ [クラスター間検索のメトリクス](#managedomains-cloudwatchmetrics-cross-cluster-search)
+ [クラスター間レプリケーションメトリクス](#managedomains-cloudwatchmetrics-replication)
+ [Learning to Rank のメトリクス](#managedomains-cloudwatchmetrics-learning-to-rank)
+ [Piped Processing Language のメトリクス](#managedomains-cloudwatchmetrics-ppl)
## CloudWatch でのメトリクスの表示
CloudWatch メトリクスはまずサービスの名前空間ごとにグループ化され、次に各名前空間内のさまざまなディメンションの組み合わせごとにグループ化されます。
**CloudWatch コンソールを使用してメトリクスを表示するには**
1. CloudWatch コンソール ([https://console.aws.amazon.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/)) を開きます。
1. 左のナビゲーションペインで、**[Metrics]** (メトリクス) を見つけ、**[All metrics]** (すべてのメトリクス) を選択します。**ES/OpenSearchService** 名前空間を選択します。
1. ディメンションを選択して、対応するメトリクスを表示します。個別のノードのメトリクスは、`ClientId, DomainName, NodeId` ディメンションにあります。クラスターメトリクスは、`Per-Domain, Per-Client Metrics` ディメンションにあります。一部のノードメトリクスは、クラスターレベルで集計されるため、両方のディメンションに含まれます。シャードメトリクスは、`ClientId, DomainName, NodeId, ShardRole` ディメンションにあります。
**を使用してメトリクスのリストを表示するには AWS CLI**
次のコマンドを実行します。
```
aws cloudwatch list-metrics --namespace "AWS/ES"
```
## OpenSearch Service でのヘルスチャートの解釈
OpenSearch Service でメトリクスを表示するには、[**クラスターヘルス**] および [**インスタンスヘルス**] タブを使用します [**インスタンスヘルス**] タブでは、ボックスチャートを使用して、各 OpenSearch ノードのヘルスを一目で確認できます。
![\[Chart showing search rate and CPU utilization for different instances with varying percentages.\]](http://docs.aws.amazon.com/ja_jp/opensearch-service/latest/developerguide/images/box-charts.png)
+ それぞれの色付きの箱は、指定した期間におけるノードの値範囲を示しています。
+ 青色の箱は他のノードと同じ値を示します。赤色の箱は異常値を示します。
+ 各箱の白線は、ノードの現在値を示します。
+ 各拍の両脇にある「ひげ」は、期間におけるすべてのノードの最大値と最小値を示します。
ドメインの設定を変更すると、[**クラスターヘルス**] タブと [**インスタンスヘルス**] タブの各インスタンスのリストが正しい数に戻る前に、しばらくの間 2 倍のサイズになる場合があります。この動作の説明については、「[Amazon OpenSearch Service で設定変更を行う](managedomains-configuration-changes.md)」を参照してください。
## クラスターメトリクス
Amazon OpenSearch Service は、以下のクラスターのメトリクスを提供します。
| メトリクス | 説明 |
| --- | --- |
| ClusterStatus.green | 値 1 は、すべてのインデックスシャードがクラスターのノードに割り当てられることを示します。 関連する統計: Maximum |
| ClusterStatus.yellow | 値 1 は、すべてのインデックスのプライマリシャードがクラスターのノードに割り当てられていることを示しますが、1 つ以上のインデックスのレプリカシャードが割り当てられていません。詳細については、「[黄色のクラスター状態](handling-errors.md#handling-errors-yellow-cluster-status)」を参照してください。関連する統計: Maximum |
| ClusterStatus.red | 値 1 は、少なくとも 1 つのインデックスのプライマリとレプリカの両方のシャードが、クラスターのノードに割り当てられないことを示します。詳細については、「[赤のクラスター状態](handling-errors.md#handling-errors-red-cluster-status)」を参照してください。 関連する統計: Maximum |
| Shards.active | アクティブなプライマリとレプリカの両方のシャードの合計数。 関連する統計: Maximum、Sum |
| Shards.unassigned | クラスターのノードに割り当てられていないシャードの数。 関連する統計: Maximum、Sum |
| Shards.delayedUnassigned | タイムアウト設定によってノード割り当てが遅れたシャードの数。 関連する統計: Maximum、Sum |
| Shards.activePrimary | アクティブなプライマリシャードの数。 関連する統計: Maximum、Sum |
| Shards.initializing | 初期化中のシャードの数。 関連する統計情報: Sum |
| Shards.relocating | 再配置中のシャードの数。 関連する統計情報: Sum |
| Nodes | 専用マスターノードとウォームノードを含む、OpenSearch Service クラスター内のノードの数。詳細については、「[Amazon OpenSearch Service で設定変更を行う](managedomains-configuration-changes.md)」を参照してください。 関連する統計: Maximum |
| SearchableDocuments | クラスター内のすべてのデータノードで検索可能なドキュメントの合計数。 関連する統計情報: Minimum、Maximum、Average |
| DeletedDocuments | クラスター内のすべてのデータノードで削除対象としてマークされたドキュメントの合計数。これらのドキュメントは検索結果に表示されなくなっていますが、セグメントマージ中にディスクから削除されたドキュメントのみが OpenSearch によって削除されます。このメトリクスは、削除リクエスト後に増加し、セグメントマージ後に減少します。 関連する統計情報: Minimum、Maximum、Average |
| CPUUtilization | クラスター内のデータノードの CPU 使用率の割合。Maximum は、CPU 使用率が最も高いノードを示します。Average は、クラスター内のすべてのノードを表します。このメトリクスは、個別のノードでも利用できます。 関連する統計: Maximum、Average |
| FreeStorageSpace | クラスター内のデータノードの空き領域。`Sum` はクラスターの合計空き容量を示しますが、正確な値を得るには期間を 1 分にする必要があります。`Minimum` と `Maximum` は、それぞれ空き領域が最も少ないノードと最も多いノードを示します。このメトリクスは、個別のノードでも利用できます。OpenSearch Service は、このメトリクスが `0` に達したときに `ClusterBlockException` をスローします。復旧するには、インデックスを削除する、より大きなインスタンスを追加する、既存のインスタンスに EBS ベースのストレージを追加する、のいずれかを実行する必要があります。詳細については[使用可能なストレージ領域の不足](handling-errors.md#handling-errors-watermark)を参照してください。 OpenSearch Service コンソールには、この値が GiB 単位で表示されます。Amazon CloudWatch コンソールには、この値が MiB 単位で表示されます。 `FreeStorageSpace` は、OpenSearch の `_cluster/stats` および `_cat/allocation` API が提供する値より常に小さくなります。OpenSearch Service は、内部オペレーションの各インスタンスでストレージ領域の割合を予約します。詳細については、「[ストレージ要件の計算](bp-storage.md)」を参照してください。 関連する統計: Minimum、Maximum、Average、Sum |
| ClusterUsedSpace | クラスターの合計使用領域。正確な値を取得するには、期間を 1 分のままにしておく必要があります。 OpenSearch Service コンソールには、この値が GiB 単位で表示されます。Amazon CloudWatch コンソールには、この値が MiB 単位で表示されます。 関連する統計: Minimum、Maximum |
| ClusterIndexWritesBlocked | クラスターで、着信する書き込みリクエストを受け入れるか、ブロックするかを指定します。値 0 では、クラスターでリクエストを受け入れます。値 1 ではリクエストをブロックします。 代表的なものとしては、`FreeStorageSpace` が少なすぎる、`JVMMemoryPressure` が高すぎるなどがあります。この問題を軽減するには、ディスク容量の追加やクラスターのスケーリングを検討します。 関連する統計: Maximum |
| JVMMemoryPressure | クラスター内のすべてのデータノードで使用する Java ヒープの最大パーセンテージ。OpenSearch Service は、インスタンスの RAM の半分を Java ヒープ (32 GiB のヒープサイズまで) に使用します。インスタンスは最大 64 GiB の RAM まで垂直スケーリングでき、それ以上はインスタンスを追加することで水平方向にスケーリングできます。「[Amazon OpenSearch Service で推奨される CloudWatch アラーム](cloudwatch-alarms.md)」を参照してください。 関連する統計: Maximum このメトリクスのロジックは、サービスソフトウェア R20220323 で変更されました。詳細については、「[release notes](release-notes.md)」を参照してください。 |
| OldGenJVMMemoryPressure | クラスター内のすべてのデータノードにおける「旧世代」で使用する Java ヒープの最大パーセンテージ。このメトリクスは、ノードレベルでも使用できます。 関連する統計: Maximum |
| AutomatedSnapshotFailure | クラスターの失敗した自動スナップショットの数。`1` の値は、自動スナップショットが過去 36 時間、ドメイン用に取られなかったことを示します。 関連する統計: Minimum、Maximum |
| CPUCreditBalance | クラスター内の、データノードに使用できる残りの CPU クレジット。CPU クレジットは、フル CPU パフォーマンスを 1 分間実現します。詳細については、*Amazon EC2 デベロッパーガイド*の「[CPU クレジット](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-credits-baseline-concepts.html)」を参照してください。このメトリクスは、T2 のインスタンスタイプでのみ使用できます。 関連する統計: Minimum |
| OpenSearchDashboardsHealthyNodes | OpenSearch Dashboards のヘルスチェック。最小、最大、および平均がすべて 1 に等しい場合、Dashboards は正常に動作しています。最大が 1、最小が 0、平均が 0.7 の 10 個のノードがある場合、これは 7 個のノード (70%) が正常であり、3 個のノード (30%) が正常でないことを意味します。 関連する統計情報: Minimum、Maximum、Average |
| OpensearchDashboardsReportingFailedRequestSysErrCount | サーバーの問題または機能の制限により失敗した OpenSearch Dashboards レポートを生成するリクエストの数。 関連する統計情報: Sum |
| OpensearchDashboardsReportingFailedRequestUserErrCount | クライアントの問題により失敗した OpenSearch Dashboards レポートを生成するリクエストの数。 関連する統計情報: Sum |
| OpensearchDashboardsReportingRequestCount | OpenSearch Dashboards レポートを生成するリクエストの合計数。 関連する統計情報: Sum |
| OpensearchDashboardsReportingSuccessCount | OpenSearch Dashboards レポートを生成するリクエストに成功した数。 関連する統計情報: Sum |
| KMSKeyError | 値 1 は、保管中のデータの暗号化に使用される AWS KMS キーが無効になっていることを示します。通常のオペレーションにドメインを復元するには、キーを再度有効にします。コンソールでは、保管時のデータを暗号化するドメインに対してのみこのメトリクスが表示されます。 関連する統計: Minimum、Maximum |
| KMSKeyInaccessible | 値 1 は、保管中のデータの暗号化に使用される AWS KMS キーが削除されたか、OpenSearch Service への許可が取り消されたことを示します。この状態にあるドメインを復元することはできません。ただし、手動のスナップショットがある場合は、それを使用してドメインのデータを新しいドメインに移行できます。コンソールでは、保管時のデータを暗号化するドメインに対してのみこのメトリクスが表示されます。 関連する統計: Minimum、Maximum |
| InvalidHostHeaderRequests | OpenSearch クラスターに対する HTTP リクエストのうち、ホストヘッダーが無効な (または欠落している) ものの数。有効なリクエストには、ホストヘッダー値としてドメインホスト名が含まれます。OpenSearch Service は、制限付きアクセスポリシーを持たないパブリックアクセスドメインの不正なリクエストを拒否します。すべてのドメインに制限付きアクセスポリシーを適用することをお勧めします。 このメトリクスで大きな値が表示される場合は、OpenSearch クライアントのリクエストにドメインホスト名が含まれていることを確認します (ない場合は、IP アドレスなど)。 関連する統計情報: Sum |
| OpenSearchRequests (previously ElasticsearchRequests) | OpenSearch クラスターに対するリクエストの数。 関連する統計情報: Sum |
| 2xx, 3xx, 4xx, 5xx | 特定の HTTP レスポンスコード (2*xx*、3*xx*、4*xx*、5*xx*) の発生につながった、ドメインへのリクエストの数。 関連する統計情報: Sum |
| ThroughputThrottle | ディスクがスロットリングされたかどうかが示されます。スロットリングは、`ReadThroughputMicroBursting` と `WriteThroughputMicroBursting` の合計スループットが最大スループット `MaxProvisionedThroughput` よりも高い場合に発生します。`MaxProvisionedThroughput` は、インスタンススループットまたはプロビジョニングされたボリュームスループットのうち、低い方の値です。値 1 は、ディスクがスロットリングされていることを示しています。値 0 は正常な動作を示します。 インスタンスのスループットについては、「[Amazon EBS 最適化インスタンスを使用する](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html)」を参照してください。ボリュームスループットの詳細については、「[Amazon EBS ボリュームの種類](https://console.aws.amazon.com/ebs/volume-types/)」を参照してください。 関連する統計: Minimum、Maximum |
| IopsThrottle | ドメインの 1 秒あたりの入出力オペレーション (IOPS) の数がスロットリングされているかどうかを示します。スロットリングは、データノードの IOPS が、EBS ボリュームまたはデータノードの EC2 インスタンスの最大許容制限を超えた場合に発生します。 インスタンスの IOPS については、「[Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html)」を参照してください。ボリュームの IOPS については、「[Amazon EBS volume types](https://aws.amazon.com/ebs/volume-types/)」を参照してください。 関連する統計: Minimum、Maximum |
| HighSwapUsage | 1 の値は、ページ障害によるスワップが、特定の期間中に基盤となるディスク使用量の急増を引き起こす可能性があることを示します。 関連する統計: Maximum |
## 専用マスターノードメトリクス
Amazon OpenSearch Service は、以下の[専用マスターノード](managedomains-dedicatedmasternodes.md)のメトリクスを提供します。
| メトリクス | 説明 |
| --- | --- |
| MasterCPUUtilization | 専用マスターノードが使用する CPU リソースの最大パーセンテージ。このメトリクスが 60 パーセントに達する場合、インスタンスタイプのサイズを増やすことをお勧めします。 関連する統計: Maximum |
| MasterFreeStorageSpace | このメトリクスは関係ないため無視できます。このサービスはデータノードとしてマスターノードを使用しません。 |
| MasterJVMMemoryPressure | クラスター内のすべての専用マスターノードで使用する Java ヒープの最大パーセンテージ。このメトリクスが 85 パーセントに達する場合、より大規模なインスタンスタイプに移行することをお勧めします。 関連する統計: Maximum このメトリクスのロジックは、サービスソフトウェア R20220323 で変更されました。詳細については、「[release notes](release-notes.md)」を参照してください。 |
| MasterOldGenJVMMemoryPressure | マスターノードごとの「旧世代」で使用される Java ヒープの最大パーセンテージ。 関連する統計: Maximum |
| MasterCPUCreditBalance | クラスター内の専用マスターノードで使用できる、残りの CPU クレジット。CPU クレジットは、フル CPU パフォーマンスを 1 分間実現します。詳細については、*Amazon EC2 デベロッパーガイド*の「[CPU クレジット](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-credits-baseline-concepts.html)」を参照してください。このメトリクスは、T2 のインスタンスタイプでのみ使用できます。 関連する統計: Minimum |
| MasterReachableFromNode | `MasterNotDiscovered` 例外のヘルスチェック。値 1 は正常な動作を示します。値 0 は、`/_cluster/health/` の動作が正常ではないことを示します。 障害が発生すると、ソースノードからマスターノードにアクセスすることができなくなります。通常、ネットワーク接続の問題や AWS 依存関係の問題が原因です。 関連する統計: Maximum |
| MasterSysMemoryUtilization | 使用中のマスターノードのメモリの割合。 関連する統計: Maximum |
## 専用コーディネーターノードメトリクス
Amazon OpenSearch Service は、以下の[専用コーディネーターノード](#managedomains-dedicated-coordinator-nodes)のメトリクスを提供します。
| メトリクス | 説明 |
| --- | --- |
| CoordinatorCPUUtilization | 専用コーディネーターノードが使用する CPU リソースの最大パーセンテージ。このメトリクスが 80 パーセントに達する場合、インスタンスタイプのサイズを増やすことをお勧めします。 関連する統計: Maximum |
| CoordinatorJVMMemoryPressure | クラスター内のすべての専用コーディネーターノードで使用する Java ヒープの最大パーセンテージ。このメトリクスが 85 パーセントに達する場合、より大規模なインスタンスタイプに移行することをお勧めします。 関連する統計: Maximum |
| CoordinatorOldGenJVMMemoryPressure | マスターノードごとの「旧世代」で使用される Java ヒープの最大パーセンテージ。 関連する統計: Maximum |
| CoordinatorSysMemoryUtilization | 使用中のコーディネーターノードのメモリの割合。 関連する統計: Maximum |
| CoordinatorFreeStorageSpace | このメトリクスは、サービスがコーディネーターノードをデータノードとして使用していないことを示します。 |
## EBS ボリュームメトリクス
Amazon OpenSearch Service は、以下の EBS ボリュームのメトリクスを提供します。
| メトリクス | 説明 |
| --- | --- |
| ReadLatency | EBS ボリュームでの読み取り操作のレイテンシー (秒単位)。このメトリクスは、個別のノードでも利用できます。 関連する統計情報: Minimum、Maximum、Average |
| WriteLatency | EBS ボリュームでの書き込み操作のレイテンシー (秒単位)。このメトリクスは、個別のノードでも利用できます。 関連する統計情報: Minimum、Maximum、Average |
| ReadThroughput | EBS ボリュームでの読み取り操作のスループット (バイト/秒単位)。このメトリクスは、個別のノードでも利用できます。 関連する統計情報: Minimum、Maximum、Average |
| ReadThroughputMicroBursting | [マイクロバースト](https://repost.aws/knowledge-center/ebs-identify-micro-bursting)を考慮に入れたときの、EBS ボリュームにおける読み取りオペレーションのスループット (バイト/秒)。このメトリクスは、個別のノードでも利用できます。マイクロバーストは、EBS ボリュームがきわめて短い時間 (1 分未満) に高い IOPS またはスループットをバーストするときに発生します。 関連する統計情報: Minimum、Maximum、Average |
| WriteThroughput | EBS ボリュームでの書き込み操作のスループット (バイト/秒単位)。このメトリクスは、個別のノードでも利用できます。 関連する統計情報: Minimum、Maximum、Average |
| WriteThroughputMicroBursting | [マイクロバースト](https://repost.aws/knowledge-center/ebs-identify-micro-bursting)を考慮に入れたときの、EBS ボリュームにおける書き込みオペレーションのスループット (バイト/秒)。このメトリクスは、個別のノードでも利用できます。マイクロバーストは、EBS ボリュームがきわめて短い時間 (1 分未満) に高い IOPS またはスループットをバーストするときに発生します。 関連する統計情報: Minimum、Maximum、Average |
| DiskQueueDepth | EBS ボリュームに対する保留中の入出力 (I/O) リクエストの数。 関連する統計情報: Minimum、Maximum、Average |
| ReadIOPS | EBS ボリュームでの読み取り操作の入出力 (I/O) 操作数 (1 秒あたり)。このメトリクスは、個別のノードでも利用できます。 関連する統計情報: Minimum、Maximum、Average |
| ReadIOPSMicroBursting | [マイクロバースト](https://repost.aws/knowledge-center/ebs-identify-micro-bursting)を考慮に入れたときの、EBS ボリュームでの読み取り操作の入出力 (I/O) 操作数 (1 秒あたり)。このメトリクスは、個別のノードでも利用できます。マイクロバーストは、EBS ボリュームがきわめて短い時間 (1 分未満) に高い IOPS またはスループットをバーストするときに発生します。 関連する統計情報: Minimum、Maximum、Average |
| WriteIOPS | EBS ボリュームでの書き込み操作の入出力 (I/O) 操作数 (1 秒あたり)。このメトリクスは、個別のノードでも利用できます。 関連する統計情報: Minimum、Maximum、Average |
| WriteIOPSMicroBursting | [マイクロバースト](https://repost.aws/knowledge-center/ebs-identify-micro-bursting)を考慮に入れたときの、EBS ボリュームでの書き込み操作の入出力 (I/O) 操作数 (1 秒あたり)。このメトリクスは、個別のノードでも利用できます。マイクロバーストは、EBS ボリュームがきわめて短い時間 (1 分未満) に高い IOPS またはスループットをバーストするときに発生します。 関連する統計情報: Minimum、Maximum、Average |
| BurstBalance | EBS ボリュームの、バーストバケットに残っている入出力 (I/O) クレジットの割合。値 100 は、ボリュームが最大クレジット数を累積したことを意味します。このパーセンテージが 70% を下回る場合は、「[低 EBS バーストバランス](handling-errors.md#handling-errors-low-ebs-burst)」を参照してください。gp3 ボリュームタイプを使用するドメインと、ボリュームサイズが 1,000 GiB を超える gp2 ボリュームを使用するドメインのバーストバランスは 0 のままになります。 関連する統計情報: Minimum、Maximum、Average |
| VolumeStalledIOcheck | 障害が発生した時期を判断するための EBS ボリュームのステータス。このメトリクスは、EBS ボリュームが入出力操作を完了できるかどうかに基づいて、0 (合格) または 1 (失敗) のステータスを返すバイナリ値です。`VolumeStalledIOcheck` は個々のノードでも使用できます。 関連する統計情報: Minimum、Maximum、Average |
## インスタンスメトリクス
Amazon OpenSearch Service は、以下のドメイン内の各インスタンスのメトリクスを提供します。また、OpenSearch Service では、これらのインスタンスメトリクスを集約することで、クラスター全体のヘルスへのインサイトを提供します。この動作を確認するには、コンソールで [**サンプル数**] 統計を使用します。以下のテーブルの各メトリクスには、ノード*と*クラスターに関連する統計を含みます。
**重要**
Elasticsearch のバージョンが異なる場合、`_index` API への呼び出しの処理にも異なるスレッドプールが使用されます。Elasticsearch 1.5 および 2.3 は、インデックス作成スレッドプールを使用します。Elasticsearch 5.*x*、6.0、および 6.2 はバルクスレッドプールを使用します。OpenSearch および Elasticsearch 6.3 以降では書き込みスレッドプールを使用します。現在、OpenSearch Service コンソールにはバルクスレッドプールのグラフは含まれていません。
`GET _cluster/settings?include_defaults=true` を使用して、クラスターのスレッドプールとキューサイズを確認します。
| メトリクス | 説明 |
| --- | --- |
| FetchLatency | ノード内のすべてのシャードフェッチ操作にかかった合計時間 (ミリ秒) の、N 分と (N - 1) 分の差。 関連するノードの統計: Average 関連するクラスターの統計: Average、Maximum |
| FetchRate | データノード上のすべてのシャードに対する 1 分あたりのシャードフェッチ操作の合計数。 関連するノードの統計: Average 関連するクラスターの統計: Average、Maximum、Sum |
| ScrollTotal | データノード上のすべてのシャードに対する 1 分あたりのシャードスクロール操作の合計数。 関連するノードの統計: Average、Maximum 関連するクラスターの統計: Average、Maximum、Sum |
| ScrollCurrent | 現在実行中のシャードスクロールオペレーションの数。 関連するノードの統計: Average、Maximum 関連するクラスターの統計: Average、Maximum、Sum |
| OpenContexts | オープン検索コンテキストの数。 関連するノードの統計: Average、Maximum 関連するクラスターの統計: Average、Maximum、Sum |
| ThreadCount | OpenSearch プロセスで現在使用されているスレッドの合計数。 関連するノードの統計: Average、Maximum 関連するクラスターの統計: Average、Maximum、Sum |
| ShardReactivateCount | すべてのシャードがアイドル状態からアクティブ化された合計回数。 関連するノードの統計: Sum、Maximum 関連するクラスターの統計: Sum、Maximum |
| ConcurrentSearchRate | データノードのすべてのシャードに対する 1 分あたりの同時セグメント検索を使用した検索リクエストの総数。`_search` API への 1 回の呼び出しに対して、さまざまなシャードから結果が返される可能性があります。これらのシャードのうちの 5 つが 1 つのノードにある場合、クライアントが 1 つのリクエストしか行っていない場合でも、ノードはこのメトリクスについて 5 を報告します。 関連するノードの統計: Average 関連するクラスターの統計: Average、Maximum、Sum |
| ConcurrentSearchLatency | ノード内で同時セグメント検索を使用したすべての検索にかかった合計時間 (ミリ秒) の、N 分と (N-1) 分の差。 関連するノードの統計: Average 関連するクラスターの統計: Average、Maximum |
| IndexingLatency | ノード内のすべてのインデックス作成オペレーションにかかった合計時間 (ミリ秒) の、N 分と (N-1) 分の差。 関連するノードの統計: Average 関連するクラスターの統計: Average、Maximum |
| IndexingRate | 1 分あたりのインデックス作成オペレーションの数。2 つのドキュメントを追加し、2 つのカウントを 4 つのオペレーションとして更新する `_bulk` API への 1 回の呼び出し。これは 1 つ以上のノードに分散する可能性があります。そのインデックスに 1 つ以上のレプリカがあり、[最適化インスタンス](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/or1.html)が使用されない OpenSearch ドメインにある場合、クラスター内の他のノードにも合計 4 つのインデックス作成オペレーションが記録されます。インスタンスが最適化された OpenSearch ドメインの場合、レプリカを持つ他のノードはオペレーションを記録しません。ドキュメントの削除はこのメトリクスに対してカウントされません。 関連するノードの統計: Average 関連するクラスターの統計: Average、Maximum、Sum |
| SearchLatency | ノード内のすべての検索にかかった合計時間 (ミリ秒) の、N 分と (N-1) 分の差。 関連するノードの統計: Average 関連するクラスターの統計: Average、Maximum |
| SearchRate | データノードのすべてのシャードに対する 1 分あたりの検索リクエストの総数。`_search` API への 1 回の呼び出しに対して、さまざまなシャードから結果が返される可能性があります。これらのシャードのうちの 5 つが 1 つのノードにある場合、クライアントが 1 つのリクエストしか行っていない場合でも、ノードはこのメトリクスについて 5 を報告します。 関連するノードの統計: Average 関連するクラスターの統計: Average、Maximum、Sum |
| SegmentCount | データノードでのセグメントの数。セグメントの数が多いほど、各検索にかかる時間が長くなります。OpenSearch では、小さなセグメントを大きなセグメントにマージすることがあります。 関連するノードの統計: Maximum、Average 関連するクラスターの統計: Sum、Maximum、Average |
| SysMemoryUtilization | インスタンスが使用中のメモリの割合。このメトリクスの高い値は正常であり、通常はクラスターに問題はありません。潜在的なパフォーマンスおよび安定性の問題の指標については、「`JVMMemoryPressure` メトリクス」を参照してください。 関連するノードの統計: Minimum、Maximum、Average 関連するクラスターの統計: Minimum、Maximum、Average |
| JVMGCYoungCollectionCount | 「新世代」ガベージコレクションが実行された回数。実行数が大量になり、かつ増え続けることは、通常のクラスター操作の一部です。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum、Maximum、Average |
| JVMGCYoungCollectionTime | クラスターで「新世代」ガベージコレクションの実行にかかった時間 (ミリ秒)。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum、Maximum、Average |
| JVMGCOldCollectionCount | 「旧世代」ガベージコレクションが実行された回数。十分なリソースがあるクラスターでは、この回数は少ないままですが、まれに増加します。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum、Maximum、Average |
| JVMGCOldCollectionTime | クラスターで「旧世代」ガベージコレクションの実行にかかった時間 (ミリ秒)。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum、Maximum、Average |
| OpenSearchDashboardsConcurrentConnections | OpenSearch Dashboards へのアクティブな同時接続の数。この数が一貫して増加する場合は、クラスターのスケーリングを検討してください。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum、Maximum、Average |
| OpenSearchDashboardsHealthyNode | 個別の OpenSearch Dashboards ノードのヘルスチェック。値 1 は正常な動作を示します。値 0 は Dashboards がアクセス不可であることを示します。 関連するノードの統計: Minimum 関連するクラスターの統計: Minimum、Maximum、Average |
| OpenSearchDashboardsHeapTotal | OpenSearch Dashboards に割り当てられたヒープメモリの容量 (MiB)。EC2 インスタンスタイプが異なると、正確なメモリ割り当てに影響する可能性があります。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum、Maximum、Average |
| OpenSearchDashboardsHeapUsed | OpenSearch Dashboards で使用されるヒープメモリの絶対容量 (MiB)。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum、Maximum、Average |
| OpenSearchDashboardsHeapUtilization | OpenSearch Dashboards で使用される使用可能なヒープメモリの最大パーセンテージ。この値が 80% を超えて増加する場合は、クラスターのスケーリングを検討してください。 関連するノードの統計: Maximum 関連するクラスターの統計: Minimum、Maximum、Average |
| OpenSearchDashboardsOS1MinuteLoad | OpenSearch Dashboards の 1 分の CPU ロードの平均。CPU ロードは、理想的には 1.00 未満にとどまるはずです。一時的なスパイクは問題ありませんが、このメトリクスが一貫して 1.00 を超える場合は、インスタンスタイプのサイズを増やすことをお勧めします。 関連するノードの統計: Average 関連するクラスターの統計: Average、Maximum |
| OpenSearchDashboardsRequestTotal | OpenSearch Dashboards に対して行われた HTTP リクエストの合計数。システムの速度が遅い、または Dashboards リクエストの数が多い場合は、インスタンスタイプのサイズを増やすことを検討してください。 関連するノードの統計: Sum 関連するクラスターの統計: Sum |
| OpenSearchDashboardsResponseTimesMaxInMillis | OpenSearch Dashboards がリクエストに応答するのに必要な最大時間 (ミリ秒)。リクエストで結果が返ってくるために一貫して時間がかかる場合は、インスタンスタイプのサイズを増やすことを検討してください。 関連するノードの統計: Maximum 関連するクラスターの統計: Maximum、Average |
| SearchTaskCancelled | コーディネーターノードのキャンセル数。 関連するノードの統計: Sum 関連するクラスターの統計: Sum |
| SearchShardTaskCancelled | データノードのキャンセル数。 関連するノードの統計: Sum 関連するクラスターの統計: Sum、 |
| ThreadpoolForce\$1mergeQueue | 強制マージスレッドプールでキューに入っているタスクの数。キューのサイズが一貫して大きい場合は、クラスターのスケーリングを検討してください。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum、Maximum、Average |
| ThreadpoolForce\$1mergeRejected | 強制マージスレッドプールで拒否されたタスクの数。この数が増え続ける場合は、クラスターのスケーリングを検討してください。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum |
| ThreadpoolForce\$1mergeThreads | 強制マージスレッドプールのサイズ。 関連するノードの統計: Maximum 関連するクラスターの統計: Average、Sum |
| ThreadpoolIndexQueue | インデックス作成スレッドプールでキューに入っているタスクの数。キューのサイズが一貫して大きい場合は、クラスターのスケーリングを検討してください。インデックスキューの最大サイズは 200 です。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum、Maximum、Average |
| ThreadpoolIndexRejected | インデックス作成スレッドプールで拒否されたタスクの数。この数が増え続ける場合は、クラスターのスケーリングを検討してください。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum |
| ThreadpoolIndexThreads | インデックス作成スレッドプールのサイズ。 関連するノードの統計: Maximum 関連するクラスターの統計: Average、Sum |
| ThreadpoolSearchQueue | 検索スレッドプールでキューに入っているタスクの数。キューのサイズが一貫して大きい場合は、クラスターのスケーリングを検討してください。検索キューの最大サイズは 1,000 です。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum、Maximum、Average |
| ThreadpoolSearchRejected | 検索スレッドプールで拒否されたタスクの数。この数が増え続ける場合は、クラスターのスケーリングを検討してください。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum |
| ThreadpoolSearchThreads | 検索スレッドプールのサイズ。 関連するノードの統計: Maximum 関連するクラスターの統計: Average、Sum |
| Threadpoolsql-workerQueue | SQL 検索スレッドプールでキューに入っているタスクの数。キューのサイズが一貫して大きい場合は、クラスターのスケーリングを検討してください。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum、Maximum、Average |
| Threadpoolsql-workerRejected | SQL 検索スレッドプールで拒否されたタスクの数。この数が増え続ける場合は、クラスターのスケーリングを検討してください。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum |
| Threadpoolsql-workerThreads | SQL 検索スレッドプールのサイズ。 関連するノードの統計: Maximum 関連するクラスターの統計: Average、Sum |
| ThreadpoolBulkQueue | バルクスレッドプールでキューに入っているタスクの数。キューのサイズが一貫して大きい場合は、クラスターのスケーリングを検討してください。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum、Maximum、Average |
| ThreadpoolBulkRejected | バルクスレッドプールで拒否されたタスクの数。この数が増え続ける場合は、クラスターのスケーリングを検討してください。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum |
| ThreadpoolBulkThreads | バルクスレッドプールのサイズ。 関連するノードの統計: Maximum 関連するクラスターの統計: Average、Sum |
| ThreadpoolIndexSearcherQueue | インデックス検索スレッドプールでキューに入っているタスクの数。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum、Maximum、Average |
| ThreadpoolIndexSearcherRejected | インデックス検索スレッドプールで拒否されたタスクの数。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum |
| ThreadpoolIndexSearcherThreads | インデックス検索スレッドプールのサイズ。 関連するノードの統計: Maximum 関連するクラスターの統計: Average、Sum |
| ThreadpoolWriteThreads | 書き込みスレッドプールのサイズ。 関連するノードの統計: Maximum 関連するクラスターの統計: Average、Sum |
| ThreadpoolWriteQueue | 書き込みスレッドプールでキューに入っているタスクの数。 関連するノードの統計: Maximum 関連するクラスターの統計: Average、Sum |
| ThreadpoolWriteRejected | 書き込みスレッドプールで拒否されたタスクの数。 関連するノードの統計: Maximum 関連するクラスターの統計: Average、Sum バージョン 7.1 では、デフォルトの書き込みキューのサイズが 200 から 10000 に増加したため、このメトリクスは OpenSearch Service からの拒否の唯一の指標ではなくなりました。`CoordinatingWriteRejected`、`PrimaryWriteRejected`、および `ReplicaWriteRejected` メトリクスを使用して、バージョン 7.1 以降での拒否をモニタリングします。 |
| CoordinatingWriteRejected | 最後の OpenSearch Service プロセスのスタートアップ以降のインデックス作成のプレッシャーにより調整ノードで発生した拒否の総数。 関連するノードの統計: Maximum 関連するクラスターの統計: Average、Sum このメトリクスは、バージョン 7.1 以降で使用できます。 |
| PrimaryWriteRejected | 最後の OpenSearch Service プロセスのスタートアップ以降のインデックス作成のプレッシャーによりプライマリシャードで発生した拒否の総数。 関連するノードの統計: Maximum 関連するクラスターの統計: Average、Sum このメトリクスは、バージョン 7.1 以降で使用できます。 |
| ReplicaWriteRejected | 最後の OpenSearch Service プロセスのスタートアップ以降のインデックス作成のプレッシャーによりレプリカシャードで発生した拒否の合計数。 関連するノードの統計: Maximum 関連するクラスターの統計: Average、Sum このメトリクスは、バージョン 7.1 以降で使用できます。 |
| WorkloadManagementEnabled | ワークロード管理機能が有効になっているかどうかを示します。値 1 は有効、値 0 は `monitor_only` または無効を意味します。 関連するノードの統計: Maximum、Minimum 関連するクラスターの統計: Average、Sum このメトリクスは、バージョン 7.1 以降で使用できます。 |
| SoftQueryGroupCount | ドメインでソフトモードになっているクエリグループの数。 関連するノードの統計: Average、Maximum 関連するクラスターの統計: Average、Maximum、Sum このメトリクスは、バージョン 7.1 以降で使用できます。 |
| EnforcedQueryGroupCount | ドメインで強制モードになっているクエリグループの数。 関連するノードの統計: Average、Maximum 関連するクラスターの統計: Average、Maximum、Sum このメトリクスは、バージョン 7.1 以降で使用できます。 |
## ウォームメトリクス
Amazon OpenSearch Service は、[多層ストレージアーキテクチャ](multi-tier-storage.html)と [UltraWarm](ultrawarm.html) に次のメトリクスを提供します。
**注記**
ウォームインデックス作成関連のメトリクスは、多層ストレージアーキテクチャにのみ適用されます。
| メトリクス | 説明 |
| --- | --- |
| WarmIndexingLatency | N 分から 1 分 (N-1) の間のウォームノードのすべてのインデックス作成オペレーションによって取得された合計時間のミリ秒単位の差。 関連するノードの統計: Average 関連するクラスターの統計: Average、Maximum |
| WarmIndexingRate | 1 分あたりのウォームに対するインデックス作成オペレーションの数。2 つのドキュメントを追加し、2 つのカウントを 4 つのオペレーションとして更新する `_bulk` API への 1 回の呼び出し。これは 1 つ以上のノードに分散する可能性があります。そのインデックスに 1 つ以上のレプリカがあり、[最適化インスタンス](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/or1.html)が使用されない OpenSearch ドメインにある場合、クラスター内の他のノードにも合計 4 つのインデックス作成オペレーションが記録されます。インスタンスが最適化された OpenSearch ドメインの場合、レプリカを持つ他のノードはオペレーションを記録しません。ドキュメントの削除はこのメトリクスに対してカウントされません。 関連するノードの統計: Average 関連するクラスターの統計: Average、Maximum、Sum |
| WarmThreadpoolIndexingQueue | インデックス作成スレッドプールでキューに入っているタスクの数。キューのサイズが一貫して大きい場合は、クラスターのスケーリングを検討してください。インデックスキューの最大サイズは 200 です。 関連するノードの統計: Maximum 関連するクラスターの統計: Average、Maximum、Sum |
| WarmThreadpoolIndexingRejected | インデックス作成スレッドプールで拒否されたタスクの数。この数が増え続ける場合は、クラスターのスケーリングを検討してください。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum |
| WarmThreadpoolIndexingThreads | インデックス作成スレッドプールのサイズ。 関連するノードの統計: Maximum 関連するクラスターの統計: Average、Sum |
| WarmCPUUtilization | クラスター内のウォームノードの CPU 使用率。Maximum は、CPU 使用率が最も高いノードを示します。Average は、クラスター内のすべてのウォームノードを表します。このメトリクスは、個々のウォームノードでも使用できます。 関連する統計: Maximum、Average |
| WarmFreeStorageSpace | ウォームストレージの空き容量 (MiB)。Warm はアタッチされたディスクではなく Amazon S3 を使用するため、関連する統計`Sum`は のみです。正確な値を取得するには、期間を 1 分のままにしておく必要があります。 関連する統計情報: Sum |
| WarmSearchableDocuments | クラスター内のすべてのウォームインデックスで検索可能なドキュメントの合計数。正確な値を取得するには、期間を 1 分のままにしておく必要があります。 関連する統計情報: Sum |
| WarmSearchLatency | ウォームでの N 分から 1 分 (N-1) までのすべての検索で取得された合計時間のミリ秒単位の差。 関連するノードの統計: Average 関連するクラスターの統計: Average、Maximum |
| WarmSearchRate | Warm ノード上のすべてのシャードに対する 1 分あたりの検索リクエストの合計数。`_search` API への 1 回の呼び出しに対して、さまざまなシャードから結果が返される可能性があります。これらのシャードのうちの 5 つが 1 つのノードにある場合、クライアントが 1 つのリクエストしか行っていない場合でも、ノードはこのメトリクスについて 5 を報告します。 関連するノードの統計: Average 関連するクラスターの統計: Average、Maximum、Sum |
| WarmStorageSpaceUtilization | クラスターで使用中のウォームストレージスペースの合計容量 (MiB)。 関連する統計: Maximum |
| HotStorageSpaceUtilization | クラスターで使用しているホットストレージの合計容量。 関連する統計: Maximum |
| WarmSysMemoryUtilization | 使用中のウォームノードのメモリの割合。 関連する統計: Maximum |
| HotToWarmMigrationQueueSize | 現在、ホットストレージからウォームトストレージへの移行を待機しているインデックスの数。 関連する統計: Maximum |
| WarmToHotMigrationQueueSize | 現在、ウォームストレージからホットストレージへの移行を待機しているインデックスの数。 関連する統計: Maximum |
| HotToWarmMigrationFailureCount | 失敗したホットからウォームへの移行の合計数。このメトリクスは UltraWarm ノードでのみ使用できます。 関連する統計情報: Sum |
| HotToWarmMigrationForceMergeLatency | 移行プロセスの強制マージステージの平均レイテンシー。このステージに一貫して時間がかかりすぎる場合は、 を増やすことを検討してください。このメトリクスは UltraWarm ノードでのみ使用できます。 `index.ultrawarm.migration.force_merge.max_num_segments` 関連する統計: Average |
| HotToWarmMigrationSnapshotLatency | 移行プロセスのスナップショットステージの平均レイテンシー。この段階が一貫して時間がかかりすぎる場合は、シャードが適切にサイズ設定され、クラスター全体に分散されていることを確認します。このメトリクスは UltraWarm ノードでのみ使用できます。 関連する統計: Average |
| HotToWarmMigrationProcessingLatency | ホットからウォームへの移行が成功した場合の平均レイテンシーで、キューに費やした時間を*含まない*。この値は、移行プロセスの強制マージ、スナップショット、およびシャード再配置ステージを完了するのにかかる時間の合計です。このメトリクスは UltraWarm ノードでのみ使用できます。 関連する統計: Average |
| HotToWarmMigrationSuccessCount | ホットからウォームへの移行に成功した合計数。 関連する統計情報: Sum |
| HotToWarmMigrationSuccessLatency | ホットからウォームへの移行が成功した場合の平均レイテンシーで、キューに費やされた時間を含む。 関連する統計: Average |
| WarmThreadpoolSearchThreads | ウォーム検索スレッドプールのサイズ。 関連するノードの統計: Maximum 関連するクラスターの統計: Average、Sum |
| WarmThreadpoolSearchRejected | ウォーム検索スレッドプールで拒否されたタスクの数。この数が継続的に増加する場合は、ウォームノードを追加することを検討してください。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum |
| WarmThreadpoolSearchQueue | ウォーム検索スレッドプール内のキューに入れられたタスクの数。キューサイズが一貫して大きい場合は、ウォームノードを追加することを検討してください。関連するノードの統計: Maximum関連するクラスターの統計: Sum、Maximum、Average |
| WarmJVMMemoryPressure | ウォームノードに使用される Java ヒープの最大パーセンテージ。 関連する統計: Maximum このメトリクスのロジックは、サービスソフトウェア R20220323 で変更されました。詳細については、「[release notes](release-notes.md)」を参照してください。 |
| WarmOldGenJVMMemoryPressure | ウォームノードあたりの「旧世代」に使用される Java ヒープの最大パーセンテージ。 関連する統計: Maximum |
| WarmJVMGCYoungCollectionCount | 「低世代」ガベージコレクションがウォームノードで実行された回数。実行数が大量になり、かつ増え続けることは、通常のクラスター操作の一部です。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum、Maximum、Average |
| WarmJVMGCYoungCollectionTime | クラスターがウォームノードで「低生成」ガベージコレクションの実行に費やしたミリ秒単位の時間。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum、Maximum、Average |
| WarmJVMGCOldCollectionCount | 「旧世代」ガベージコレクションがウォームノードで実行された回数。十分なリソースがあるクラスターでは、この回数は少ないままですが、まれに増加します。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum、Maximum、Average |
| WarmConcurrentSearchRate | Warm ノード上のすべてのシャードに対する 1 分あたりの同時セグメント検索を使用した検索リクエストの合計数。`_search` API への 1 回の呼び出しに対して、さまざまなシャードから結果が返される可能性があります。これらのシャードのうちの 5 つが 1 つのノードにある場合、クライアントが 1 つのリクエストしか行っていない場合でも、ノードはこのメトリクスについて 5 を報告します。 関連するノードの統計: Average 関連するクラスターの統計: Sum、Maximum、Average |
| WarmConcurrentSearchLatency | ウォームノードでの同時セグメント検索を使用したすべての検索で、分 N から分 (N-1) までの合計時間の差をミリ秒単位で表します。 関連するノードの統計: Average 関連するクラスターの統計: Maximum、Average |
| WarmThreadpoolIndexSearcherQueue | ウォームインデックス検索スレッドプール内のキューに入れられたタスクの数。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum、Maximum、Average |
| WarmThreadpoolIndexSearcherRejected | ウォームインデックス検索スレッドプールで拒否されたタスクの数。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum |
| WarmThreadpoolIndexSearcherThreads | ウォームインデックス検索スレッドプールのサイズ。 関連するノードの統計: Maximum 関連するクラスターの統計: Sum、Average |
## コールドストレージのメトリクス
Amazon OpenSearch Service は、以下の[コールドストレージ](cold-storage.md)のメトリクスを提供します。
| メトリクス | 説明 |
| --- | --- |
| ColdStorageSpaceUtilization | クラスターで使用しているコールドストレージの合計容量 (MiB)。 関連する統計情報: Max |
| ColdToWarmMigrationFailureCount | コールドからウォームへの移行に失敗した移行の合計数。 関連する統計情報: Sum |
| ColdToWarmMigrationLatency | コールドからウォームへの移行が正常に完了するまでの時間。 関連する統計: Average |
| ColdToWarmMigrationQueueSize | 現在、コールドストレージからウォームストレージへの移行を待機しているインデックスの数。 関連する統計: Maximum |
| ColdToWarmMigrationSuccessCount | コールドからウォームへの移行に成功した合計数。 関連する統計情報: Sum |
| WarmToColdMigrationFailureCount | ウォームからコールドへの移行に失敗した合計数。 関連する統計情報: Sum |
| WarmToColdMigrationLatency | ウォームからコールドへの移行が正常に完了するまでの時間。 関連する統計: Average |
| WarmToColdMigrationQueueSize | 現在、ウォームストレージからコールドストレージへの移行を待機しているインデックスの数。 関連する統計: Maximum |
| WarmToColdMigrationSuccessCount | ウォームからコールドへの移行に成功した合計数。 関連する統計情報: Sum |
## OpenSearch Optimized インスタンス (OR1) メトリクス
Amazon OpenSearch Service は、[OR1 インスタンス](or1.md)について次のメトリクスを提供します。
| メトリクス | 説明 |
| --- | --- |
| RemoteStorageUsedSpace | クラスターで使用中の Amazon S3 スペースの合計容量 (MiB)。 関連する統計情報: Sum |
| RemoteStorageWriteRejected | リモートストレージとレプリケーションの負荷により、プライマリシャードで拒否されたリクエストの総数。これは、OpenSearch Service のプロセスの最後の起動を起点として計算されます。 関連する統計情報: Sum |
| ReplicationLagMaxTime | レプリカシャードがプライマリシャードの背後にある時間 (ミリ秒) 関連する統計: Maximum |
## アラートメトリクス
Amazon OpenSearch Service は、以下の[アラート](alerting.md)のメトリクスを提供します。
| メトリクス | 説明 |
| --- | --- |
| AlertingDegraded | 値 1 は、アラートインデックスが赤であるか、1 つ以上のノードがスケジュールどおりでないことを意味します。値 0 は正常な動作を示します。 関連する統計: Maximum |
| AlertingIndexExists | 値 1 は、`.opensearch-alerting-config` インデックスが存在することを意味します。値 0 は、そのインデックスが存在しないことを意味します。アラート機能を初めて使用するまで、この値は 0 のままです。 関連する統計: Maximum |
| AlertingIndexStatus.green | インデックスのヘルス。値 1 は、緑を意味します。値 0 は、インデックスが存在しないか、緑ではないことを意味します。 関連する統計: Maximum |
| AlertingIndexStatus.red | インデックスのヘルス。値 1 は、赤を意味します。値 0 は、インデックスが存在しないか、赤でないことを意味します。 関連する統計: Maximum |
| AlertingIndexStatus.yellow | インデックスのヘルス。値 1 は、黄色を意味します。値 0 は、インデックスが存在しないか、黄色でないことを意味します。 関連する統計: Maximum |
| AlertingNodesNotOnSchedule | 値 1 は、一部のジョブがスケジュールどおりに実行されていないことを意味します。値 0 は、すべてのアラートジョブがスケジュールどおりに実行されていることを意味します (またはアラートジョブが存在しないことを意味します)。OpenSearch Service コンソールを確認するか、`_nodes/stats` リクエストを行って、リソースの使用率が高いノードがあるかどうかを確認します。 関連する統計: Maximum |
| AlertingNodesOnSchedule | 値 1 は、すべてのアラートジョブがスケジュールどおりに実行されていることを意味します (またはアラートジョブが存在しないことを意味します)。値 0 は、一部のジョブがスケジュールどおりに実行されていないことを意味します。 関連する統計: Maximum |
| AlertingScheduledJobEnabled | 値 1 は、`opensearch.scheduled_jobs.enabled` クラスター設定が true であることを意味します。値 0 は、その設定が false であり、スケジュールされたジョブが無効であることを意味します。 関連する統計: Maximum |
## 異常検出のメトリクス
Amazon OpenSearch Service は、以下の[異常検出](ad.md)のメトリクスを提供します。
| メトリクス | 説明 |
| --- | --- |
| ADPluginUnhealthy | 値 1 は、異常検出プラグインが正しく動作していないことを意味します。これは、障害の数が多いか、使用しているインデックスの 1 つが赤の状態であるためです。値 0 は、プラグインが想定どおりに動作していることを示します。 関連する統計: Maximum |
| ADExecuteRequestCount | 異常検出のリクエストの数。 関連する統計情報: Sum |
| ADExecuteFailureCount | 異常検出に失敗したリクエストの数。 関連する統計情報: Sum |
| ADHCExecuteFailureCount | 高基数ディテクターの異常検出に失敗したリクエストの数。 関連する統計情報: Sum |
| ADHCExecuteRequestCount | 高基数ディテクターの異常検出のリクエストの数。 関連する統計情報: Sum |
| ADAnomalyResultsIndexStatusIndexExists | 値 1 は、`.opensearch-anomaly-results` エイリアスが指すインデックスが存在することを意味します。異常検出を初めて使用するまで、この値は 0 のままです。 関連する統計: Maximum |
| ADAnomalyResultsIndexStatus.red | 値 1 は、 `.opensearch-anomaly-results` エイリアスが指すインデックスが赤の状態であることを意味します。値 0 は、そうでないことを意味します。異常検出を初めて使用するまで、この値は 0 のままです。 関連する統計: Maximum |
| ADAnomalyDetectorsIndexStatusIndexExists | 値 1 は、`.opensearch-anomaly-detectors` インデックスが存在することを意味します。値 0 は、そのインデックスが存在しないことを意味します。異常検出を初めて使用するまで、この値は 0 のままです。 関連する統計: Maximum |
| ADAnomalyDetectorsIndexStatus.red | 値 1 は、`.opensearch-anomaly-detectors` インデックスが赤の状態であることを意味します。値 0 は、そうでないことを意味します。異常検出を初めて使用するまで、この値は 0 のままです。 関連する統計: Maximum |
| ADModelsCheckpointIndexStatusIndexExists | 値 1 は、`.opensearch-anomaly-checkpoints` インデックスが存在することを意味します。値 0 は、そのインデックスが存在しないことを意味します。異常検出を初めて使用するまで、この値は 0 のままです。 関連する統計: Maximum |
| ADModelsCheckpointIndexStatus.red | 値 1 は、`.opensearch-anomaly-checkpoints` インデックスが赤の状態であることを意味します。値 0 は、そうでないことを意味します。異常検出を初めて使用するまで、この値は 0 のままです。 関連する統計: Maximum |
## 非同期検索メトリクス
Amazon OpenSearch Service は、以下の[非同期検索](asynchronous-search.md)のメトリクスを提供します。
**非同期検索コーディネーターノードの統計 (コーディネーターノードあたり)**
| メトリクス | 説明 |
| --- | --- |
| AsynchronousSearchSubmissionRate | 過去 1 分間に送信された非同期検索の数。 |
| AsynchronousSearchInitializedRate | 過去 1 分間に初期化された非同期検索の数。 |
| AsynchronousSearchRunningCurrent | 現在実行中の非同期検索の数。 |
| AsynchronousSearchCompletionRate | 過去 1 分間に正常に完了した非同期検索の数。 |
| AsynchronousSearchFailureRate | 過去 1 分間に完了し、失敗した非同期検索の数。 |
| AsynchronousSearchPersistRate | 過去 1 分間に持続した非同期検索の数。 |
| AsynchronousSearchPersistFailedRate | 過去 1 分間に持続できなかった非同期検索の数。 |
| AsynchronousSearchRejected | ノードの稼働時間以降に拒否された非同期検索の合計数。 |
| AsynchronousSearchCancelled | ノードの稼働時間以降にキャンセルされた非同期検索の合計数。 |
| AsynchronousSearchMaxRunningTime | 過去 1 分間にノードで実行されている非同期検索の最長時間。 |
**非同期検索クラスター統計**
| メトリクス | 説明 |
| --- | --- |
| AsynchronousSearchStoreHealth | 過去 1 分間に持続したインデックス (赤/赤以外) 内のストアのヘルス。 |
| AsynchronousSearchStoreSize | 過去 1 分間のすべてのシャードのシステムインデックスのサイズ。 |
| AsynchronousSearchStoredResponseCount | 過去 1 分間にシステムインデックスに保存されたレスポンスの数。 |
## Auto-Tune メトリクス
Amazon OpenSearch Service は、[Auto-Tune](auto-tune.md) に以下のメトリクスを提供します。
| メトリクス | 説明 |
| --- | --- |
| AutoTuneChangesHistoryHeapSize | ヒープサイズチューニング値の MiB 単位の変更履歴。 |
| AutoTuneChangesHistoryJVMYoungGenArgs | JVM YongGen 引数の変更履歴。 |
| AutoTuneFailed | Auto-Tune の変更が失敗したかどうかを示すブール値。 |
| AutoTuneSucceeded | Auto-Tune の変更が成功したかどうかを示すブール値。 |
| AutoTuneValue | 中断を伴わない変更のキュー変更履歴 (カウント) とキャッシュチューニング変更履歴 (MiB 単位)。 |
## Multi-AZ with Standby メトリクス
Amazon OpenSearch Service は、[Multi-AZ with Standby](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html#managedomains-za-no-standby) で次のメトリクスを提供します。
**アクティブなアベイラビリティーゾーンにおけるデータノードのノードレベルメトリクス**
| メトリクス | 説明 |
| --- | --- |
| CPUUtilization | クラスター内のデータノードの CPU 使用率の割合。Maximum は、CPU 使用率が最も高いノードを示します。Average は、クラスター内のすべてのノードを表します。このメトリクスは、個別のノードでも利用できます。 |
| FreeStorageSpace | クラスター内のデータノードの空き領域。`Sum` はクラスターの合計空き容量を示しますが、正確な値を得るには期間を 1 分にする必要があります。`Minimum` と `Maximum` は、それぞれ空き領域が最も少ないノードと最も多いノードを示します。このメトリクスは、個別のノードでも利用できます。OpenSearch Service は、このメトリクスが `0` に達したときに `ClusterBlockException` をスローします。復旧するには、インデックスを削除する、より大きなインスタンスを追加する、既存のインスタンスに EBS ベースのストレージを追加する、のいずれかを実行する必要があります。詳細については[使用可能なストレージ領域の不足](handling-errors.md#handling-errors-watermark)を参照してください。 OpenSearch Service コンソールには、この値が GiB 単位で表示されます。Amazon CloudWatch コンソールには、この値が MiB 単位で表示されます。 |
| JVMMemoryPressure | クラスター内のすべてのデータノードで使用する Java ヒープの最大パーセンテージ。OpenSearch Service は、インスタンスの RAM の半分を Java ヒープ (32 GiB のヒープサイズまで) に使用します。インスタンスは最大 64 GiB の RAM まで垂直スケーリングでき、それ以上はインスタンスを追加することで水平方向にスケーリングできます。「[Amazon OpenSearch Service で推奨される CloudWatch アラーム](cloudwatch-alarms.md)」を参照してください。 |
| SysMemoryUtilization | インスタンスが使用中のメモリの割合。このメトリクスの高い値は正常であり、通常はクラスターに問題はありません。潜在的なパフォーマンスおよび安定性の問題の指標については、「JVMMemoryPressure メトリクス」を参照してください。 |
| IndexingLatency | ノード内のすべてのインデックス作成オペレーションにかかった合計時間 (ミリ秒) の、N 分と (N-1) 分の差。 |
| IndexingRate | 1 分あたりのインデックス作成オペレーションの数。 |
| SearchLatency | ノード内のすべての検索にかかった合計時間 (ミリ秒) の、N 分と (N-1) 分の差。 |
| SearchRate | データノードのすべてのシャードに対する 1 分あたりの検索リクエストの総数。 |
| ThreadpoolSearchQueue | 検索スレッドプールでキューに入っているタスクの数。キューのサイズが一貫して大きい場合は、クラスターのスケーリングを検討してください。検索キューの最大サイズは 1,000 です。 |
| ThreadpoolWriteQueue | 書き込みスレッドプールでキューに入っているタスクの数。 |
| ThreadpoolSearchRejected | 検索スレッドプールで拒否されたタスクの数。この数が増え続ける場合は、クラスターのスケーリングを検討してください。 |
| ThreadpoolWriteRejected | 書き込みスレッドプールで拒否されたタスクの数。 |
**アクティブなアベイラビリティーゾーンにおけるクラスターのクラスターレベルメトリクス**
| メトリクス | 説明 |
| --- | --- |
| DataNodes | アクティブシャードとスタンバイシャードの合計数。 |
| DataNodesShards.active | アクティブなプライマリとレプリカの両方のシャードの合計数。 |
| DataNodesShards.unassigned | クラスターのノードに割り当てられていないシャードの数。 |
| DataNodesShards.initializing | 初期化中のシャードの数。 |
| DataNodesShards.relocating | 再配置中のシャードの数。 |
**アベイラビリティーゾーンのローテーションメトリクス**
`ActiveReads.Availability-Zone = 1` の場合、ゾーンはアクティブです。`ActiveReads.Availability-Zone = 0` の場合、ゾーンはスタンバイ状態です。
## ポイントインタイムメトリクス
Amazon OpenSearch Service は、[ポイントインタイム](pit.md) (PIT) 検索で次のメトリクスを提供します。
**PIT コーディネーターノードの統計 (コーディネーターノードあたり)**
| メトリクス | 説明 |
| --- | --- |
| CurrentPointInTime | ノード内のアクティブな PIT 検索コンテキストの数。 |
| TotalPointInTime | ノードのアップタイム以降の、期限切れの PIT 検索コンテキストの数。 |
| AvgPointInTimeAliveTime | ノードのアップタイム以降の、PIT 検索コンテキストの平均キープアライブ数。 |
| HasActivePointInTime | 値が 1 の場合、アクティブな PIT コンテキストがノードのアップタイム以降に存在していることを示します。値が 0 の場合は存在していません。 |
| HasUsedPointInTime | 値が 1 の場合、期限切れの PIT コンテキストがノードのアップタイム以降に存在していることを示します。値が 0 の場合は存在していません。 |
## SQL メトリクス
Amazon OpenSearch Service は、以下の [SQL サポート](sql-support.md)のメトリクスを提供します。
| メトリクス | 説明 |
| --- | --- |
| SQLFailedRequestCountByCusErr | クライアントの問題により失敗した `_sql` API へのリクエストの数。例えば、`IndexNotFoundException` により、リクエストが HTTP ステータスコード 400 を返す場合があります。 関連する統計情報: Sum |
| SQLFailedRequestCountBySysErr | サーバーの問題または機能の制限により失敗した `_sql` API へのリクエストの数。例えば、`VerificationException` により、リクエストが HTTP ステータスコード 503 を返す場合があります。 関連する統計情報: Sum |
| SQLRequestCount | `_sql` API へのリクエストの数。 関連する統計情報: Sum |
| SQLDefaultCursorRequestCount | `SQLRequestCount` に似ていますが、測定対象はページネーションのリクエストのみです。 関連する統計情報: Sum |
| SQLUnhealthy | 値 1 は、特定のリクエストへのレスポンスで、SQL プラグインが 5*xx* レスポンスコードを返すか、無効なクエリ DSL を OpenSearch に渡すことを示します。他のリクエストは引き続き成功します。値 0 は、最近の障害がないことを示します。値 1 が持続して表示される場合、クライアントがプラグインに対して行っているリクエストのトラブルシューティングを行います。 関連する統計: Maximum |
## k-NN メトリクス
Amazon OpenSearch Service は、以下の k 最近傍 ([k-NN](knn.md)) プラグインのメトリクスを提供します。
| メトリクス | 説明 |
| --- | --- |
| KNNCacheCapacityReached | キャッシュ容量に達したかどうかのノード単位のメトリクス。このメトリクスは、おおよその k-NN 検索にのみ関係します。 関連する統計: Maximum |
| KNNCircuitBreakerTriggered | サーキットブレーカーがトリガーされるかどうかのクラスタ単位のメトリクス。`KNNCacheCapacityReached` についていずれかのノードが 1 の値を返す場合、この値も 1 を返します。このメトリクスは、おおよその k-NN 検索にのみ関係します。 関連する統計: Maximum |
| KNNEvictionCount | メモリ制約またはアイドル時間のためにキャッシュから削除されたグラフ数のノード単位のメトリクス。インデックスの削除のために発生した明示的な削除はカウントされません。このメトリクスは、おおよその k-NN 検索にのみ関係します。 関連する統計情報: Sum |
| KNNGraphIndexErrors | ドキュメントの `knn_vector` フィールドを、エラーを生成したグラフに追加するリクエストの数のノードごとのメトリクス。 関連する統計情報: Sum |
| KNNGraphIndexRequests | ドキュメントの `knn_vector` フィールドを、グラフに追加するリクエストの数のノードごとのメトリクス。 関連する統計情報: Sum |
| KNNGraphMemoryUsage | 現在のキャッシュサイズ (メモリー内のすべてのグラフの合計サイズ) のノードごとのメトリクス (KB)。このメトリクスは、おおよその k-NN 検索にのみ関係します。 関連する統計: Average |
| KNNGraphQueryErrors | エラーを生成したグラフクエリの数のノード単位のメトリクス。 関連する統計情報: Sum |
| KNNGraphQueryRequests | グラフクエリの数のノード単位のメトリクス。 関連する統計情報: Sum |
| KNNHitCount | キャッシュヒットの数のノード単位のメトリクス。ユーザーがすでにメモリにロードされているグラフのクエリを行ったときに、キャッシュヒットが発生します。このメトリクスは、おおよその k-NN 検索にのみ関係します。 関連する統計情報: Sum |
| KNNLoadExceptionCount | グラフをキャッシュにロードしようとしたときに例外が発生した回数のノード単位のメトリクス。このメトリクスは、おおよその k-NN 検索にのみ関係します。 関連する統計情報: Sum |
| KNNLoadSuccessCount | プラグインがグラフをキャッシュに正常にロードした回数のノード単位のメトリクス。このメトリクスは、おおよその k-NN 検索にのみ関係します。 関連する統計情報: Sum |
| KNNMissCount | キャッシュミスの数のノード単位のメトリクス。ユーザーがまだメモリにロードされていないグラフのクエリを行ったときに、キャッシュミスが発生します。このメトリクスは、おおよその k-NN 検索にのみ関係します。 関連する統計情報: Sum |
| KNNQueryRequests | k-NN プラグインが受信したクエリリクエストの数のノード単位のメトリクス。 関連する統計情報: Sum |
| KNNRemoteBuildEnabled | 機能を有効にするかどうかを指定するバイナリ値。 関連する統計: バイナリ |
| KNNRemoteIndexBuildFailureCount | ビルド失敗の合計数。 関連する統計情報: Sum |
| KNNRemoteIndexBuildSuccessCount | 成功したビルドの合計数。 関連する統計情報: Sum |
| KNNScriptCompilationErrors | スクリプトのコンパイル中のエラーの数のノード単位のメトリクス。この統計は、k-NN スコアスクリプト検索にのみ関係します。 関連する統計情報: Sum |
| KNNScriptCompilations | k-NN スクリプトがコンパイルされた回数のノードごとのメトリクス。通常、この値は 1 または 0 であるはずですが、コンパイルされたスクリプトを含むキャッシュがいっぱいになると、k-NN スクリプトが再コンパイルされる可能性があります。この統計は、k-NN スコアスクリプト検索にのみ関係します。 関連する統計情報: Sum |
| KNNScriptQueryErrors | スクリプトクエリ中のエラーの数のノード単位のメトリクス。この統計は、k-NN スコアスクリプト検索にのみ関係します。 関連する統計情報: Sum |
| KNNScriptQueryRequests | スクリプトクエリの合計数のノード単位のメトリクス。この統計は、k-NN スコアスクリプト検索にのみ関係します。 関連する統計情報: Sum |
| KNNTotalLoadTime | k-NN がグラフをキャッシュにロードするのにかかった時間 (ナノ秒)。このメトリクスは、おおよその k-NN 検索にのみ関係します。 関連する統計情報: Sum |
| VectorIndexBuildAccelerationOCU | ベクトルインデックス作成の高速化に使用される OpenSearch コンピューティングユニット (OCUs) の数。 関連する統計情報: Sum |
## クラスター間検索のメトリクス
Amazon OpenSearch Service は、以下の[クラスター間検索](cross-cluster-search.md)のメトリクスを提供します。
**ソースドメインのメトリクス**
| メトリクス | ディメンション | 説明 |
| --- | --- | --- |
| CrossClusterOutboundConnections | `ConnectionId` | 接続されたノードの数。スキップされたドメインが 1 つ以上レスポンスに含まれている場合は、このメトリクスを使用して異常な接続を追跡します。この数が 0 になった場合、その接続は正常ではありません。 |
| CrossClusterOutboundRequests | `ConnectionId` | ターゲットドメインに送信された検索リクエストの数。ドメインでクラスター間検索リクエストが過負荷になっているかどうかを確認し、このメトリクスのスパイクと JVM/CPU スパイクの関連性を探るために使用します。 |
**ターゲットドメインのメトリクス**
| メトリクス | ディメンション | 説明 |
| --- | --- | --- |
| CrossClusterInboundRequests | `ConnectionId` | ソースドメインから受信した着信接続リクエストの数。 |
予期せず接続が切断された場合に CloudWatch アラームを追加します。アラームを作成する手順については、「[静的しきい値に基づいて CloudWatch アラームを作成する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ConsoleAlarms.html)」を参照してください。
## クラスター間レプリケーションメトリクス
Amazon OpenSearch Service は、以下の[クラスター間レプリケーション](replication.md)のメトリクスを提供します。
| メトリクス | 説明 |
| --- | --- |
| ReplicationRate | 1 秒あたりのレプリケーションオペレーションの平均率。このメトリクスは `IndexingRate` メトリクスに似ています。 |
| LeaderCheckPoint | 特定の接続については、すべてのレプリケートインデックスにおけるリーダーチェックポイントの合計値。このメトリクスを使用して、レプリケーションのレイテンシーを測定できます。 |
| FollowerCheckPoint | 特定の接続については、すべてのレプリケートインデックスにおけるフォロワーチェックポイントの合計値。このメトリクスを使用して、レプリケーションのレイテンシーを測定できます。 |
| ReplicationNumSyncingIndices | `SYNCING` のレプリケーションステータスを持つインデックスの数。 |
| ReplicationNumBootstrappingIndices | `BOOTSTRAPPING` のレプリケーションステータスを持つインデックスの数。 |
| ReplicationNumPausedIndices | `PAUSED` のレプリケーションステータスを持つインデックスの数。 |
| ReplicationNumFailedIndices | `FAILED` のレプリケーションステータスを持つインデックスの数。 |
| `CrossClusterOutboundReplicationRequests` | フォロワードメイン上のレプリケーショントランスポートリクエストの数。トランスポートリクエストは内部的なものであり、レプリケーション API オペレーションが呼び出されるたびに発生します。これらは、フォロワードメインがリーダードメインからの変更をポーリングする際にも発生します。 |
| `CrossClusterInboundReplicationRequests` | リーダードメイン上のレプリケーショントランスポートリクエストの数。トランスポートリクエストは内部的なものであり、レプリケーション API オペレーションが呼び出されるたびに発生します。 |
| AutoFollowNumSuccessStartReplication | 特定の接続のレプリケーションルールによって正常に作成されたフォロワーインデックスの数。 |
| AutoFollowNumFailedStartReplication | 一致するパターンがあったときにレプリケーションルールによって作成されなかったフォロワーインデックスの数。この問題は、リモートクラスターのネットワーク上の問題、またはセキュリティ上の問題 (すなわち、関連付けられているロールにレプリケーションを開始する許可がない) が原因となって発生する可能性があります。 |
| AutoFollowLeaderCallFailure | 新しいデータをプルするための、フォロワーインデックスからリーダーインデックスへのクエリが失敗したかどうか。`1` の値は、直前の 1 分間に 1 つ以上の失敗した呼び出しがあったことを意味します。 |
## Learning to Rank のメトリクス
Amazon OpenSearch Service は、以下の [Learning to Rank](learning-to-rank.md) のメトリクスを提供します。
| メトリクス | 説明 |
| --- | --- |
| LTRRequestTotalCount | ランク付けリクエストの合計数。 |
| LTRRequestErrorCount | 失敗したリクエストの合計数。 |
| LTRStatus.red | プラグインの実行に必要なインデックスの 1 つが赤であるかどうかを追跡します。 |
| LTRMemoryUsage | プラグインで使用されるメモリの合計。 |
| LTRFeatureMemoryUsageInBytes | Learning to Rank 機能フィールドで使用されるメモリの量 (バイト単位)。 |
| LTRFeaturesetMemoryUsageInBytes | すべての Learning to Rank 機能セットで使用されるメモリの量 (バイト単位)。 |
| LTRModelMemoryUsageInBytes | すべての Learning to Rank モデルで使用されるメモリの量 (バイト単位)。 |
## Piped Processing Language のメトリクス
Amazon OpenSearch Service は、以下の [Piped Processing Language](observability.md) のメトリクスを提供します。
| メトリクス | 説明 |
| --- | --- |
| PPLFailedRequestCountByCusErr | クライアントの問題により失敗した `_ppl` API へのリクエストの数。例えば、`IndexNotFoundException` により、リクエストが HTTP ステータスコード 400 を返す場合があります。 |
| PPLFailedRequestCountBySysErr | サーバーの問題または機能の制限により失敗した `_ppl` API へのリクエストの数。例えば、`VerificationException` により、リクエストが HTTP ステータスコード 503 を返す場合があります。 |
| PPLRequestCount | `_ppl` API へのリクエストの数。 |
# Amazon CloudWatch Logs を用いて OpenSearch ログをモニタリングする
Amazon OpenSearch Service は、Amazon CloudWatch Logs を通じて以下の OpenSearch ログを公開します。
+ エラーログ
+ [検索リクエストのスローログ](https://opensearch.org/docs/latest/install-and-configure/configuring-opensearch/logs/#search-request-slow-logs)
+ [シャードスローログ](https://opensearch.org/docs/latest/install-and-configure/configuring-opensearch/logs/#shard-slow-logs)
+ [監査ログ](audit-logs.md)
検索シャードスローログ、インデックス作成シャードスローログ、およびエラーログは、パフォーマンスと安定性の問題のトラブルシューティングに役立ちます。監査ログは、コンプライアンスの目的でユーザーのアクティビティを追跡します。すべてのログはデフォルトで*無効*になっています。有効にすると、[標準の CloudWatch 料金](https://aws.amazon.com/cloudwatch/pricing/)が適用されます。
**注記**
エラーログは、OpenSearch および Elasticsearch バージョン 5.1 以降のでのみ利用できます。スローログは、すべてのバージョンの OpenSearch および Elasticsearch で利用できます。
ログについては、OpenSearch は、[Apache Log4j 2](https://logging.apache.org/log4j/2.x/) とその組み込みログレベル (昇順) の `TRACE`、`DEBUG`、`INFO`、`WARN`、`ERROR`、および `FATAL` を使用します。
エラーログを有効にすると、OpenSearch Service によって、`WARN`、`ERROR`、および `FATAL` のログ行が CloudWatch に発行されます。OpenSearch サービスは、`DEBUG` レベルからのいくつかの例外も公開し、それには以下が含まれます。
+ `org.opensearch.index.mapper.MapperParsingException`
+ `org.opensearch.index.query.QueryShardException`
+ `org.opensearch.action.search.SearchPhaseExecutionException`
+ `org.opensearch.common.util.concurrent.OpenSearchRejectedExecutionException`
+ `java.lang.IllegalArgumentException`
以下のように、エラーログは多くの状況でトラブルシューティングに役立ちます。
+ Painless スクリプトのコンパイルの問題
+ 無効なクエリ
+ インデックス作成の問題
+ スナップショットの失敗
+ Index State Management の移行の失敗
**注記**
すべてのエラーがエラーログで報告されるわけではありません。
**注記**
OpenSearch Service は、発生したすべてのエラーをログに記録しません。
**Topics**
+ [ログ発行を有効にする (コンソール)](#createdomain-configure-slow-logs-console)
+ [ログ発行の有効化 (AWS CLI)](#createdomain-configure-slow-logs-cli)
+ [ログ発行 (AWS SDKs) の有効化](#createdomain-configure-slow-logs-sdk)
+ [ログの発行を有効にする (CloudFormation)](#createdomain-configure-slow-logs-cfn)
+ [検索リクエストスのスローログのしきい値設定](#createdomain-configure-search-request-slow-logs)
+ [シャードスローログのしきい値設定](#createdomain-configure-slow-logs-indices)
+ [スローログのテスト](#createdomain-configure-slow-logs-testing)
+ [ログの表示](#createdomain-configure-slow-logs-viewing)
## ログ発行を有効にする (コンソール)
CloudWatch へのログの発行を有効にするには、OpenSearch Service コンソールを使用する方法が最も簡単です。
**CloudWatch へのログの発行を有効にするには (コンソール)**
1. [aws.amazon.com](https://aws.amazon.com/) に移動し、**[サインイン]** を選択して認証情報を指定します。
1. **[分析]** の下で、**[Amazon OpenSearch Service]** を選択します。
1. 更新するドメインを選択します。
1. [**ログ**] タブで、ログタイプを選択し、[**有効化**] を選択します。
1. 新しい CloudWatch ロググループを作成するか、既存のロググループを選択します。
**注記**
複数のログを有効にする場合は、各ログを個別にロググループに発行することをお勧めします。分離することで、ログをスキャンしやすくなります。
1. 適切なアクセス権限を含むアクセスポリシーを選択するか、コンソールに用意された JSON を使用してポリシーを作成します。
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"Service": "es.amazonaws.com"
},
"Action": [
"logs:PutLogEvents",
"logs:CreateLogStream"
],
"Resource": "arn:aws:logs:us-east-1:111122223333:log-group:cw_log_group_name:*"
}
]
}
```
------
[Confused Deputy Problem (混乱した代理の問題)](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html) から自分を守るために、`aws:SourceAccount` および `aws:SourceArn` の条件キーをポリシーに追加することをお勧めします。ソースアカウントはドメインの所有者であり、ソース ARN はドメインの ARN です。これらの条件キーを追加するには、ドメインがサービスソフトウェア R20211203 以降にある必要があります。
例えば、次の条件ブロックをポリシーに追加できます。
```
"Condition": {
"StringEquals": {
"aws:SourceAccount": "account-id"
},
"ArnLike": {
"aws:SourceArn": "arn:aws:es:region:account-id:domain/domain-name"
}
}
```
**重要**
CloudWatch Logs では、[リージョンごとに 10 個のリソースポリシー](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutResourcePolicy.html)がサポートされます。複数の OpenSearch Service ドメインでログを有効にする場合は、この制限に達しないように、複数のロググループを含む広範囲のポリシーを作成して再利用します。ポリシーを更新する手順については、「[ログ発行の有効化 (AWS CLI)](#createdomain-configure-slow-logs-cli)」を参照してください。
1. [**有効**] を選択します。
ドメインのステータスが [**アクティブ**] から [**処理中**] に変わります。ステータスは、ログの発行が有効になる前に [**アクティブ**] に戻る必要があります。この変更には通常 30 分かかりますが、ドメイン設定によってはさらに時間がかかる場合があります。
シャードスローログのいずれかを有効にしている場合は、「[シャードスローログのしきい値設定](#createdomain-configure-slow-logs-indices)」を参照してください。監査ログを有効にした場合は、「[ステップ 2: OpenSearch Dashboards で、監査ログを有効にする](audit-logs.md#audit-log-dashboards-ui)」を参照してください。エラーログのみ有効にしている場合は、追加のステップを行う必要はありません。
## ログ発行の有効化 (AWS CLI)
ログの発行を有効にする前に、CloudWatch ロググループが必要です。まだロググループがない場合は、次のコマンドを使用して作成できます。
```
aws logs create-log-group --log-group-name my-log-group
```
次のコマンドを入力してロググループの ARN を検索し、*それを書き留めます*。
```
aws logs describe-log-groups --log-group-name my-log-group
```
これで、このロググループに書き込むための許可を OpenSearch Service に付与できます。ロググループの末尾に近い位置にロググループの ARN を指定する必要があります。
```
aws logs put-resource-policy \
--policy-name my-policy \
--policy-document '{ "Version": "2012-10-17", "Statement": [{ "Sid": "", "Effect": "Allow", "Principal": { "Service": "es.amazonaws.com"}, "Action":[ "logs:PutLogEvents","logs:CreateLogStream"],"Resource": "cw_log_group_arn:*"}]}'
```
**重要**
CloudWatch Logs では、[リージョンごとに 10 個のリソースポリシー](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutResourcePolicy.html)がサポートされます。複数の OpenSearch Service ドメインでシャードスローログを有効にする場合は、複数のロググループが含まれている適用範囲のより広いポリシーを作成して再利用し、この制限に達しないようにします。
後でこのポリシーを確認する必要がある場合は、`aws logs describe-resource-policies` コマンドを使用します。ポリシーを更新するには、新しいポリシードキュメントで同じ `aws logs put-resource-policy` コマンドを実行します。
最後に、`--log-publishing-options` オプションを使用して発行を有効化できます。オプションの構文は、`create-domain` コマンドと `update-domain-config` コマンドのどちらでも同じです。
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/opensearch-service/latest/developerguide/createdomain-configure-slow-logs.html)
**注記**
複数のログを有効にする場合は、各ログを個別にロググループに発行することをお勧めします。分離することで、ログをスキャンしやすくなります。
**例**
次の例では、指定されたドメインに対して検索およびインデックス作成のシャードスローログの発行を有効にします。
```
aws opensearch update-domain-config \
--domain-name my-domain \
--log-publishing-options "SEARCH_SLOW_LOGS={CloudWatchLogsLogGroupArn=arn:aws:logs:us-east-1:123456789012:log-group:my-log-group,Enabled=true},INDEX_SLOW_LOGS={CloudWatchLogsLogGroupArn=arn:aws:logs:us-east-1:123456789012:log-group:my-other-log-group,Enabled=true}"
```
CloudWatch への発行を無効にするには、`Enabled=false` を使用して同じコマンドを実行します。
シャードスローログのいずれかを有効にしている場合は、「[シャードスローログのしきい値設定](#createdomain-configure-slow-logs-indices)」を参照してください。監査ログを有効にした場合は、「[ステップ 2: OpenSearch Dashboards で、監査ログを有効にする](audit-logs.md#audit-log-dashboards-ui)」を参照してください。エラーログのみ有効にしている場合は、追加のステップを行う必要はありません。
## ログ発行 (AWS SDKs) の有効化
ログの発行を有効にする前に、CloudWatch ロググループを作成してその ARN を取得し、そのロググループに書き込むための許可を OpenSearch Service に付与する必要があります。関連するオペレーションは [Amazon CloudWatch Logs API リファレンス](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/)に記載されています。
+ `CreateLogGroup`
+ `DescribeLogGroup`
+ `PutResourcePolicy`
これらのオペレーションには、[AWS SDK](https://aws.amazon.com/tools/#sdk) を使用してアクセスできます。
AWS SDKs (Android および iOS SDKs を除く) は、 `CreateDomain`および `--log-publishing-options`のオプションを含め、[Amazon OpenSearch Service API リファレンス](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/Welcome.html)で定義されているすべてのオペレーションをサポートします`UpdateDomainConfig`。
シャードスローログのいずれかを有効にしている場合は、「[シャードスローログのしきい値設定](#createdomain-configure-slow-logs-indices)」を参照してください。エラーログのみ有効にしている場合は、追加のステップを行う必要はありません。
## ログの発行を有効にする (CloudFormation)
この例では、CloudFormation を使用して `opensearch-logs` というロググループを作成し、適切な許可を割り当ててから、アプリケーションログ、検索スローログ、およびインデックス作成シャードスローログのためにログの発行が有効化されたドメインを作成します。
ログの公開を有効化する前に、CloudWatch ロググループを作成する必要があります。
```
Resources:
OpenSearchLogGroup:
Type: AWS::Logs::LogGroup
Properties:
LogGroupName: opensearch-logs
Outputs:
Arn:
Value:
'Fn::GetAtt':
- OpenSearchLogGroup
- Arn
```
テンプレートは、ロググループの ARN を出力します。この場合、ARNは `arn:aws:logs:us-east-1:123456789012:log-group:opensearch-logs` です。
ARN を使用して、OpenSearch Service にロググループに書き込むための許可を付与するリソースポリシーを作成します。
```
Resources:
OpenSearchLogPolicy:
Type: AWS::Logs::ResourcePolicy
Properties:
PolicyName: my-policy
PolicyDocument: "{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Sid\": \"\", \"Effect\": \"Allow\", \"Principal\": { \"Service\": \"es.amazonaws.com\"}, \"Action\":[ \"logs:PutLogEvents\",\"logs:CreateLogStream\"],\"Resource\": \"arn:aws:logs:us-east-1:123456789012:log-group:opensearch-logs:*\"}]}"
```
最後に、以下の CloudFormation スタックが作成されます。これは、ログの発行が有効化された OpenSearch Service ドメインを生成します。アクセスポリシーは、 のユーザーがドメイン AWS アカウント へのすべての HTTP リクエストを行うことを許可します。
```
Resources:
OpenSearchServiceDomain:
Type: "AWS::OpenSearchService::Domain"
Properties:
DomainName: my-domain
EngineVersion: "OpenSearch_1.0"
ClusterConfig:
InstanceCount: 2
InstanceType: "r6g.xlarge.search"
DedicatedMasterEnabled: true
DedicatedMasterCount: 3
DedicatedMasterType: "r6g.xlarge.search"
EBSOptions:
EBSEnabled: true
VolumeSize: 10
VolumeType: "gp2"
AccessPolicies:
Version: "2012-10-17"
Statement:
Effect: "Allow"
Principal:
AWS: "arn:aws:iam::123456789012:user/es-user"
Action: "es:*"
Resource: "arn:aws:es:us-east-1:123456789012:domain/my-domain/*"
LogPublishingOptions:
ES_APPLICATION_LOGS:
CloudWatchLogsLogGroupArn: "arn:aws:logs:us-east-1:123456789012:log-group:opensearch-logs"
Enabled: true
SEARCH_SLOW_LOGS:
CloudWatchLogsLogGroupArn: "arn:aws:logs:us-east-1:123456789012:log-group:opensearch-logs"
Enabled: true
INDEX_SLOW_LOGS:
CloudWatchLogsLogGroupArn: "arn:aws:logs:us-east-1:123456789012:log-group:opensearch-logs"
Enabled: true
```
構文の詳細については、*CloudFormation ユーザーガイド*の「[ログの発行オプション](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-logpublishingoption.html)」を参照してください。
## 検索リクエストスのスローログのしきい値設定
[検索リクエストのスローログ](https://opensearch.org/docs/latest/install-and-configure/configuring-opensearch/logs/#search-request-slow-logs)は、バージョン 2.13 以降で実行されている OpenSearch Service ドメインで検索できます。検索リクエストのスローログのしきい値は、リクエストの合計所要時間に対して設定されます。これは、個々のシャードの所要時間に対して設定されたシャードリクエストのスローログとは異なります。
クラスター設定を使用して、検索リクエストのスローログを指定できます。これは、インデックス設定で有効にするシャードスローログとは異なります。例えば、次の設定は、OpenSearch REST API を使用して指定できます。
```
PUT domain-endpoint/_cluster/settings
{
"transient": {
"cluster.search.request.slowlog.threshold.warn": "5s",
"cluster.search.request.slowlog.threshold.info": "2s"
}
}
```
**注記**
`PUT /_cluster/settings` エンドポイントは Amazon OpenSearch Service で制限されています。このリクエストを送信するとエラーが返されます。シャードスローログのしきい値`Your request: '/_cluster/settings' payload is not allowed.`を設定するには、代わりにインデックスレベルの設定を使用します。例えば、次のようになります。
```
PUT domain-endpoint/index/_settings
{
"index.search.slowlog.threshold.query.warn": "5s",
"index.search.slowlog.threshold.query.info": "2s"
}
```
## シャードスローログのしきい値設定
OpenSearch では、デフォルトで[シャードスローログ](https://opensearch.org/docs/latest/install-and-configure/configuring-opensearch/logs/#shard-slow-logs)が無効になっています。CloudWatch へのシャードスローログの*発行*を有効にしたら、さらに OpenSearch インデックスごとにログしきい値を指定する必要があります。これらのしきい値は、ログに記録する内容とログレベルを正確に定義します。
例えば、次の設定は、OpenSearch REST API を使用して指定できます。
```
PUT domain-endpoint/index/_settings
{
"index.search.slowlog.threshold.query.warn": "5s",
"index.search.slowlog.threshold.query.info": "2s"
}
```
## スローログのテスト
検索リクエストのスローログとシャードスローログの正常な発行をテストするには、極度に低い値から開始してログが CloudWatch に表示されることを確認し、その後、しきい値をより有用なレベルに高めます。
ログが表示されない場合は、以下を確認してください。
+ CloudWatch ロググループが存在しているかどうか? CloudWatch コンソールを確認します。
+ ロググループに書き込むための許可が OpenSearch Service にあるかどうか? OpenSearch Service コンソールを確認します。
+ OpenSearch Service ドメインはロググループに発行するように設定されているかどうか? OpenSearch Service コンソールを確認するか、 AWS CLI `describe-domain-config`オプションを使用するか、いずれかの SDK `DescribeDomainConfig`を使用して を呼び出します。 SDKs
+ OpenSearch ログしきい値が低くてリクエストが超過していないかどうか?
ドメインの検索リクエストのスローログのしきい値を確認するには、次のコマンドを使用します。
```
GET domain-endpoint/_cluster/settings?flat_settings
```
インデックスのシャードスローログのしきい値を確認するには、次のコマンドを使用します。
```
GET domain-endpoint/index/_settings?pretty
```
インデックスのスローログを無効にする場合は、変更したしきい値をデフォルト値の `-1` に戻します。
OpenSearch Service コンソールを使用して CloudWatch への発行を無効にすると、OpenSearch によるログの生成は停止 AWS CLI *されず*、それらのログの*発行*のみが停止します。シャードスローログが不要になった場合はインデックス設定、検索リクエストのスローログが不要になった場合はドメイン設定を確認してください。
## ログの表示
CloudWatchでアプリケーションとスローログを表示する方法は、その他の CloudWatch ログを表示する方法と同じです。詳細については、*Amazon CloudWatch Logs ユーザーガイド*の「[ログデータの表示](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html#ViewingLogData)」を参照してください。
ログを表示する際の考慮事項は以下のとおりです。
+ OpenSearch Service は、各行の最初の 255,000 文字のみを CloudWatch に発行します。残りのコンテンツは切り捨てられます。監査ログの場合、それはメッセージあたり 10,000 文字です。
+ CloudWatch では、ログの内容を識別しやすいようにログストリーム名のサフィックスとして `-index-slow-logs`、`-search-slow-logs`、`-application-logs`、および `-audit-logs` が使用されます。
# Amazon OpenSearch Service での監査ログのモニタリング
Amazon OpenSearch Service ドメインできめ細かなアクセスコントロールを使用する場合、データの監査ログを有効にすることができます。監査ログは高度にカスタマイズ可能で、認証の成功と失敗、OpenSearch へのリクエスト、インデックスの変更、受信検索クエリなど、OpenSearch クラスターでのユーザーアクティビティを追跡できます。デフォルトの設定では、一般的な一連のユーザーアクションが追跡されますが、正確なニーズに合わせて設定を調整することをお勧めします。
[OpenSearch アプリケーションログおよびスローログ](createdomain-configure-slow-logs.md)のように、OpenSearch Service は CloudWatch Logs に監査ログを発行します。有効にすると、[標準の CloudWatch 料金](https://aws.amazon.com/cloudwatch/pricing/)が適用されます。
**注記**
監査ログを有効にするには、ユーザーロールが `security_manager` ロールにマッピングされる必要があり、これにより、OpenSearch `plugins/_security` REST APIへのアクセス権が提供されます。詳細については[マスターユーザーの変更](fgac.md#fgac-forget)を参照してください。
**Topics**
+ [制限事項](#audit-logs-limitations)
+ [監査ログ記録の有効化](#audit-log-enabling)
+ [を使用して監査ログ記録を有効にする AWS CLI](#audit-log-enabling-cli)
+ [設定 API を使用して監査ログを有効にする](#audit-log-enabling-api)
+ [監査ログのレイヤーとカテゴリ](#audit-log-layers)
+ [監査ログの設定](#audit-log-settings)
+ [監査ログの例](#audit-log-example)
+ [REST API を使用した監査ログの設定](#audit-log-rest-api)
## 制限事項
監査ログには以下の制限事項があります。
+ 監査ログには、送信先のドメインアクセスポリシーによって拒否されたクロスクラスター検索リクエストは含まれません。
+ 各監査ログメッセージの最大サイズは 10,000 文字です。この制限を超えると、監査ログメッセージが切り捨てられます。
## 監査ログ記録の有効化
監査ログの有効化は、2 段階のプロセスです。まず、CloudWatch Logs に CloudWatch Logs に監査ログを発行するようにドメインを設定します。次に、OpenSearch Dashboards で監査ログを有効にして、ニーズを満たすように監査ログを設定します。
**重要**
これらの手順の実行中にエラーが発生した場合、トラブルシューティング情報については、[監査ログを有効にできない](handling-errors.md#troubleshooting-audit-logs-error) を参照してください。
### ステップ 1: 監査ログを有効にし、アクセスポリシーを設定する
次の手順では、コンソールを使用して監査ログを有効にする方法について説明します。または [OpenSearch Service API](#audit-log-enabling-api) [を使用して有効に AWS CLI](#audit-log-enabling-cli)することもできます。
**OpenSearch Service ドメインの監査ログを有効にするには (コンソール)**
1. ドメインを選択して設定を開き、[**ログ**] タブに移動します。
1. [**監査ログ**] を選択してから、[**有効化**] を選択します。
1. CloudWatch ロググループを作成するか、既存のロググループを選択します。
1. 適切なアクセス権限を含むアクセスポリシーを選択するか、コンソールに用意された JSON を使用してポリシーを作成します。
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"Service": "es.amazonaws.com"
},
"Action": [
"logs:PutLogEvents",
"logs:CreateLogStream"
],
"Resource": "arn:aws:logs:us-east-1:111122223333:log-group:/aws/opensearch/domains/domain-name/*"
}
]
}
```
------
[Confused Deputy Problem (混乱した代理の問題)](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html) から自分を守るために、`aws:SourceAccount` および `aws:SourceArn` の条件キーをポリシーに追加することをお勧めします。ソースアカウントはドメインの所有者であり、ソース ARN はドメインの ARN です。これらの条件キーを追加するには、ドメインがサービスソフトウェア R20211203 以降にある必要があります。
例えば、次の条件ブロックをポリシーに追加できます。
```
"Condition": {
"StringEquals": {
"aws:SourceAccount": "account-id"
},
"ArnLike": {
"aws:SourceArn": "arn:aws:es:region:account-id:domain/domain-name"
}
}
```
1. **[有効化]** を選択します。
### ステップ 2: OpenSearch Dashboards で、監査ログを有効にする
OpenSearch Service コンソールで監査ログを有効にした後、OpenSearch Dashboards でも有効にして、ニーズを満たすように設定する*必要があります*。
1. OpenSearch Dashboards を開き、左側のサイドメニューから [**セキュリティ**] を選択します。
1. [**監査ログ**] を選択します。
1. [**監査ログ作成を有効にする**] を選択します。
Dashboards UI には、[**全般設定**] および [**コンプライアンス設定**] の下で、監査ログの設定の完全なコントロールが用意されています。すべての設定オプションの説明については、「[監査ログの設定](#audit-log-settings)」を参照してください。
## を使用して監査ログ記録を有効にする AWS CLI
次の AWS CLI コマンドは、既存のドメインの監査ログを有効にします。
```
aws opensearch update-domain-config --domain-name my-domain --log-publishing-options "AUDIT_LOGS={CloudWatchLogsLogGroupArn=arn:aws:logs:us-east-1:123456789012:log-group:my-log-group,Enabled=true}"
```
ドメインを作成するときに、監査ログを有効にすることもできます。詳細については、「[AWS CLI コマンドのリファレンス](https://docs.aws.amazon.com/cli/latest/reference/)」を参照してください。
## 設定 API を使用して監査ログを有効にする
次の設定 API へのリクエストにより、既存のドメインで監査ログが有効になります。
```
POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain/my-domain/config
{
"LogPublishingOptions": {
"AUDIT_LOGS": {
"CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:123456789012:log-group1:sample-domain",
"Enabled":true
}
}
}
```
詳細については、「[Amazon OpenSearch Service API reference](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_LogPublishingOption.html)」(Amazon OpenSearch Service API リファレンス) を参照してください。
## 監査ログのレイヤーとカテゴリ
クラスターコミュニケーションは、2 つの別々の*レイヤー*を介して行われます: RESTレイヤーとトランスポートレイヤー。
+ REST レイヤーは、curl、Logstash、OpenSearch Dashboards、Java 高レベル REST クライアント、Python [Requests](https://2.python-requests.org/) ライブラリなどの HTTP クライアントとの通信 (クラスターに到達する HTTP リクエスト) を対象としています。
+ トランスポートレイヤーは、ノード間のコミュニケーションを対象としています。例えば、検索リクエストが（REST レイヤーを介して）クラスターに到着した後、リクエストを処理する調整ノードは、クエリを他のノードに送信し、そのレスポンスを受け取り、必要なドキュメントを収集し、それらを最終的なレスポンスと照合します。シャード割り当てや再分散などのオペレーションは、トランスポートレイヤーでも実行されます。
レイヤー全体の監査ログと、レイヤーの個々の監査カテゴリを有効または無効にできます。次の表に、監査カテゴリの概要と、監査カテゴリが使用可能なレイヤーを示します。
| Category | 説明 | REST で利用可能 | トランスポートで利用可能 |
| --- | --- | --- | --- |
| FAILED\$1LOGIN | リクエストに無効な資格情報が含まれ、認証に失敗しました。 | はい | はい |
| MISSING\$1PRIVILEGES | ユーザーには、リクエストを行う権限がありませんでした。 | はい | はい |
| GRANTED\$1PRIVILEGES | ユーザーには、リクエストを行う権限がありました。 | はい | はい |
| OPENSEARCH\$1SECURITY\$1INDEX\$1ATTEMPT | リクエストが .opendistro\$1security インデックスを修正しようとしました。 | いいえ | はい |
| AUTHENTICATED | リクエストに有効な認証情報が含まれ、認証に成功しました。 | はい | はい |
| INDEX\$1EVENT | リクエストは、インデックスの作成、エイリアスの設定、強制マージの実行など、インデックスの管理オペレーションを実行しました。このカテゴリに含まれる indices:admin/ アクションの完全なリストは、[OpenSearch ドキュメント](https://docs.opensearch.org/latest/security-plugin/access-control/permissions/)で入手可能です。 | いいえ | はい |
これらの標準カテゴリに加えて、きめ細かなアクセスコントロールには、データコンプライアンス要件を満たすように設計されたいくつかの追加カテゴリが用意されています。
| Category | 説明 |
| --- | --- |
| COMPLIANCE\$1DOC\$1READ | リクエストは、インデックス内のドキュメントに対して読み取りイベントを実行しました。 |
| COMPLIANCE\$1DOC\$1WRITE | リクエストは、インデックス内のドキュメントに対して書き込みイベントを実行しました。 |
| COMPLIANCE\$1INTERNAL\$1CONFIG\$1READ | リクエストは、`.opendistro_security` インデックスで読み取りイベントを実行しました。 |
| COMPLIANCE\$1INTERNAL\$1CONFIG\$1WRITE | リクエストは、`.opendistro_security` インデックスで書き込みイベントを実行しました。 |
カテゴリおよびメッセージ属性の任意の組み合わせを指定できます。例えば、REST リクエストを送信してドキュメントのインデックスを作成すると、監査ログに次の行が表示されることがあります。
+ REST レイヤーで AUTHENTICATED (認証)
+ トランスポートレイヤーで GRANTED\$1PREVIEWE (認可)
+ COMPLIANCE\$1DOC\$1WRITE (インデックスに書き込まれたドキュメント)
## 監査ログの設定
監査ログには、多数の設定オプションがあります。
### 全般設定
全般設定では、個々のカテゴリまたはレイヤー全体を有効または無効にできます。除外カテゴリとして GRANTED\$1Privileges および Authenticated を残すことを強くお勧めします。それ以外の場合、これらのカテゴリは、クラスターへの有効なリクエストごとにログされます。
| 名前 | バックエンドの設定 | 説明 |
| --- | --- | --- |
| REST レイヤー | enable\$1rest | REST レイヤーで発生するイベントを有効または無効にします。 |
| REST 無効なカテゴリ | disabled\$1rest\$1categories | REST レイヤーで無視する監査カテゴリを指定します。これらのカテゴリを変更すると、監査ログのサイズが大幅に増加する可能性があります。 |
| トランスポートレイヤー | enable\$1transport | トランスポートレイヤーで発生するイベントを有効または無効にします。 |
| トランスポート無効なカテゴリ | disabled\$1transport\$1categories | トランスポートレイヤーで無視する必要がある監査カテゴリを指定します。これらのカテゴリを変更すると、監査ログのサイズが大幅に増加する可能性があります。 |
属性設定では、各ログ行の詳細量をカスタマイズできます。
| 名前 | バックエンドの設定 | 説明 |
| --- | --- | --- |
| 一括リクエスト | resolve\$1bulk\$1requests | この設定を有効にすると、一括要求でドキュメントごとにログが生成されます。これにより、監査ログのサイズが大幅に増加する可能性があります。 |
| リクエストボディ | log\$1request\$1body | リクエストのリクエストボディを含めます。 |
| インデックスの解決 | resolve\$1indices | インデックスに対してエイリアスを解決します。 |
無視設定を使用して、一連のユーザーまたは API パスを除外します。
| 名前 | バックエンドの設定 | 説明 |
| --- | --- | --- |
| 無視されたユーザー | ignore\$1users | 除外するユーザーを指定します。 |
| 無視されたリクエスト | ignore\$1requests | 除外するリクエストパターンを指定します。 |
### コンプライアンス設定
コンプライアンス設定では、インデックス、ドキュメント、またはフィールドレベルのアクセスを調整できます。
| 名前 | バックエンドの設定 | 説明 |
| --- | --- | --- |
| コンプライアンスのロギング | enable\$1compliance | コンプライアンスのロギングを有効または無効にします。 |
読み取りおよび書き込みイベントのロギングには以下の設定を指定できます。
| 名前 | バックエンドの設定 | 説明 |
| --- | --- | --- |
| 内部設定のロギング | internal\$1config | `.opendistro_security` インデックスのイベントのロギングを有効または無効にします。 |
読み取りイベントには以下の設定を指定できます。
| 名前 | バックエンドの設定 | 説明 |
| --- | --- | --- |
| メタデータの読み取り | read\$1metadata\$1only | 読み取りイベントのメタデータのみを含めます。ドキュメントフィールドを含めないでください。 |
| 無視されたユーザー | read\$1ignore\$1users | 読み取りイベントには特定のユーザーを含めないでください。 |
| 監視するフィールド | read\$1watched\$1fields | 読み取りイベントを監視するインデックスとフィールドを指定します。監視するフィールドを追加すると、ドキュメントアクセスごとに 1 つのログが生成されます。これにより、監査ログのサイズが大幅に増加する可能性があります。監視するフィールドは、インデックスパターンとフィールドパターンをサポートします。 {
"index-name-pattern": [
"field-name-pattern"
],
"logs*": [
"message"
],
"twitter": [
"id",
"user*"
]
} |
書き込みイベントには以下の設定を指定できます。
| 名前 | バックエンドの設定 | 説明 |
| --- | --- | --- |
| メタデータの書き込み | write\$1metadata\$1only | 書き込みイベントのメタデータのみを含めます。ドキュメントフィールドを含めないでください。 |
| 差分のログ | write\$1log\$1diffs | write\$1metadata\$1only が false の場合は、書き込みイベント間の違いのみを含めます。 |
| 無視されたユーザー | write\$1ignore\$1users | 書き込みイベントには特定のユーザーを含めないでください。 |
| インデックスの監視 | write\$1watched\$1indices | 書き込みイベントを監視するインデックスまたはインデックスパターンを指定します。監視するフィールドを追加すると、ドキュメントアクセスごとに 1 つのログが生成されます。これにより、監査ログのサイズが大幅に増加する可能性があります。 |
## 監査ログの例
このセクションには、設定例、検索リクエスト、およびインデックスのすべての読み取りおよび書き込みイベントの結果となる監査ログが含まれます。
### ステップ 1: 監査ログを設定する
CloudWatch Logs グループへの監査ログの公開を有効にした後、OpenSearch Dashboards の監査ロギングページに移動し、[**監査ロギングを有効にする**] を選択します。
1. [**全般設定**] で、[**設定**] を選択し、[**REST レイヤー**] が有効であることを確認します。
1. [**コンプライアンス設定**] で、[**設定**] を選択します。
1. [**書き込み**] の下で、[**監視フィールド**] に、追加このインデックスへのすべての書き込みイベントのために `accounts` を追加します。
1. **[読み取り]** で、**[監視フィールド]** に、`accounts` インデックスの `ssn` および `id-` フィールドを追加します。
```
{
"accounts-": [
"ssn",
"id-"
]
}
```
### ステップ 2: 読み取りイベントと書き込みイベントを実行する
1. OpenSearch Dashboards に移動し、[**デベロッパーツール**] を選択し、サンプルドキュメントのインデックスを作成します。
```
PUT accounts/_doc/0
{
"ssn": "123",
"id-": "456"
}
```
1. 読み取りイベントをテストするには、次のリクエストを送信します。
```
GET accounts/_search
{
"query": {
"match_all": {}
}
}
```
### ステップ 3: ログを確認する
1. CloudWatch コンソールの [https://console.aws.amazon.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/) を開いてください。
1. ナビゲーションペインで、**[Log groups]** (ロググループ) を選択します。
1. 監査ログを有効にするときに指定したロググループを選択します。ロググループ内で、OpenSearch Service はドメイン内の各ノードのログストリームを作成します。
1. [**ログストリーム**] で、[**すべて検索**] を選択します。
1. 読み取りおよび書き込みイベントについては、対応するログを参照してください。ログが表示される前に、5 秒の遅延が予想されます。
**監査ログの書き込みの例**
```
{
"audit_compliance_operation": "CREATE",
"audit_cluster_name": "824471164578:audit-test",
"audit_node_name": "be217225a0b77c2bd76147d3ed3ff83c",
"audit_category": "COMPLIANCE_DOC_WRITE",
"audit_request_origin": "REST",
"audit_compliance_doc_version": 1,
"audit_node_id": "3xNJhm4XS_yTzEgDWcGRjA",
"@timestamp": "2020-08-23T05:28:02.285+00:00",
"audit_format_version": 4,
"audit_request_remote_address": "3.236.145.227",
"audit_trace_doc_id": "lxnJGXQBqZSlDB91r_uZ",
"audit_request_effective_user": "admin",
"audit_trace_shard_id": 8,
"audit_trace_indices": [
"accounts"
],
"audit_trace_resolved_indices": [
"accounts"
]
}
```
**監査ログの読み取りの例**
```
{
"audit_cluster_name": "824471164578:audit-docs",
"audit_node_name": "806f6050cb45437e2401b07534a1452f",
"audit_category": "COMPLIANCE_DOC_READ",
"audit_request_origin": "REST",
"audit_node_id": "saSevm9ASte0-pjAtYi2UA",
"@timestamp": "2020-08-31T17:57:05.015+00:00",
"audit_format_version": 4,
"audit_request_remote_address": "54.240.197.228",
"audit_trace_doc_id": "config:7.7.0",
"audit_request_effective_user": "admin",
"audit_trace_shard_id": 0,
"audit_trace_indices": [
"accounts"
],
"audit_trace_resolved_indices": [
"accounts"
]
}
```
リクエストボディを含めるには、OpenSearch Dashboards の [**コンプライアンス設定**] に戻り、[**メタデータの書き込み**] を無効にします。特定のユーザーによるイベントを除外するには、そのユーザーを [**無視されたユーザー**] に追加します。
各監査ログフィールドの説明については、「[監査ログフィールドのリファレンス](https://docs.opensearch.org/latest/security-plugin/audit-logs/field-reference/)]を参照してください。監査ログデータの検索および分析の詳細については、*Amazon CloudWatch Logs ユーザーガイド*の「[CloudWatch Logs Insights を用いたログデータの分析](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html)」を参照してください。
## REST API を使用した監査ログの設定
OpenSearch Dashboards を使用して監査ログを設定することをお勧めしますが、きめ細かなアクセスコントロールの REST API を使用することもできます。このセクションには、リクエストの例が含まれています。REST API に関する完全なドキュメントは、[OpenSearch ドキュメント](https://opensearch.org/docs/latest/security/access-control/api/#audit-logs)で入手可能です。
```
PUT _opendistro/_security/api/audit/config
{
"enabled": true,
"audit": {
"enable_rest": true,
"disabled_rest_categories": [
"GRANTED_PRIVILEGES",
"AUTHENTICATED"
],
"enable_transport": true,
"disabled_transport_categories": [
"GRANTED_PRIVILEGES",
"AUTHENTICATED"
],
"resolve_bulk_requests": true,
"log_request_body": true,
"resolve_indices": true,
"exclude_sensitive_headers": true,
"ignore_users": [
"kibanaserver"
],
"ignore_requests": [
"SearchRequest",
"indices:data/read/*",
"/_cluster/health"
]
},
"compliance": {
"enabled": true,
"internal_config": true,
"external_config": false,
"read_metadata_only": true,
"read_watched_fields": {
"read-index-1": [
"field-1",
"field-2"
],
"read-index-2": [
"field-3"
]
},
"read_ignore_users": [
"read-ignore-1"
],
"write_metadata_only": true,
"write_log_diffs": false,
"write_watched_indices": [
"write-index-1",
"write-index-2",
"log-*",
"*"
],
"write_ignore_users": [
"write-ignore-1"
]
}
}
```
# Amazon EventBridge を用いた OpenSearch Service イベントのモニタリング
Amazon OpenSearch Service は Amazon EventBridge と統合され、ドメインに影響する特定のイベントを通知します。 AWS サービスからのイベントは、ほぼリアルタイムで EventBridge に配信されます。同じイベントが Amazon EventBridge の先行である [Amazon CloudWatch Events](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatchEvents.html) にも送信されます。簡単なルールを記述して、注目するイベントと、イベントがルールに一致した場合に自動的に実行するアクションを指定できます。自動的にトリガーできるオペレーションには、以下が含まれます。
+ AWS Lambda 関数の呼び出し
+ Amazon EC2 Run Command の呼び出し
+ Amazon Kinesis Data Streams へのイベントの中継
+ AWS Step Functions ステートマシンのアクティブ化
+ Amazon SNS トピックまたは Amazon SQS キューの通知
詳細については、*Amazon EventBridge ユーザーガイド*の「[Amazon EventBridge の開始方法](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-get-started.html)」を参照してください。
**Topics**
+ [サービスソフトウェア更新イベント](#monitoring-events-sso)
+ [Auto-Tune イベント](#monitoring-events-autotune)
+ [クラスターヘルスイベント](#monitoring-events-cluster-health)
+ [VPC エンドポイントイベント](#monitoring-events-vpc)
+ [ノードの廃止イベント](#monitoring-events-nr)
+ [デグレードされたノードの廃止イベント](#monitoring-events-degraded-nr)
+ [ドメインエラーイベント](#monitoring-events-errors)
+ [チュートリアル: Amazon OpenSearch Service EventBridge イベントをリッスンする](listening-events.md)
+ [チュートリアル: 利用可能なソフトウェア更新に関する Amazon SNS アラートの送信](sns-events.md)
## サービスソフトウェア更新イベント
OpenSearch Service は、次の[サービスソフトウェア更新](service-software.md)イベントのいずれかが発生したときに、EventBridge にイベントを送信します。
### サービスソフトウェア更新が利用可能
OpenSearch Service は、サービスソフトウェア更新が利用可能になったときに、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version": "0",
"id": "01234567-0123-0123-0123-012345678901",
"detail-type": "Amazon OpenSearch Service Software Update Notification",
"source": "aws.es",
"account": "123456789012",
"time": "2016-11-01T13:12:22Z",
"region": "us-east-1",
"resources": ["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail": {
"event": "Service Software Update",
"status": "Available",
"severity": "Informational",
"description": "Service software update R20220928 available. Service Software Deployment Mechanism:
Blue/Green. For more information on deployment configuration, please
see: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes.html"
}
}
```
### サービスソフトウェア更新をスケジュールしました
OpenSearch Service は、サービスソフトウェア更新がスケジュールされたときに、このイベントを送信します。オプションの更新の場合、予定日に通知が届きます。再スケジュールはいつでも可能です。必要な更新の場合、予定日の 3 日前に通知が届きます。再スケジュールは、決められた期間内に行えます。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version": "0",
"id": "01234567-0123-0123-0123-012345678901",
"detail-type": "Amazon OpenSearch Service Software Update Notification",
"source": "aws.es",
"account": "123456789012",
"time": "2016-11-01T13:12:22Z",
"region": "us-east-1",
"resources": ["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail": {
"event": "Service Software Update",
"status": "Scheduled",
"severity": "High",
"description": "A new service software update [R20200330-p1] has been scheduled at [21st May 2023 12:40 GMT].
Please see documentation for more information on scheduling software updates:
https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html."
}
}
```
### サービスソフトウェア更新を再スケジュールしました
OpenSearch Service は、サービスソフトウェア更新が再スケジュールされたときに、このイベントを送信します。詳細については、「[オプションの更新と必須の更新](service-software.md#service-software-optional-required)」を参照してください。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version": "0",
"id": "01234567-0123-0123-0123-012345678901",
"detail-type": "Amazon OpenSearch Service Software Update Notification",
"source": "aws.es",
"account": "123456789012",
"time": "2016-11-01T13:12:22Z",
"region": "us-east-1",
"resources": ["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail": {
"event": "Service Software Update",
"status": "Rescheduled",
"severity": "High",
"description": "The service software update [R20200330-p1], which was originally scheduled for
[21st May 2023 12:40 GMT], has been rescheduled to [23rd May 2023 12:40 GMT].
Please see documentation for more information on scheduling software updates:
https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html."
}
}
```
### サービスソフトウェア更新が開始しました
OpenSearch Service は、サービスソフトウェア更新が開始したときに、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version": "0",
"id": "01234567-0123-0123-0123-012345678901",
"detail-type": "Amazon OpenSearch Service Software Update Notification",
"source": "aws.es",
"account": "123456789012",
"time": "2016-11-01T13:12:22Z",
"region": "us-east-1",
"resources": ["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail": {
"event": "Service Software Update",
"status": "Started",
"severity": "Informational",
"description": "Service software update [R20200330-p1] started.
}
}
```
### サービスソフトウェアの更新が完了しました
OpenSearch Service は、サービスソフトウェアの更新が完了したときに、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version": "0",
"id": "01234567-0123-0123-0123-012345678901",
"detail-type": "Amazon OpenSearch Service Software Update Notification",
"source": "aws.es",
"account": "123456789012",
"time": "2016-11-01T13:12:22Z",
"region": "us-east-1",
"resources": ["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail": {
"event": "Service Software Update",
"status": "Completed",
"severity": "Informational",
"description": "Service software update [R20200330-p1] completed."
}
}
```
### サービスソフトウェア更新をキャンセルしました
OpenSearch Service は、サービスソフトウェア更新がキャンセルされたときに、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version": "0",
"id": "01234567-0123-0123-0123-012345678901",
"detail-type": "Amazon OpenSearch Service Software Update Notification",
"source": "aws.es",
"account": "123456789012",
"time": "2016-11-01T13:12:22Z",
"region": "us-east-1",
"resources": ["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail": {
"event": "Service Software Update",
"status": "Cancelled",
"severity": "Informational",
"description": "The scheduled service software update [R20200330-p1] has been cancelled as a
newer update is available. Please schedule the latest update."
}
}
```
### スケジュールされたサービスソフトウェア更新をキャンセルしました
OpenSearch Service は、ドメインに対して以前に予定されていたサービスソフトウェア更新がキャンセルされたときに、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version": "0",
"id": "01234567-0123-0123-0123-012345678901",
"detail-type": "Amazon OpenSearch Service Software Update Notification",
"source": "aws.es",
"account": "123456789012",
"time": "2016-11-01T13:12:22Z",
"region": "us-east-1",
"resources": ["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail": {
"event": "Service Software Update",
"status": "Cancelled",
"severity": "Informational",
"description": "The scheduled service software update [R20200330-p1] has been cancelled."
}
}
```
### サービスソフトウェア更新が実行されませんでした
OpenSearch Service は、サービスソフトウェア更新が開始できないときに、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version": "0",
"id": "01234567-0123-0123-0123-012345678901",
"detail-type": "Amazon OpenSearch Service Software Update Notification",
"source": "aws.es",
"account": "123456789012",
"time": "2016-11-01T13:12:22Z",
"region": "us-east-1",
"resources": ["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail": {
"event": "Service Software Update",
"status": "Unexecuted",
"severity": "Informational",
"description": "The scheduled service software update [R20200330-p1] cannot be started. Reason: [reason]"
}
}
```
### サービスソフトウェアの更新に失敗しました
OpenSearch Service は、サービスソフトウェア更新が失敗したときに、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version": "0",
"id": "01234567-0123-0123-0123-012345678901",
"detail-type": "Amazon OpenSearch Service Software Update Notification",
"source": "aws.es",
"account": "123456789012",
"time": "2016-11-01T13:12:22Z",
"region": "us-east-1",
"resources": ["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail": {
"event": "Service Software Update",
"status": "Failed",
"severity": "High",
"description": "Installation of service software update [R20200330-p1] failed. [reason].
}
}
```
### サービスソフトウェア更新が必要
OpenSearch Service は、サービスソフトウェア更新が必要なときに、このイベントを送信します。詳細については、「[オプションの更新と必須の更新](service-software.md#service-software-optional-required)」を参照してください。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version": "0",
"id": "01234567-0123-0123-0123-012345678901",
"detail-type": "Amazon OpenSearch Service Software Update Notification",
"source": "aws.es",
"account": "123456789012",
"time": "2016-11-01T13:12:22Z",
"region": "us-east-1",
"resources": ["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail": {
"event": "Service Software Update",
"status": "Required",
"severity": "High",
"description": "Service software update [R20200330-p1] available. Update
will be automatically installed after [21st May 2023] if no
action is taken. Service Software Deployment Mechanism: Blue/Green.
For more information on deployment configuration, please see:
https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes.html"
}
}
```
## Auto-Tune イベント
OpenSearch Service は、次の [Auto-Tune](auto-tune.md) イベントのいずれかが発生したときに、EventBridge にイベントを送信します。
### Auto-Tune 保留中
OpenSearch Service は、Auto-Tune がクラスターのパフォーマンスと可用性を改善するためのチューニングの推奨事項を特定したときに、このイベントを送信します。このイベントは、Auto-Tune が無効になっているドメインに対してのみ表示されます。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version": "0",
"id": "3acb26c8-397c-4c89-a80a-ce672a864c55",
"detail-type": "Amazon OpenSearch Service Auto-Tune Notification",
"source": "aws.es",
"account": "123456789012",
"time": "2020-10-30T22:06:31Z",
"region": "us-east-1",
"resources": ["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail": {
"event": "Auto-Tune Event",
"severity": "Informational",
"status": "Pending",
"description": "Auto-Tune recommends the following new settings for your domain: { JVM Heap size : 60%}. Enable Auto-Tune to improve cluster stability and performance.",
"scheduleTime": "{iso8601-timestamp}"
}
}
```
### Auto-Tune が開始されました
OpenSearch Service は、Auto-Tune がドメインに新しい設定を適用し始めたときに、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version": "0",
"id": "3acb26c8-397c-4c89-a80a-ce672a864c55",
"detail-type": "Amazon OpenSearch Service Auto-Tune Notification",
"source": "aws.es",
"account": "123456789012",
"time": "2020-10-30T22:06:31Z",
"region": "us-east-1",
"resources": ["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail": {
"event": "Auto-Tune Event",
"severity": "Informational",
"status": "Started",
"scheduleTime": "{iso8601-timestamp}",
"startTime": "{iso8601-timestamp}",
"description" : "Auto-Tune is applying the following settings to your domain: { JVM Heap size : 60%}."
}
}
```
### Auto-Tune には、スケジュールされた Blue/Green のデプロイが必要です。
OpenSearch Service は、スケジュールされた Blue/Green のデプロイを必要とするチューニングの推奨事項を Auto-Tune が特定したときに、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version": "0",
"id": "3acb26c8-397c-4c89-a80a-ce672a864c55",
"detail-type": "Amazon OpenSearch Service Auto-Tune Notification",
"source": "aws.es",
"account": "123456789012",
"time": "2020-10-30T22:06:31Z",
"region": "us-east-1",
"resources": ["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail": {
"event": "Auto-Tune Event",
"severity": "Low",
"status": "Pending",
"startTime": "{iso8601-timestamp}",
"description": "Auto-Tune has identified the following settings for your domain that require a blue/green deployment: { JVM Heap size : 60%}.
You can schedule the deployment for your preferred time."
}
}
```
### Auto-Tune がキャンセルされました
OpenSearch Service は、保留中のチューニングの推奨事項がないために Auto-Tune スケジュールがキャンセルされたときに、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version": "0",
"id": "3acb26c8-397c-4c89-a80a-ce672a864c55",
"detail-type": "Amazon OpenSearch Service Auto-Tune Notification",
"source": "aws.es",
"account": "123456789012",
"time": "2020-10-30T22:06:31Z",
"region": "us-east-1",
"resources": ["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail": {
"event": "Auto-Tune Event",
"severity": "Low",
"status": "Cancelled",
"scheduleTime": "{iso8601-timestamp}",
"description": "Auto-Tune has cancelled the upcoming blue/green deployment."
}
}
```
### 自動チューニングが完了しました
OpenSearch Service は、Auto-Tune が Blue/Green のデプロイを完了し、クラスターが新しい JVM 設定を用いてオペレーション可能になったときに、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version": "0",
"id": "3acb26c8-397c-4c89-a80a-ce672a864c55",
"detail-type": "Amazon OpenSearch Service Auto-Tune Notification",
"source": "aws.es",
"account": "123456789012",
"time": "2020-10-30T22:06:31Z",
"region": "us-east-1",
"resources": ["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail": {
"event": "Auto-Tune Event",
"severity": "Informational",
"status": "Completed",
"completionTime": "{iso8601-timestamp}",
"description": "Auto-Tune has completed the blue/green deployment and successfully applied the following settings: { JVM Heap size : 60%}."
}
}
```
### Auto-Tune が無効になり、変更が元に戻されました
OpenSearch Service は、Auto-Tune が無効になっており、適用された変更がロールバックされたときに、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version": "0",
"id": "3acb26c8-397c-4c89-a80a-ce672a864c55",
"detail-type": "Amazon OpenSearch Service Auto-Tune Notification",
"source": "aws.es",
"account": "123456789012",
"time": "2020-10-30T22:06:31Z",
"region": "us-east-1",
"resources": [ "arn:aws:es:us-east-1:123456789012:domain/test-domain" ],
"detail": {
"event": "Auto-Tune Event",
"severity": "Informational",
"status": "Completed",
"description": "Auto-Tune is now disabled. All settings have been reverted. Auto-Tune will continue to evaluate
cluster performance and provide recommendations.",
"completionTime": "{iso8601-timestamp}"
}
}
```
### Auto-Tune が無効になり、変更が保持されました
OpenSearch Service は、Auto-Tune が無効になっており、適用された変更が保持されたときに、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version": "0",
"id": "3acb26c8-397c-4c89-a80a-ce672a864c55",
"detail-type": "Amazon OpenSearch Service Auto-Tune Notification",
"source": "aws.es",
"account": "123456789012",
"time": "2020-10-30T22:06:31Z",
"region": "us-east-1",
"resources": ["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail": {
"event": "Auto-Tune Event",
"severity": "Informational",
"status": "Completed",
"description": "Auto-Tune is now disabled. The most-recent settings by Auto-Tune have been retained.
Auto-Tune will continue to evaluate cluster performance and provide recommendations.",
"completionTime": "{iso8601-timestamp}"
}
}
```
## クラスターヘルスイベント
OpenSearch サービスは、クラスターのヘルスが侵害されると、特定のイベントを EventBridge に送信します。
### 赤いクラスターの復旧が開始しました
OpenSearch Service は、クラスターのステータスが赤になってから連続して 1 時間以上が経過した後に、このイベントを送信します。クラスタステータスを修正するために、スナップショットから赤いインデックスの自動復元が試行されます。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service Cluster Status Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2016-11-01T13:12:22Z",
"region":"us-east-1",
"resources":[
"arn:aws:es:us-east-1:123456789012:domain/test-domain"
],
"detail":{
"event":"Automatic Snapshot Restore for Red Indices",
"status":"Started",
"severity":"High",
"description":"Your cluster status is red. We have started automatic snapshot restore for the red indices.
No action is needed from your side. Red indices [red-index-0, red-index-1]"
}
}
```
### 赤いクラスタの復旧が部分的に完了しました
OpenSearch Service は、赤いクラスターステータスを修正する際、スナップショットから赤いインデックスのサブセットのみを復元できたときに、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service Cluster Status Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2016-11-01T13:12:22Z",
"region":"us-east-1",
"resources":[
"arn:aws:es:us-east-1:123456789012:domain/test-domain"
],
"detail":{
"event":"Automatic Snapshot Restore for Red Indices",
"status":"Partially Restored",
"severity":"High",
"description":"Your cluster status is red. We were able to restore the following Red indices from
snapshot: [red-index-0]. Indices not restored: [red-index-1]. Please refer https://docs.aws.amazon.com/opensearch-service/latest/developerguide/handling-errors.html#handling-errors-red-cluster-status for troubleshooting steps."
}
}
```
### 赤いクラスターの復旧に失敗しました
OpenSearch Service は、赤いクラスターステータスを修正する際、スナップショットから赤いインデックスのサブセットのみを復元できたときに、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service Cluster Status Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2016-11-01T13:12:22Z",
"region":"us-east-1",
"resources":[
"arn:aws:es:us-east-1:123456789012:domain/test-domain"
],
"detail":{
"event":"Automatic Snapshot Restore for Red Indices",
"status":"Failed",
"severity":"High",
"description":"Your cluster status is red. We were unable to restore the Red indices automatically.
Indices not restored: [red-index-0, red-index-1]. Please refer https://docs.aws.amazon.com/opensearch-service/latest/developerguide/handling-errors.html#handling-errors-red-cluster-status for troubleshooting steps."
}
}
```
### 削除するシャード
OpenSearch Service は、14 日間連続して赤いままのクラスターステータスの自動修正を試み、1 つ以上のインデックスが赤のままのときに、このイベントを送信します。さらに 7 日後 (赤のステータスになってから連続して 21 日後)、OpenSearch Service は、すべての赤いインデックスの[割り当てられていないシャードを削除](#monitoring-events-red-deleted)します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service Cluster Status Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2022-04-09T10:36:48Z",
"region":"us-east-1",
"resources":[
"arn:aws:es:us-east-1:123456789012:domain/test-domain"
],
"detail":{
"severity":"Medium",
"description":"Your cluster status is red. Please fix the red indices as soon as possible.
If not fixed by 2022-04-12 01:51:47+00:00, we will delete all unassigned shards,
the unit of storage and compute, for these red indices to recover your domain and make it green.
Please refer to https://docs.aws.amazon.com/opensearch-service/latest/developerguide/handling-errors.html#handling-errors-red-cluster-status for troubleshooting steps.
test_data, test_data1",
"event":"Automatic Snapshot Restore for Red Indices",
"status":"Shard(s) to be deleted"
}
}
```
### シャードが削除されました
OpenSearch Service は、クラスターステータスが赤になってから連続して 21 日以上が経過した後に、このイベントを送信します。すべての赤いインデックスの未割り当てシャード (ストレージとコンピューティング) が削除されます。詳細については、「[赤いクラスターの自動修復](handling-errors.md#handling-errors-red-cluster-status-auto-recovery)」を参照してください。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service Cluster Status Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2022-04-09T10:54:48Z",
"region":"us-east-1",
"resources":[
"arn:aws:es:us-east-1:123456789012:domain/test-domain"
],
"detail":{
"severity":"High",
"description":"We have deleted unassinged shards, the unit of storage and compute, in
red indices: index-1, index-2 because these indices were red for more than
21 days and could not be restored with the automated restore process.
Please refer to https://docs.aws.amazon.com/opensearch-service/latest/developerguide/handling-errors.html#handling-errors-red-cluster-status for troubleshooting steps.",
"event":"Automatic Snapshot Restore for Red Indices",
"status":"Shard(s) deleted"
}
}
```
### シャードカウントが高い警告
OpenSearch Service は、ホットデータノードの平均シャード数が、推奨されるデフォルト制限の 1,000 の 90% を超えた場合に、このイベントを送信します。Elasticsearch および OpenSearch の以降のバージョンでは、ノードあたりのシャード数の制限を設定できますが、ノードあたり 1,000 シャード以下です。[シャード数の選択](bp-sharding.md)を参照してください。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2016-11-01T13:12:22Z",
"region":"us-east-1",
"resources":["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail":{
"event":"High Shard Count",
"status":"Warning",
"severity":"Low",
"description":"One or more data nodes have close to 1000 shards. To ensure optimum performance and stability of your
cluster, please refer to the best practice guidelines - https://docs.aws.amazon.com/opensearch-service/latest/developerguide/sizing-domains.html#bp-sharding."
}
}
```
### シャード数の制限を超えました
OpenSearch Service は、ホットデータノードの平均シャード数が、推奨されるデフォルト制限の 1,000 を超えた場合に、このイベントを送信します。Elasticsearch および OpenSearch の以降のバージョンでは、ノードあたりのシャード数の制限を設定できますが、ノードあたり 1,000 シャード以下です。[シャード数の選択](bp-sharding.md)を参照してください。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2016-11-01T13:12:22Z",
"region":"us-east-1",
"resources":["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail":{
"event":"High Shard Count",
"status":"Warning",
"severity":"Medium",
"description":"One or more data nodes have more than 1000 shards. To ensure optimum performance and stability of your
cluster, please refer to the best practice guidelines - https://docs.aws.amazon.com/opensearch-service/latest/developerguide/sizing-domains.html#bp-sharding."
}
}
```
### ディスク容量の不足
OpenSearch Service は、クラスター内の 1 つ以上のノードが使用可能なストレージ領域の 25% 未満、または 25 GB 未満の場合にこのイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2017-12-01T13:12:22Z",
"region":"us-east-1",
"resources":["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail":{
"event":"Low Disk Space",
"status":"Warning",
"severity":"Medium",
"description":"One or more data nodes in your cluster has less than 25% of storage space or less than 25GB.
Your cluster will be blocked for writes at 20% or 20GB. Please refer to the documentation for more information - https://docs.aws.amazon.com/opensearch-service/latest/developerguide/handling-errors.html#troubleshooting-cluster-block"
}
}
```
### 低ディスクウォーターマーク超過
OpenSearch Service は、クラスター内のすべてのノードで利用可能なストレージ領域が 10% 未満になった、または 10 GB 未満になったときにこのイベントを送信します。すべてのノードが低ディスクウォーターマークを超過すると、新しいインデックスは黄色のクラスターになり、すべてのノードが高ディスクウォーターマークを下回ると、赤色のクラスターになります。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2017-12-01T13:12:22Z",
"region":"us-east-1",
"resources":["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail":{
"event":"Low Disk Watermark Breach",
"status":"Warning",
"severity":"Medium",
"description":"Low Disk Watermark threshold is about to be breached. Once the threshold is breached, new index creation will be blocked on all
nodes to prevent the cluster status from turning red. Please increase disk size to suit your storage needs. For more information,
see https://docs.aws.amazon.com/opensearch-service/latest/developerguide/handling-errors.html#troubleshooting-cluster-block".
}
}
```
### EBS バーストバランスが 70% 未満
OpenSearch Service は、1 つ以上のデータノードで EBS バーストバランスが 70% を下回ったときにこのイベントを送信します。EBS バーストバランスが枯渇すると、クラスターが広範囲にわたって使用できなくなり、I/O リクエストがスロットリングされ、インデックス作成や検索リクエストのレイテンシーが高くなり、タイムアウトが発生する可能性があります。この問題を修正するステップについては、「[低 EBS バーストバランス](handling-errors.md#handling-errors-low-ebs-burst)」を参照してください。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2017-12-01T13:12:22Z",
"region":"us-east-1",
"resources":["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail":{
"event":"EBS Burst Balance",
"status":"Warning",
"severity":"Medium",
"description":"EBS burst balance on one or more data nodes is below 70%.
Follow https://docs.aws.amazon.com/opensearch-service/latest/developerguide/handling-errors.html#handling-errors-low-ebs-burst
to fix this issue."
}
}
```
### EBS バーストバランスが 20% 未満
OpenSearch Service は、1 つ以上のデータノードで EBS バーストバランスが 20% を下回ったときにこのイベントを送信します。EBS バーストバランスが枯渇すると、クラスターが広範囲にわたって使用できなくなり、I/O リクエストがスロットリングされ、インデックス作成や検索リクエストのレイテンシーが高くなり、タイムアウトが発生する可能性があります。この問題を修正するステップについては、「[低 EBS バーストバランス](handling-errors.md#handling-errors-low-ebs-burst)」を参照してください。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2017-12-01T13:12:22Z",
"region":"us-east-1",
"resources":["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail":{
"event":"EBS Burst Balance",
"status":"Warning",
"severity":"High",
"description":"EBS burst balance on one or more data nodes is below 20%.
Follow https://docs.aws.amazon.com/opensearch-service/latest/developerguide/handling-errors.html#handling-errors-low-ebs-burst
to fix this issue.
}
}
```
### ディスクスループットのスロットリング
OpenSearch Service は、EBS ボリュームまたは EC2 インスタンスのスループット制限を理由として、ドメインへの読み取りおよび書き込みリクエストがスロットリングされているときに、このイベントを送信します。この通知を受け取った場合は、 AWS 推奨されるベストプラクティスに従ってボリュームまたはインスタンスをスケールアップすることを検討してください。ボリュームタイプが `gp2` の場合は、ボリュームサイズを大きくします。ボリュームタイプが `gp3` の場合は、より多くのスループットをプロビジョニングします。また、インスタンスベースと最大 EBS スループットがプロビジョニングされたボリュームスループット以上であることを確認し、それに応じてスケールアップすることもできます。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2017-12-01T13:12:22Z",
"region":"us-east-1",
"resources":["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail":{
"event":"Disk Throughput Throttle",
"status":"Warning",
"severity":"Medium",
"description":"Your domain is experiencing throttling due to instance or volume throughput limitations.
Please consider scaling your domain to suit your throughput needs. In July 2023, we improved
the accuracy of throughput throttle calculation by replacing ‘Max volume throughput’ with
‘Provisioned volume throughput’. Please refer to the documentation for more information."
}
}
```
### 大きなシャードサイズ
OpenSearch Service は、クラスター内の 1 つ以上のシャードが 50 GiB または 65 GiB を超えたときにこのイベントを送信します。クラスターのパフォーマンスと安定性を最適化するには、シャードサイズを減らします。
詳細については、「[sharding best practices](bp.md#bp-sharding-strategy)」を参照してください。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2017-12-01T13:12:22Z",
"region":"us-east-1",
"resources":["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail":{
"event":"Large Shard Size",
"status":"Warning",
"severity":"Medium",
"description":"One or more shards are larger than 65GiB. To ensure optimum cluster performance and stability, reduce shard sizes.
For more information, see https://docs.aws.amazon.com/opensearch-service/latest/developerguide/monitoring-events.html#monitoring-events-large-shard-size."
}
}
```
### 高い JVM 使用率
OpenSearch Service は、ドメインの `JVMMemoryPressure` メトリクスが 80% を超えたときにこのイベントを送信します。30 分間で 92% を超えると、クラスターに対するすべての書き込みオペレーションがブロックされます。クラスターの最適な安定性を確保するには、クラスターへのトラフィックを減らすか、またはドメインをスケールしてワークロードに十分なメモリを提供します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2017-12-01T13:12:22Z",
"region":"us-east-1",
"resources":["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail":{
"event":"High JVM Usage",
"status":"Warning",
"severity":"High",
"description":"JVM memory pressure has exceeded 80%. If it exceeds 92% for 30 minutes, all write operations to your cluster
will be blocked. To ensure optimum cluster stability, reduce traffic to the cluster or use larger instance types.
For more information, see https://docs.aws.amazon.com/opensearch-service/latest/developerguide/monitoring-events.html#monitoring-events-high-jvm."
}
}
```
### GC が不足している
OpenSearch Service は、最大 JVM が 70% を超え、最大値と最小値の差が 30% 未満の場合にこのイベントを送信します。これは、JVM がワークロード用のガベージコレクションサイクル中に十分なメモリを再利用できないことを示唆している可能性があります。これにより、レスポンスがますます遅くなり、レイテンシーが高くなる可能性があります。また場合によっては、ヘルスチェックのタイムアウトによりノードがドロップすることさえあります。クラスターの最適な安定性を確保するには、クラスターへのトラフィックを減らすか、またはドメインをスケールしてワークロードに十分なメモリを提供します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2017-12-01T13:12:22Z",
"region":"us-east-1",
"resources":["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail":{
"event":"Insufficient GC",
"status":"Warning",
"severity":"Medium",
"description":"Maximum JVM is above 70% and JVM range is less than 30%. This may indicate insufficient garbage collection for your workload.
For more information, see https://docs.aws.amazon.com/opensearch-service/latest/developerguide/monitoring-events.html#monitoring-events-insufficient-gc."
}
}
```
### カスタムインデックスルーティングの警告
OpenSearch Service は、ドメインが処理状態にあり、ブルー/グリーンデプロイが停止する原因となり得る index.routing.allocation のカスタム設定を持つインデックスが含まれているときにこのイベントを送信します。設定が適切に適用されていることを確認します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2017-12-01T13:12:22Z",
"region":"us-east-1",
"resources":["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail":{
"event":"Custom Index Routing Warning",
"status":"Warning",
"severity":"Medium",
"description":"Your domain is in processing state and contains indice(s) with custom index.routing.allocation
settings which can cause blue-green deployments to get stuck. Verify settings are applied properly.
For more information, see https://docs.aws.amazon.com/opensearch-service/latest/developerguide/monitoring-events.html#monitoring-events-index-routing."
}
}
```
### シャードロックの失敗
OpenSearch Service は、`[ShardLockObtainFailedException]` を含むシャードが割り当てられていないことを理由としてドメインが異常な状態である場合にこのイベントを送信します。詳細については、「[Amazon OpenSearch Service のインメモリシャードロックの例外を解決するにはどうすればよいですか?](https://aws.amazon.com/premiumsupport/knowledge-center/opensearch-in-memory-shard-lock/)」を参照してください。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2017-12-01T13:12:22Z",
"region":"us-east-1",
"resources":["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail":{
"event":"Failed Shard Lock",
"status":"Warning",
"severity":"Medium",
"description":"Your domain is unhealthy due to unassigned shards with [ShardLockObtainFailedException]. For more information,
see https://docs.aws.amazon.com/opensearch-service/latest/developerguide/monitoring-events.html#monitoring-events-failed-shard-lock."
}
```
## VPC エンドポイントイベント
OpenSearch Service では、[AWS PrivateLink インターフェイスエンドポイント](vpc-interface-endpoints.md)に関連する EventBridge に特定のイベントを送信します。
### VPC エンドポイントが作成できない
OpenSearch Service は、リクエストされた VPC エンドポイントを作成できない場合、このイベントを送信します。このエラーは、1 つのリージョンで許可される VPC エンドポイントの数の制限に到達したために発生することがあります。このエラーは、指定されたサブネットまたはセキュリティグループが存在しない場合にも表示されます。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service VPC Endpoint Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2016-11-01T13:12:22Z",
"region":"us-east-1",
"resources":[
"arn:aws:es:us-east-1:123456789012:domain/test-domain"
],
"detail":{
"event":"VPC Endpoint Create Validation",
"status":"Failed",
"severity":"High",
"description":"Unable to create VPC endpoint aos-0d4c74c0342343 for domain
arn:aws:es:eu-south-1:123456789012:domain/my-domain due to the following validation failures: You've reached the limit on the
number of VPC endpoints that you can create in the AWS Region."
}
}
```
### VPC エンドポイントが更新できない
OpenSearch Service は、リクエストされた VPC エンドポイントを削除できない場合、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service VPC Endpoint Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2016-11-01T13:12:22Z",
"region":"us-east-1",
"resources":[
"arn:aws:es:us-east-1:123456789012:domain/test-domain"
],
"detail":{
"event":"VPC Endpoint Update Validation",
"status":"Failed",
"severity":"High",
"description":"Unable to update VPC endpoint aos-0d4c74c0342343 for domain
arn:aws:es:eu-south-1:123456789012:domain/my-domain due to the following validation failures: ."
}
}
```
### VPC エンドポイントが削除できない
OpenSearch Service は、リクエストされた VPC エンドポイントを削除できない場合、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service VPC Endpoint Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2016-11-01T13:12:22Z",
"region":"us-east-1",
"resources":[
"arn:aws:es:us-east-1:123456789012:domain/test-domain"
],
"detail":{
"event":"VPC Endpoint Delete Validation",
"status":"Failed",
"severity":"High",
"description":"Unable to delete VPC endpoint aos-0d4c74c0342343 for domain
arn:aws:es:eu-south-1:123456789012:domain/my-domain due to the following validation failures: Specified subnet doesn't exist."
}
}
```
## ノードの廃止イベント
OpenSearch Service は、以下にあるノードの廃止イベントのいずれかが発生したときに、EventBridge にイベントを送信します。
### ノードの廃止をスケジュールしました
OpenSearch Service は、ノードの廃止がスケジュールされたときに、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version": "0",
"id": "01234567-0123-0123-0123-012345678901",
"detail-type": "Amazon OpenSearch Service Notification",
"source": "aws.es",
"account": "123456789012",
"time": "2023-04-07T10:07:33Z",
"region": "us-east-1",
"resources": ["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail": {
"event": "Node Retirement Notification",
"status": "Scheduled",
"severity": "Medium",
"description": "An automated action to retire and replace a node has been scheduled on your domain.
The node will be replaced in the next off-peak window. For more information, see
https://docs.aws.amazon.com/opensearch-service/latest/developerguide/monitoring-events.html."
}
}
```
### ノードの廃止が完了しました
OpenSearch Service は、ノードの廃止が完了したときに、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version": "0",
"id": "01234567-0123-0123-0123-012345678901",
"detail-type": "Amazon OpenSearch Service Notification",
"source": "aws.es",
"account": "123456789012",
"time": "2023-04-07T10:07:33Z",
"region": "us-east-1",
"resources": ["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail": {
"event": "Node Retirement Notification",
"status": "Completed",
"severity": "Medium",
"description": "The node has been retired and replaced with a new node."
}
}
```
### ノードの廃止に失敗しました
OpenSearch Service は、ノードの廃止が失敗したときに、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version": "0",
"id": "01234567-0123-0123-0123-012345678901",
"detail-type": "Amazon OpenSearch Service Notification",
"source": "aws.es",
"account": "123456789012",
"time": "2023-04-07T10:07:33Z",
"region": "us-east-1",
"resources": ["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail": {
"event": "Node Retirement Notification",
"status": "Failed",
"severity": "Medium",
"description": "Node retirement failed. No actions are required from your end. We will automatically
retry replacing the node."
}
}
```
## デグレードされたノードの廃止イベント
OpenSearch Service は、ノード上のハードウェアのデグレードによりノードの交換が必要な場合に、これらのイベントを送信します。
### デグレードされたノードの廃止通知
OpenSearch Service は、デグレードされたノードを廃止して置き換える自動アクションがドメインにスケジュールされたときに、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"db233454-aad1-7676-3b15-10a84b052baa",
"detail-type":"Amazon OpenSearch Service Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2024-01-11T08:16:06Z",
"region":"us-east-1",
"resources":[
"arn:aws:es:us-east-1:123456789012:domain/test-node-replacement"
],
"detail":{
"severity":"Medium",
"description":"An automated action to retire and replace a node has been scheduled on your domain. For more information, please see https://docs.aws.amazon.com/opensearch-service/latest/developerguide/monitoring-events.html.",
"event":"Degraded Node Retirement Notification",
"status":"Scheduled"
}
}
```
### デグレードされたノードの廃止を完了しました
OpenSearch Service は、デグレードされたノードが廃止され、新しいノードに置き換えられたときにこのイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"7444215c-90f9-a52d-bcda-e85973a9a762",
"detail-type":"Amazon OpenSearch Service Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2024-01-11T10:20:30Z",
"region":"us-east-1",
"resources":[
"arn:aws:es:us-east-1:123456789012:domain/test-node-replacement"
],
"detail":{
"severity":"Medium",
"description":"The node has been retired and replaced with a new node.",
"event":"Degraded Node Retirement Notification",
"status":"Completed"
}
}
```
### デグレードされたノードの廃止に失敗しました
OpenSearch Service は、デグレードされたノードの廃止が失敗したときに、このイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"c328e9bb-93b9-c0b2-b17a-df527fdf96b6",
"detail-type":"Amazon OpenSearch Service Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2024-01-11T08:31:38Z",
"region":"us-east-1",
"resources":[
"arn:aws:es:us-east-1:123456789012:domain/test-node-replacement"
],
"detail":{
"severity":"Medium",
"description":"Node retirement failed. No actions are required from your end. We will automatically re-try replacing the node.",
"event":"Degraded Node Retirement Notification",
"status":"Failed"
}
}
```
## ドメインエラーイベント
OpenSearch Service は、次のドメインエラーのいずれかが発生したときに、EventBridge にイベントを送信します。
### ドメイン更新の検証エラー
OpenSearch Service は、ドメインで更新または設定変更の実行を試行した際に 1 つ以上の検証エラーが発生した場合にこのイベントを送信します。これらの障害を解決するためのステップについては、「[検証エラーのトラブルシューティング](managedomains-configuration-changes.md#validation)」を参照してください。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service Domain Update Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2016-11-01T13:12:22Z",
"region":"us-east-1",
"resources":[
"arn:aws:es:us-east-1:123456789012:domain/test-domain"
],
"detail":{
"event":"Domain Update Validation",
"status":"Failed",
"severity":"High",
"description":"Unable to perform updates to your domain due to the following validation failures:
Please see the documentation for more information https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes.html#validation"
}
}
```
### KMS キーにアクセスできない
OpenSearch Service は、[AWS KMS キーにアクセスできない](encryption-at-rest.md#disabled-key)ときにこのイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Domain Error Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2016-11-01T13:12:22Z",
"region":"us-east-1",
"resources":["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail":{
"event":"KMS Key Inaccessible",
"status":"Error",
"severity":"High",
"description":"The KMS key associated with this domain is inaccessible. You are at risk of losing access to your domain.
For more information, please refer to https://docs.aws.amazon.com/opensearch-service/latest/developerguide/encryption-at-rest.html#disabled-key."
}
}
```
### ドメインの分離
OpenSearch Service は、ドメインが分離されてネットワークからアクセスできないためにリクエストの受信、読み取り、または書き込みができなくなったときにこのイベントを送信します。
**例**
このタイプのイベントの例を以下に示します。
```
{
"version":"0",
"id":"01234567-0123-0123-0123-012345678901",
"detail-type":"Amazon OpenSearch Service Notification",
"source":"aws.es",
"account":"123456789012",
"time":"2023-11-01T13:12:22Z",
"region":"us-east-1",
"resources":["arn:aws:es:us-east-1:123456789012:domain/test-domain"],
"detail":{
"event":"Domain Isolation Notification",
"status":"Error",
"severity":"High",
"description":"Your OpenSearch Service domain has been isolated. An isolated domain is unreachable by network and cannot receive, read, or write requests. For more information and assistance, please contact AWS Support at https://docs.aws.amazon.com/opensearch-service/latest/developerguide/encryption-at-rest.html#disabled-key."
}
}
```
# チュートリアル: Amazon OpenSearch Service EventBridge イベントをリッスンする
このチュートリアルでは、Amazon OpenSearch Service イベントをリッスンし、CloudWatch Logs ログストリームに書き込むシンプルな AWS Lambda 関数を設定します。
## 前提条件
このチュートリアルは、既存の OpenSearch Service ドメインがあることを前提としています。ドメインをまだ作成していない場合は、1 つ作成するために「[Amazon OpenSearch Service ドメインの作成と管理](createupdatedomains.md)」の手順に従います。
## ステップ 1: Lambda 関数を作成する
この手順では、OpenSearch Service イベントメッセージのターゲットとなるシンプルな Lambda 関数を作成します。
**ターゲットの Lambda 関数を作成するには**
1. [https://console.aws.amazon.com/lambda/](https://console.aws.amazon.com/lambda/) で AWS Lambda コンソールを開きます。
1. [**Lambda 関数の作成**]、[**一から作成**] の順に選択します。
1. [**関数名**] では、**event-handler** と入力します。
1. [**ランタイム**] では、[**Python 3.8**] を選択します。
1. **[Create function]** を選択します。
1. [**関数コード**] セクションで、以下の例に一致するようにサンプルコードを編集します。
```
import json
def lambda_handler(event, context):
if event["source"] != "aws.es":
raise ValueError("Function only supports input from events with a source type of: aws.es")
print(json.dumps(event))
```
これは、OpenSearch Service から送信されたイベントを印刷するシンプルな Python 3.8 関数です。すべてが正しく設定されると、このチュートリアルの最後に、この Lambda 関数に関連付けられている CloudWatch Logs ログストリームにイベントの詳細が表示されます。
1. **[デプロイ]** をクリックします。
## ステップ 2: イベントルールを登録する
このステップでは、OpenSearch Service ドメインからイベントをキャプチャする EventBridge ルールを作成します。このルールでは、それが定義されているアカウント内のすべてのイベントがキャプチャされます。イベントメッセージ自体に、イベントソースに関する情報 (イベントソースの送信元ドメインの情報など) が含まれています。この情報を使用して、プログラムでイベントをフィルタリングおよびソートできます。
**EventBridge ルールを作成するには**
1. EventBridge コンソール ([https://console.aws.amazon.com/events/](https://console.aws.amazon.com/events/)) を開きます。
1. [**ルールの作成**] を選択します。
1. ルールに **event-rule** と名前を付けます。
1. [**次へ**] を選択します。
1. イベントパターンの場合、[**AWS のサービス**]、[**Amazon OpenSearch Service**] 、[**すべてのイベント**] の順にクリックします。このパターンは、すべての OpenSearch Service ドメインおよびすべての OpenSearch Service イベントに適用されます。または、より具体的なパターンを作成し、一部の結果をフィルターで除外することもできます。
1. [**次へ**] を選択します。
1. ターゲットに [**Lambda 関数**] を選択します。機能ドロップダウンで [**イベントハンドラ**] を選択します。
1. [**次へ**] を選択します。
1. タグをスキップして [**次へ**] をクリックします。
1. 設定を確認して、[**ルールの作成**] を選択します。
## ステップ 3: 設定をテストする
次回 OpenSearch Service コンソールの**通知**セクションで通知を受け取ったときに、すべてが適切に設定されている場合、Lambda 関数がトリガーされ、関数の CloudWatch Logs ログストリームにイベントデータが書き込まれます。
**設定をテストするには**
1. CloudWatch コンソール [https://console.aws.amazon.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/) を開きます。
1. ナビゲーションペインで、[**ログ**] を選択して Lambda 関数 (**/aws/lambda/event-handler** など) のロググループを選択します。
1. イベントデータを表示するログストリームを選択します。
# チュートリアル: 利用可能なソフトウェア更新に関する Amazon SNS アラートの送信
このチュートリアルでは、Amazon OpenSearch Service で利用可能なサービスソフトウェア更新の通知をキャプチャし、 Amazon Simple Notification Service (Amazon SNS) を介して E メール通知を送信する Amazon EventBridge イベントルールを設定します。
## 前提条件
このチュートリアルは、既存の OpenSearch Service ドメインがあることを前提としています。ドメインをまだ作成していない場合は、1 つ作成するために「[Amazon OpenSearch Service ドメインの作成と管理](createupdatedomains.md)」の手順に従います。
## ステップ 1: Amazon SNS トピックを作成してサブスクライブする
新しいイベントルールのイベントターゲットとして使用する Amazon SNS トピックを設定します。
**Amazon SNS ターゲットを作成するには**
1. Amazon SNS コンソールの[https://console.aws.amazon.com/sns/v3/home](https://console.aws.amazon.com/sns/v3/home)を開いてください。
1. [**トピック**] および [**トピックの作成**] を選択します。
1. ジョブタイプでは、[**標準**] を選択し、ジョブに **software-update** と名前を付けます。
1. **[トピックを作成]** を選択します。
1. トピックが作成されたら、[**サブスクリプションの作成**] を選択します。
1. [**プロトコル**] で [**E メール**] を選択します。[**Endpoint (エンドポイント)**] では、現在アクセスできるメールアドレスを入力し、[**Create subscription (サブスクリプションの作成)**] を選択します。
1. メールアカウントを確認し、サブスクリプションの確認メールメッセージが届くのを待ちます。確認メールが届いたら、[**サブスクリプションの確認**] を選択します。
## ステップ 2: イベントルールを登録する
次に、サービスソフトウェア更新イベントのみをキャプチャするイベントルールを登録します。
**イベントルールを作成するには**
1. EventBridge コンソール ([https://console.aws.amazon.com/events/](https://console.aws.amazon.com/events/)) を開きます。
1. [**ルールの作成**] を選択します。
1. ルールに **softwareupdate-rule** と名前を付けます。
1. [**次へ**] を選択します。
1. イベントパターンの場合、**[AWS のサービス]**、**[Amazon OpenSearch Service (マネージドクラスター)]**、**[Amazon OpenSearch Service ソフトウェアの更新通知]** の順に選択します。このパターンは、OpenSearch Service からのサービスソフトウェアアップデートイベントに一致します。イベントパターンの詳細については、*Amazon EventBridge ユーザーガイド*の「[Amazon EventBridge イベントパターン](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html)」を参照してください。
1. 特定の重大度のみをフィルターできます (オプション)。各イベントの重大度については、「[サービスソフトウェア更新イベント](monitoring-events.md#monitoring-events-sso)」を参照してください。
1. [**次へ**] を選択します。
1. ターゲットに [**SNS トピック**] を選択し、[**software-update**] (ソフトウェア更新) を選択します。
1. [**次へ**] を選択します。
1. タグをスキップして [**次へ**] を選択します。
1. ルールの設定を確認して、[**ルールの作成**] を選択します。
次回 OpenSearch Service から利用可能なサービスソフトウェアの更新に関する通知を受け取ったときに、すべてが適切に設定されている場合、Amazon SNS は更新に関するアラートを E メールで送信します。
# を使用した Amazon OpenSearch Service API コールのモニタリング AWS CloudTrail
Amazon OpenSearch Service は AWS CloudTrail、OpenSearch Service のユーザー、ロール、または のサービスによって実行されたアクションを記録する AWS サービスである と統合されます。CloudTrail は、OpenSearch Service のすべての設定 API 呼び出しをイベントとしてキャプチャします。
**注記**
CloudTrail は、`CreateDomain` や `GetUpgradeStatus` などの、[Configuration API](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/Welcome.html) への呼び出しのみをキャプチャします。CloudTrail は、`_search` や `_bulk` などの、[OpenSearch API](supported-operations.md)への呼び出しをキャプチャしません。これらの呼び出しについては、「[Amazon OpenSearch Service での監査ログのモニタリング](audit-logs.md)」を参照してください。
キャプチャされた呼び出しには、OpenSearch Service コンソール AWS CLI、または AWS SDK からの呼び出しが含まれます。証跡を作成する場合は、OpenSearch Service のイベントなど、Amazon S3 バケットへの CloudTrail イベントの継続的な配信を有効にすることができます 証跡を設定しない場合でも、CloudTrail コンソールの [**Event history (イベント履歴)**] で最新のイベントを表示できます。CloudTrail で収集された情報を使用して、OpenSearch Service に対するリクエスト、リクエスト元の IP アドレス、リクエスト者、リクエスト日時などの詳細を確認できます。
CloudTrail の詳細については、「[AWS CloudTrail ユーザーガイド](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/)」を参照してください。
## CloudTrail での Amazon OpenSearch Service 情報
CloudTrail は、アカウントの作成 AWS アカウント 時に で有効になります。OpenSearch Service でアクティビティが発生すると、そのアクティビティはイベント**履歴**の他の AWS サービスイベントとともに CloudTrail イベントに記録されます。最近のイベントは、 AWS アカウント アカウントで表示、検索、ダウンロードできます。詳細については、「[CloudTrail Event 履歴でのイベントの表示](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html)」を参照してください。
OpenSearch Service のイベントなど、 AWS アカウント アカウント内のイベントの継続的な記録については、証跡を作成します。*証跡*により、CloudTrail はログファイルを Amazon S3 バケットに配信できます。デフォルトでは、コンソールで証跡を作成するときに、証跡がすべての AWS リージョンに適用されます。証跡は、 AWS パーティション内のすべてのリージョンからのイベントをログに記録し、指定した Amazon S3 バケットにログファイルを配信します。さらに、CloudTrail ログで収集されたイベントデータをさらに分析して処理するように他の AWS サービスを設定できます。詳細については次を参照してください:
+ [の証跡の作成 AWS アカウント](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-create-and-update-a-trail.html)
+ [AWS CloudTrail Logs との サービス統合](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-aws-service-specific-topics.html#cloudtrail-aws-service-specific-topics-integrations)
+ 「[CloudTrail の Amazon SNS 通知の設定](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/getting_notifications_top_level.html)」
+ [CloudTrail ログファイルを複数のリージョンから受け取る](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/receive-cloudtrail-log-files-from-multiple-regions.html)、[複数のアカウントから CloudTrail ログファイルを受け取る](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-receive-logs-from-multiple-accounts.html)
すべての OpenSearch Service 設定 API アクションは CloudTrail によってログに記録され、「[Amazon OpenSearch Service API リファレンス](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/Welcome.html)」に記載されています。
各イベントまたはログエントリには、誰がリクエストを生成したかという情報が含まれます。アイデンティティ情報は、以下を判別するのに役立ちます。
+ リクエストがルートまたは AWS Identity and Access Management (IAM) ユーザー認証情報を使用して行われたかどうか
+ リクエストの送信に使用された一時的なセキュリティ認証情報に、ロールとフェデレーテッドユーザーのどちらが使用されたか
+ リクエストが別の AWS サービスによって行われたかどうか
詳細については、「[CloudTrail userIdentity 要素](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-user-identity.html)」を参照してください。
## Amazon OpenSearch Service のログファイルエントリを理解する
「トレイル」は、指定した Amazon S3 バケットにイベントをログファイルとして配信するように設定できます。CloudTrail のログファイルは、単一か複数のログエントリを含みます。イベントは、任意の出典からの単一のリクエストを表し、リクエストされたアクション、アクションの日時、リクエストパラメータなどに関する情報が含まれます。CloudTrailログファイルは、パブリックAPIコールの順序付けられたスタックトレースではないため、特定の順序では表示されません。
`CreateDomain`オペレーションを示すCloudTrailログエントリの例は、次のとおりです。
```
{
"eventVersion": "1.05",
"userIdentity": {
"type": "IAMUser",
"principalId": "AIDACKCEVSQ6C2EXAMPLE",
"arn": "arn:aws:iam::123456789012:user/test-user",
"accountId": "123456789012",
"accessKeyId": "access-key",
"userName": "test-user",
"sessionContext": {
"attributes": {
"mfaAuthenticated": "false",
"creationDate": "2018-08-21T21:59:11Z"
}
},
"invokedBy": "signin.amazonaws.com"
},
"eventTime": "2018-08-21T22:00:05Z",
"eventSource": "es.amazonaws.com",
"eventName": "CreateDomain",
"awsRegion": "us-west-1",
"sourceIPAddress": "123.123.123.123",
"userAgent": "signin.amazonaws.com",
"requestParameters": {
"engineVersion": "OpenSearch_1.0",
"clusterConfig": {
"instanceType": "m4.large.search",
"instanceCount": 1
},
"snapshotOptions": {
"automatedSnapshotStartHour": 0
},
"domainName": "test-domain",
"encryptionAtRestOptions": {},
"eBSOptions": {
"eBSEnabled": true,
"volumeSize": 10,
"volumeType": "gp2"
},
"accessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[\"123456789012\"]},\"Action\":[\"es:*\"],\"Resource\":\"arn:aws:es:us-west-1:123456789012:domain/test-domain/*\"}]}",
"advancedOptions": {
"rest.action.multi.allow_explicit_index": "true"
}
},
"responseElements": {
"domainStatus": {
"created": true,
"clusterConfig": {
"zoneAwarenessEnabled": false,
"instanceType": "m4.large.search",
"dedicatedMasterEnabled": false,
"instanceCount": 1
},
"cognitoOptions": {
"enabled": false
},
"encryptionAtRestOptions": {
"enabled": false
},
"advancedOptions": {
"rest.action.multi.allow_explicit_index": "true"
},
"upgradeProcessing": false,
"snapshotOptions": {
"automatedSnapshotStartHour": 0
},
"eBSOptions": {
"eBSEnabled": true,
"volumeSize": 10,
"volumeType": "gp2"
},
"engineVersion": "OpenSearch_1.0",
"processing": true,
"aRN": "arn:aws:es:us-west-1:123456789012:domain/test-domain",
"domainId": "123456789012/test-domain",
"deleted": false,
"domainName": "test-domain",
"accessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-west-1:123456789012:domain/test-domain/*\"}]}"
}
},
"requestID": "12345678-1234-1234-1234-987654321098",
"eventID": "87654321-4321-4321-4321-987654321098",
"eventType": "AwsApiCall",
"recipientAccountId": "123456789012"
}
```