クラスターレベルのクエリ レイテンシを返す
Cloud Manager は、 2024年8月30日でMongoDB 3.6と4.0のオートメーション、バックアップおよびモニタリングのサポートを終了します。 MongoDB の配置をアップグレードするか、Atlas に移行してください。
- Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用する サービス アカウント を作成します。
指定された名前空間のクラスターレベルのクエリ レイテンシの測定値の一覧を返します。
ベース URL: https://cloud.mongodb.com/api/public/v 1.0
Resource
GET /groups/{PROJECT-ID}/clusters/{hostClusterId}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements
リクエスト パス パラメーター
Parameter | タイプ | 説明 |
|---|---|---|
プロジェクトID | string | （必須。） 名前空間を含むプロジェクトを識別する一意の 24 桁の 16 進数string 。 |
hostClusterId | string | （必須。） 名前空間 を含むクラスターの一意の識別子。 |
clusterView | string | （必須。） クラスター トポロジーを識別する名前。 値には、次のものが含まれます。
|
databaseName | string | （必須。） データベースを識別する名前。 |
コレクション名 | string | （必須。） コレクションを識別する名前。 |
リクエスト クエリ パラメータ
すべてのパラメーターは任意です。
名前 | タイプ | 説明 | default |
|---|---|---|---|
pretty | ブール値 | レスポンス本体を pretty-print にするかどうかを示します 形式。 | false |
envelope | ブール値 | 応答をエンベロープでラップするかどうかを示します。 | false |
メトリクス | 配列 | 関連するデータ シリーズについて取得するメトリクスを含むリスト。 このパラメーターを指定しない場合、このリソースはすべてのクエリ レイテンシ メトリクスのデータ シリーズを返します。 | すべて |
period | string | ISO8601 の期間 過去の測定値を検索する方法を指定する表記。この値を指定した場合、 たとえば、過去の36時間をリクエストするには、次のクエリ パラメータを含めます: | |
始める | string | ISO8601 のタイムスタンプ 測定値を取得する期間の開始の日付と時刻形式（ UTC） 。 startを指定する場合は、 endも指定する必要があります。また、 periodを指定することはできません。 | |
end | string | ISO8601 のタイムスタンプ 測定値を取得する期間の終了の日付と時刻（ UTC） 形式。 endを指定する場合は、 startも指定する必要があります。また、 periodを指定することはできません。 |
メトリクス
メトリクス | 説明 |
|---|---|
TOTAL_LATENCY | コレクションでの合計サーバー操作時間の合計を示すレート（合計サーバー操作時間 / コレクション間隔（秒単位））。 |
READS_LATENCY | コレクションでの合計読み取り操作期間を示すレート（合計読み取り操作期間 / コレクション間隔（秒単位））。 |
WRITES_LATENCY | コレクションでの合計書込み (write) 操作時間の合計を示すレート（合計書込み (write) 操作時間 / コレクション間隔（秒単位））。 |
COMMANDS_LATENCY | コレクションでの合計コマンド操作時間の合計を示すレート（合計コマンド操作時間 / コレクション間隔（秒単位））。 |
AVERAGE_TOTAL_OPS_LATENCY | 合計サーバー操作期間を、すべての操作タイプの合計サーバー操作数で割った値。 |
AVERAGE_READS_LATENCY | 読み取り操作期間を読み取り操作回数で割った値。 |
AVERAGE_WRITES_LATENCY | 書込み操作期間を書込み操作回数で割った値。 |
AVERAGE_COMMANDS_LATENCY | コマンド操作期間を コマンド操作数で割った値。 |
TOTAL_OPS_P50_VALUE | レイテンシ ヒストグラムの50パーセンタイル。 |
READS_P50_VALUE | 読み取りレイテンシ ヒストグラムの50パーセンタイル。 |
WRITES_P50_VALUE | 書込みレイテンシ ヒストグラムの50パーセンタイル。 |
COMMANDS_P50_VALUE | コマンドレイテンシ ヒストグラムの50パーセンタイル。 |
TOTAL_OPS_P95_VALUE | レイテンシ ヒストグラムの95パーセンタイル。 |
READS_P95_VALUE | 読み取りレイテンシ ヒストグラムの95パーセンタイル。 |
WRITES_P95_VALUE | 書込みレイテンシ ヒストグラムの95パーセンタイル。 |
COMMANDS_P95_VALUE | コマンドレイテンシ ヒストグラムの95パーセンタイル。 |
TOTAL_OPS_P99_VALUE | すべての操作にわたるレイテンシ ヒストグラムの99パーセンタイル。 |
READS_P99_VALUE | 読み取りレイテンシ ヒストグラムの99パーセンタイル。 |
WRITES_P99_VALUE | 書込みレイテンシ ヒストグラムの99パーセンタイル。 |
COMMANDS_P99_VALUE | コマンドレイテンシ ヒストグラムの99パーセンタイル。 |
TOTAL_OPS | コレクションで実行された操作の合計数を示すレート（合計操作 / コレクション間隔）。 |
READS_OPS | コレクションで実行された読み取り操作の数を示すレート（読み取り操作 / コレクション間隔）。 |
WRITES_OPS | コレクションで実行された書込み (write) 操作の数を示すレート（書込み (write) 操作 / コレクション間隔）。 |
COMMANDS_OPS | コレクションで実行されたコマンド操作の数を示すレート（コマンド操作 / コレクション間隔）。 |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 |
|---|---|---|
コレクション名 | string | コレクションを識別する名前。 |
databaseName | string | データベースを識別する名前。 |
end | string | ISO8601 のタイムスタンプ 測定値を取得する期間の終了の日付と時刻（ UTC） 形式。 |
粒度 | string | ISO8601 の期間 各データ ポイントがカバーする間隔のサイズを指定する表記。 たとえば、 |
グループ ID | string | 名前空間を含むプロジェクトを識別する一意の 24 桁の 16 進数string 。 |
Links | オブジェクト配列 | サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべての |
測定値 | オブジェクト配列 | この配列内の各オブジェクトは、測定値とその測定値のデータ ポイントを表します。 |
operations.dataPoints | オブジェクト配列 | 各オブジェクトは 1 つのデータ ポイントを表します。 特定の時点で利用可能なデータ ポイントがない場合、この valueはnullに設定されます。 |
operations.dataPoints.timestamp | string | ISO8601 のタイムスタンプ このデータ ポイントが表す時間間隔の開始の UTC 形式の日付と時刻形式。 |
operations.dataPoints.value | float | このデータ ポイントの値。 |
operations.name | string | 測定値の名前。 許容値は [測定タイプ]ページに記載されています。 |
operations.units | string | この測定値がどのように定量化されるか。 |
processId | string | MongoDB プロセスのFQDNとポート。 |
始める | string | ISO8601 のタイムスタンプ 測定値を取得する期間の開始の UTC 形式の日付と時刻形式。 |
リクエストの例
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET 'https://{CLOUD-MANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{hostClusterId}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true&period={period}'
応答例
応答ヘッダー
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
レスポンス本体
{ "collectionName": {collectionName}, "databaseName": "{datbaseName}", "end": "2024-03-21T13:49:25Z", "granularity": "PT10M", "groupId": "{PROJECT-ID}", "links": [ { "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{hostId}/{databaseName}/{collectionName}/collStats/measurements?period={period}", "rel": "self" }, { "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}", "rel": "https://cloud.mongodb.com/group" } ], "measurements": [ { "dataPoints": [ { "timestamp": "2024-03-22T20:26:17Z", "value": null }, { "timestamp": "2024-03-22T20:31:29Z", "value": 0.003203013395002018 }, { "timestamp": "2024-03-22T20:41:29Z", "value": 0.0016666722222407407 } ], "name": "READS_OPS", "units": "SCALAR_PER_SECOND" }, { "dataPoints": [ { "timestamp": "2024-03-21T13:40:02Z", "value": null }, { "timestamp": "2024-03-21T13:49:25Z", "value": 115.25475560992174 } ], "name": "READS_LATENCY", "units": "MICROSECONDS_PER_SECOND" }, { "dataPoints": [ { "timestamp": "2024-03-21T13:40:02Z", "value": null }, { "timestamp": "2024-03-21T13:49:25Z", "value": 229.8723404255319 } ], "name": "AVERAGE_READS_LATENCY", "units": "MICROSECONDS" }, { "dataPoints": [ { "timestamp": "2024-03-21T13:40:02Z", "value": null }, { "timestamp": "2024-03-21T13:49:25Z", "value": 98.5945945945946 } ], "name": "READS_P50_VALUE", "units": "MICROSECONDS" }, { "dataPoints": [ { "timestamp": "2024-03-21T13:40:02Z", "value": null }, { "timestamp": "2024-03-21T13:49:25Z", "value": 174.54545454545456 } ], "name": "READS_P95_VALUE", "units": "MICROSECONDS" }, { "dataPoints": [ { "timestamp": "2024-03-21T13:40:02Z", "value": null }, { "timestamp": "2024-03-21T13:49:25Z", "value": 244.36363636363637 } ], "name": "READS_P99_VALUE", "units": "MICROSECONDS" }, { "dataPoints": [ { "timestamp": "2024-03-22T20:26:17Z", "value": null }, { "timestamp": "2024-03-22T20:31:29Z", "value": 0.0 }, { "timestamp": "2024-03-22T20:41:29Z", "value": 0.0 } ], "name": "WRITES_OPS", "units": "SCALAR_PER_SECOND" }, { "dataPoints": [ { "timestamp": "2024-03-21T13:40:02Z", "value": null }, { "timestamp": "2024-03-21T13:49:25Z", "value": 0.0 } ], "name": "WRITES_LATENCY", "units": "MICROSECONDS_PER_SECOND" }, { "dataPoints": [ { "timestamp": "2024-03-21T13:40:02Z", "value": null }, { "timestamp": "2024-03-21T13:49:25Z", "value": null } ], "name": "AVERAGE_WRITES_LATENCY", "units": "MICROSECONDS" }, { "dataPoints": [ { "timestamp": "2024-03-21T13:40:02Z", "value": null }, { "timestamp": "2024-03-21T13:49:25Z", "value": null } ], "name": "WRITES_P50_VALUE", "units": "MICROSECONDS" }, { "dataPoints": [ { "timestamp": "2024-03-21T13:40:02Z", "value": null }, { "timestamp": "2024-03-21T13:49:25Z", "value": null } ], "name": "WRITES_P95_VALUE", "units": "MICROSECONDS" }, { "dataPoints": [ { "timestamp": "2024-03-21T13:40:02Z", "value": null }, { "timestamp": "2024-03-21T13:49:25Z", "value": null } ], "name": "WRITES_P99_VALUE", "units": "MICROSECONDS" }, { "dataPoints": [ { "timestamp": "2024-03-22T20:26:17Z", "value": null }, { "timestamp": "2024-03-22T20:31:29Z", "value": 0.0 }, { "timestamp": "2024-03-22T20:41:29Z", "value": 0.0 } ], "name": "COMMANDS_OPS", "units": "SCALAR_PER_SECOND" }, { "dataPoints": [ { "timestamp": "2024-03-21T13:40:02Z", "value": null }, { "timestamp": "2024-03-21T13:49:25Z", "value": 0.0 } ], "name": "COMMANDS_LATENCY", "units": "MICROSECONDS_PER_SECOND" }, { "dataPoints": [ { "timestamp": "2024-03-21T13:40:02Z", "value": null }, { "timestamp": "2024-03-21T13:49:25Z", "value": null } ], "name": "AVERAGE_COMMANDS_LATENCY", "units": "MICROSECONDS" }, { "dataPoints": [ { "timestamp": "2024-03-21T13:40:02Z", "value": null }, { "timestamp": "2024-03-21T13:49:25Z", "value": null } ], "name": "COMMANDS_P50_VALUE", "units": "MICROSECONDS" }, { "dataPoints": [ { "timestamp": "2024-03-21T13:40:02Z", "value": null }, { "timestamp": "2024-03-21T13:49:25Z", "value": null } ], "name": "COMMANDS_P95_VALUE", "units": "MICROSECONDS" }, { "dataPoints": [ { "timestamp": "2024-03-21T13:40:02Z", "value": null }, { "timestamp": "2024-03-21T13:49:25Z", "value": null } ], "name": "COMMANDS_P99_VALUE", "units": "MICROSECONDS" }, { "dataPoints": [ { "timestamp": "2024-03-21T13:40:02Z", "value": null }, { "timestamp": "2024-03-21T13:49:25Z", "value": 0.5013859231457166 } ], "name": "TOTAL_OPS", "units": "SCALAR_PER_SECOND" }, { "dataPoints": [ { "timestamp": "2024-03-21T13:40:02Z", "value": null }, { "timestamp": "2024-03-21T13:49:25Z", "value": 115.25475560992174 } ], "name": "TOTAL_LATENCY", "units": "MICROSECONDS_PER_SECOND" }, { "dataPoints": [ { "timestamp": "2024-03-21T13:40:02Z", "value": null }, { "timestamp": "2024-03-21T13:49:25Z", "value": 229.8723404255319 } ], "name": "AVERAGE_TOTAL_OPS_LATENCY", "units": "MICROSECONDS" }, { "dataPoints": [ { "timestamp": "2024-03-21T13:40:02Z", "value": null }, { "timestamp": "2024-03-21T13:49:25Z", "value": 98.5945945945946 } ], "name": "TOTAL_OPS_P50_VALUE", "units": "MICROSECONDS" }, { "dataPoints": [ { "timestamp": "2024-03-21T13:40:02Z", "value": null }, { "timestamp": "2024-03-21T13:49:25Z", "value": 174.54545454545456 } ], "name": "TOTAL_OPS_P95_VALUE", "units": "MICROSECONDS" }, { "dataPoints": [ { "timestamp": "2024-03-21T13:40:02Z", "value": null }, { "timestamp": "2024-03-21T13:49:25Z", "value": 244.36363636363637 } ], "name": "TOTAL_OPS_P99_VALUE", "units": "MICROSECONDS" } ], "processId": "notApplicable", "start": "2024-03-21T13:40:02Z" }