AWS OpenSearch Serverless(AOSS)
AWS OpenSearch Serverless (AOSS) のメトリクスデータを収集
設定¶
Func のインストール¶
Guance のインテグレーション - 拡張機能 - ホステッド Func の有効化を推奨します。前提条件はすべて自動的にインストールされるため、そのままスクリプトのインストールに進んでください。
Func を自前でデプロイする場合はFunc の自前デプロイを参照してください
スクリプトのインストール¶
ヒント: 要件を満たす Amazon AK を事前に用意してください(簡単にするため、グローバルの読み取り専用権限
ReadOnlyAccessを直接付与しても構いません)
マネージド版の有効化スクリプト¶
- Guance コンソールにログインします
- 【インテグレーション】メニューをクリックし、【クラウドアカウント管理】を選択します。
- [クラウドアカウントを追加] をクリックし、[AWS] を選択して画面に必要な情報を入力します。以前にクラウドアカウント情報を設定済みの場合は、この手順をスキップしてください
- [テスト] をクリックし、成功したら [保存] をクリックします。失敗した場合は、関連設定が正しいか確認して再度テストしてください
- 【クラウドアカウント管理】の一覧で追加済みのクラウドアカウントを確認できます。該当するクラウドアカウントをクリックして詳細ページに入ります
- クラウドアカウントの詳細ページで【インテグレーション】をクリックし、
未インストール一覧からAWS OpenSearch Serverless(AOSS)を探して【インストール】をクリックします。
手動有効化スクリプト¶
-
Func コンソールにログインし、【スクリプトマーケット】から Guance のスクリプトマーケットを開いて、
integration_open_search_serverlessを検索します。 -
[インストール] をクリックし、対応するパラメータとして AWS AK ID、AK Secret、アカウント名を入力します
-
【起動スクリプトをデプロイ】をクリックします。システムが
Startupスクリプトセットを作成し、対応する起動スクリプトを自動設定します。 -
有効化後、「管理 / 自動トリガー設定」で対応する自動トリガー設定を確認できます。[実行] をクリックすると、定期実行を待たずにすぐ 1 回実行できます。少し待ってから、実行タスクの記録と対応するログを確認してください
検証¶
- [管理 / 自動トリガー設定]で、対象タスクの自動トリガー設定が存在することを確認し、タスク履歴とログに異常がないか確認します。
- Guance の「インフラストラクチャ - リソースディレクトリ」で資産情報が存在するか確認します
- Guance の「メトリクス」で対応する監視データがあるか確認します
メトリクス¶
AWS OpenSearch Serverless (AOSS) のメトリクスは aws_aoss メトリクスセットに含まれ、説明列には各メトリクスの説明、単位、統計情報が含まれます。
| メトリクス | 説明 | 単位 |
|---|---|---|
ActiveCollection |
コレクションがアクティブ状態かどうかを示します。値が 1 の場合、コレクションは ACTIVE 状態です。この値はコレクションの作成成功時に発行され、コレクションを削除するまで 1 のまま維持されます。このメトリクスの値は 0 にはなりません。 | - |
DeletedDocuments |
削除されたドキュメントの総数です。 | count |
IndexingOCU |
コレクションデータの取り込みに使用される OpenSearch Compute Unit(OCU)の数です。このメトリクスはアカウントレベルに適用されます。 | count |
IngestionDataRate |
コレクションまたはインデックスのインデックス作成レート。単位は GiB/秒です。 | GiB/s |
IngestionDocumentErrors |
コレクションまたはインデックスへの取り込み中に発生したドキュメントエラーの総数です。バッチインデックス要求が正常に完了した後、ライターがその要求を処理し、要求内で失敗したすべてのドキュメントに対してエラーを発行します。 | count |
IngestionDocumentRate |
ドキュメントをコレクションまたはインデックスに取り込む 1 秒あたりのレートです。このメトリクスはバッチインデックス要求のみに適用されます。 | count/s |
IngestionRequestErrors |
コレクションに対するバッチインデックス要求のエラー総数です。 | count |
IngestionRequestLatency |
コレクションに対するバッチ書き込み操作のレイテンシー。単位は秒です。 | s |
IngestionRequestRate |
コレクションが受信したバッチ書き込み操作の総数です。 | count |
IngestionRequestSuccess |
コレクションに対して正常に実行されたインデックス作成操作の総数です。 | count |
SearchableDocuments |
コレクションまたはインデックス内で検索可能なドキュメントの総数です。 | count |
SearchRequestErrors |
コレクションあたり 1 分間のクエリエラー総数です。 | count |
SearchRequestLatency |
コレクションに対して検索操作を完了するのにかかる平均時間。単位はミリ秒です。 | ms |
SearchOCU |
コレクションデータの検索に使用される OpenSearch Compute Unit(OCU)の数です。 | count |
SearchRequestRate |
コレクションに対する 1 分あたりの検索リクエスト総数です。 | count |
StorageUsedInS3 |
使用された Amazon S3 ストレージ容量。単位はバイトです。 | count |
2xx, 3xx, 4xx, 5xx |
指定された HTTP レスポンスコード(2xx、3xx、4xx、5xx)を返したコレクションへのリクエスト数です。 | count |
オブジェクト¶
収集された AWS OpenSearch Serverless (AOSS) のオブジェクトデータ構造です。「インフラストラクチャ - リソースディレクトリ」でオブジェクトデータを確認できます
{
"measurement": "aws_opensearch_serverless",
"tags": {
"collection_id" : "91dxh9h35ijjctd8nlvxfd4d",
"collection_name" : "xxx-test",
"RegionId" : "ap-southeast-1",
"arn" : "arn:aws:aoss:ap-southeast-1:87xxxxxxx45r:collection/xh9h35ijjctd8nldddxd
"
},
"fields": {
"status" : "ACTIVE"
}
}
注意:
tags、fieldsのフィールドは今後の更新で変更される可能性があります