ホスト、プロセス、システムの測定値を取得する
ホスト測定値は、MongoDB プロセスの状態に関するデータを提供します。 モニタリングは、MongoDB serverStatusおよびdbStatsコマンドを介してホスト測定値を収集します。
システムおよびプロセスの測定値は、MongoDB を実行するホストの CPU 使用率に関するデータを提供します。 オートメーション はこれらの測定値を収集します。 システムおよびプロセスの測定にはMongoDB Ops Manager Automation が必要です。
このエンドポイントは、これらの測定タイプを返します。
注意
何らかのメトリック系列を計算するために、 MongoDB Ops Managerは連続する 2 つのポイントごとのレートを取得します。 これらのメトリック系列では、 MongoDB Ops Managerはクエリの時間範囲を指定して最初のデータ点のレートを計算できないため、最初のデータ点は NULL 値になります。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/hosts/{HOST-ID}/measurements?granularity={ISO-8601-PERIOD}&period={ISO-8601-PERIOD}
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
プロジェクトID | string | ホストを所有するプロジェクトの一意の識別子。 |
ホスト ID | string | MongoDB プロセスを提供するホストの一意の識別子です。 |
リクエスト クエリ パラメータ
一意のクエリ パラメーター
このエンドポイントは、返された測定値をフィルタリングするために次のクエリ パラメーターを受け入れます。
名前 | タイプ | 説明 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
granularity Required | string | ISO8601 での期間 測定データ ポイント間の間隔を指定する表記。 測定の粒度は、次の表記を使用して、日数、時間、分、秒、ミリ秒として表できます。
以下に例を挙げます。
| ||||||||
period | string | ISO8601 の期間 過去の測定値を検索する方法を指定する表記。 たとえば、過去の36時間をリクエストするには、次のクエリ パラメータを含めます: | ||||||||
始める | string | |||||||||
end | string | |||||||||
m | string | 返す測定値。
以下に例を挙げます。 ホストに対して有効な測定値を指定する必要があります。 MongoDB Ops Manager は、指定された測定値が無効な場合はエラーを返します。利用可能な測定値については、「測定タイプ 」を参照してください。 |
注意
各測定リクエストには、 periodクエリ パラメータまたはstartクエリ パラメータとendクエリ パラメータの両方を含める必要があります。
一般的なクエリ パラメーター
このエンドポイントは、単一の応答を返すすべてのエンドポイントに共通のクエリ パラメーターも受け入れます。
名前 | タイプ | 説明 | default | ||||
|---|---|---|---|---|---|---|---|
pageNum | integer | ページ番号（1 インデックス ベース）。 | 1 | ||||
itemsPerPage | integer | 1 ページあたりに返す項目の数は最大 500 です。 | 100 | ||||
pretty | ブール値 | レスポンス本体が pretty-print 内であるかどうかを示します 形式。 | false | ||||
envelope | ブール値 | 応答をエンベロープでラップするかどうかを示します。 一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
結果のリストを返すエンドポイントの場合、 | なし |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 |
|---|---|---|
databaseName | string | 測定が適用されるデータベース。 データベース測定を取得するためにのみ入力されます。 |
end | string | ISO8601 のタイムスタンプ 返された測定値がカバーする期間の終了の日付と時刻（ UTC） 形式。 |
粒度 | string | ISO8601 の期間 各データ ポイントがカバーする間隔のサイズを指定する表記。 たとえば、 |
グループ ID | string | ホストを所有するプロジェクトの一意の識別子。 |
hostId | string | 測定値が含まれるホストの一意の識別子。 |
測定値 | オブジェクト配列 | この配列内の各オブジェクトは、測定値とその測定値のデータ ポイントを表します。 |
operations.dataPoints | オブジェクト配列 | 各オブジェクトは 1 つのデータ ポイントを表します。 特定の時点で利用可能なデータ ポイントがない場合、この valueはnullに設定されます。 |
operations.dataPoints.timestamp | string | ISO8601 のタイムスタンプ このデータ ポイントが表す時間間隔の開始の UTC 形式の日付と時刻形式。 |
operations.dataPoints.value | float | このデータ ポイントの値。 |
operations.name | string | 測定値の名前。 許容値は [測定タイプ]ページに記載されています。 |
operations.units | string | この測定値がどのように定量化されるか。 指定できる単位は以下のとおりです。
|
partitionName | string | MongoDB プロセス データベースを保存するディスク パーティションの名前。 ディスク パーティション測定の取得にのみ入力されます。 |
processId | string | MongoDB プロセスのFQDNとポート。 |
始める | string | ISO8601 のタイムスタンプ 返された測定値がカバーする期間の開始の日付と時刻（ UTC） 形式。 |
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/measurements?granularity={TIME-INCREMENT}&period={PERIOD}}&pretty=true"
応答例
応答ヘッダー
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
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}
レスポンス本体
{ "end": "2022-05-12T18:28:19Z", "granularity": "{TIME-INCREMENT}", "groupId": "{PROJECT-ID}", "hostId": "{HOST-ID}", "links": [ ], "measurements": [{ "dataPoints": [{ "timestamp" : "2022-05-12T18:28:10Z", "value": 5.0 }], "name": "CONNECTIONS", "units": "SCALAR" }, { "dataPoints": [{ "timestamp": "2022-05-12T18:28:10Z", "value": 15.699934824278714 }], "name": "NETWORK_BYTES_IN", "units": "BYTES_PER_SECOND" }, . . . , { "dataPoints": [], "name": "SYSTEM_NORMALIZED_CPU_SOFTIRQ", "units": "PERCENT" }, { "dataPoints": [], "name": "SYSTEM_NORMALIZED_CPU_GUEST", "units": "PERCENT" }, { "dataPoints": [], "name": "SYSTEM_NORMALIZED_CPU_STEAL", "units": "PERCENT" }], "processId": "{MONGODB-PROCESS-FQDN}:{PORT}", "start": "2022-05-12T18:28:10Z" }