1 つの MongoDB プロセスに関する測定値を返す
指定されたプロジェクトの指定されたホストの、プロセスごとのディスク、パーティション、またはホストの測定値を返します。戻り値は、次のいずれかになります。
- MongoDB プロセスに使用されるディスク パーティションの I/O 操作のスループット
- パーティションがリクエストを発行して処理した時間の割合
- MongoDB プロセスに使用されるディスク パーティションの操作タイプごとのレイテンシ
- MongoDBプロセスに使用されたディスク パーティション上の空きディスク領域と使用済みディスク領域の量
- CPU 使用率や I/O 操作回数などのホストの測定値
このリソースを使用するには、リクエスト元のサービスアカウントまたはAPIキーにプロジェクトの読み取り専用ロールが必要です。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
MongoDB プロセスを提供するホスト名と IANA（Internet Assigned Numbers Authority、インターネット番号割当機関）ポートの組み合わせ。ホストは、MongoDB プロセス（
mongodまたはmongos）を実行するホストのホスト名、完全修飾ドメイン名（FQDN）、またはインターネット プロトコル アドレス（IPv4 または IPv6）である必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。形式は次のパターンと一致する必要があります:
^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint -
この MongoDB プロセスに要求する 1 つ以上の測定タイプ。省略すると、リソースはすべての測定値を返します。
mに複数の値を指定するには、値ごとにmパラメーターを繰り返します。指定されたホストに適用する測定値を指定します。無効な測定値を指定した場合、MongoDB Cloud はエラーを返します。少なくとも
1を、10以下の要素を含めます。値はASSERT_MSG、ASSERT_REGULAR、ASSERT_USER、ASSERT_WARNING、BACKGROUND_FLUSH_AVG、CACHE_BYTES_READ_INTO、CACHE_BYTES_WRITTEN_FROM、CACHE_DIRTY_BYTES、CACHE_USED_BYTES、CACHE_FILL_RATIO、DIRTY_FILL_RATIO、COMPUTED_MEMORY、CONNECTIONS、CURSORS_TOTAL_OPEN、CURSORS_TOTAL_TIMED_OUT、DB_DATA_SIZE_TOTAL、DB_STORAGE_TOTAL、DOCUMENT_METRICS_DELETED、DOCUMENT_METRICS_INSERTED、DOCUMENT_METRICS_RETURNED、DOCUMENT_METRICS_UPDATED、EXTRA_INFO_PAGE_FAULTS、FTS_DISK_UTILIZATION、FTS_MEMORY_MAPPED、FTS_MEMORY_RESIDENT、FTS_MEMORY_VIRTUAL、FTS_PROCESS_CPU_KERNEL、FTS_PROCESS_CPU_USER、FTS_PROCESS_NORMALIZED_CPU_KERNEL、FTS_PROCESS_NORMALIZED_CPU_USER、GLOBAL_ACCESSES_NOT_IN_MEMORY、GLOBAL_LOCK_CURRENT_QUEUE_READERS、GLOBAL_LOCK_CURRENT_QUEUE_TOTAL、GLOBAL_LOCK_CURRENT_QUEUE_WRITERS、GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN、INDEX_COUNTERS_BTREE_ACCESSES、INDEX_COUNTERS_BTREE_HITS、INDEX_COUNTERS_BTREE_MISS_RATIO、INDEX_COUNTERS_BTREE_MISSES、JOURNALING_COMMITS_IN_WRITE_LOCK、JOURNALING_MB、JOURNALING_WRITE_DATA_FILES_MB、MAX_PROCESS_CPU_CHILDREN_KERNEL、MAX_PROCESS_CPU_CHILDREN_USER、MAX_PROCESS_CPU_KERNEL、MAX_PROCESS_CPU_USER、MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL、MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER、MAX_PROCESS_NORMALIZED_CPU_KERNEL、MAX_PROCESS_NORMALIZED_CPU_USER、MAX_SWAP_USAGE_FREE、MAX_SWAP_USAGE_USED、MAX_SYSTEM_CPU_GUEST、MAX_SYSTEM_CPU_IOWAIT、MAX_SYSTEM_CPU_IRQ、MAX_SYSTEM_CPU_KERNEL、MAX_SYSTEM_CPU_SOFTIRQ、MAX_SYSTEM_CPU_STEAL、MAX_SYSTEM_CPU_USER、MAX_SYSTEM_MEMORY_AVAILABLE、MAX_SYSTEM_MEMORY_FREE、MAX_SYSTEM_MEMORY_USED、MAX_SYSTEM_NETWORK_IN、MAX_SYSTEM_NETWORK_OUT、MAX_SYSTEM_NORMALIZED_CPU_GUEST、MAX_SYSTEM_NORMALIZED_CPU_IOWAIT、MAX_SYSTEM_NORMALIZED_CPU_IRQ、MAX_SYSTEM_NORMALIZED_CPU_KERNEL、MAX_SYSTEM_NORMALIZED_CPU_NICE、MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ、MAX_SYSTEM_NORMALIZED_CPU_STEAL、MAX_SYSTEM_NORMALIZED_CPU_USER、MEMORY_MAPPED、MEMORY_RESIDENT、MEMORY_VIRTUAL、NETWORK_BYTES_IN、NETWORK_BYTES_OUT、NETWORK_NUM_REQUESTS、OP_EXECUTION_TIME_COMMANDS、OP_EXECUTION_TIME_READS、OP_EXECUTION_TIME_WRITES、OPCOUNTER_CMD、OPCOUNTER_DELETE、OPCOUNTER_TTL_DELETED、OPCOUNTER_GETMORE、OPCOUNTER_INSERT、OPCOUNTER_QUERY、OPCOUNTER_REPL_CMD、OPCOUNTER_REPL_DELETE、OPCOUNTER_REPL_INSERT、OPCOUNTER_REPL_UPDATE、OPCOUNTER_UPDATE、OPERATIONS_SCAN_AND_ORDER、OPERATIONS_QUERIES_KILLED、OPLOG_MASTER_LAG_TIME_DIFF、OPLOG_MASTER_TIME、OPLOG_RATE_GB_PER_HOUR、OPLOG_SLAVE_LAG_MASTER_TIME、OPLOG_REPLICATION_LAG、PROCESS_CPU_CHILDREN_KERNEL、PROCESS_CPU_CHILDREN_USER、PROCESS_CPU_KERNEL、PROCESS_CPU_USER、PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL、PROCESS_NORMALIZED_CPU_CHILDREN_USER、PROCESS_NORMALIZED_CPU_KERNEL、PROCESS_NORMALIZED_CPU_USER、QUERY_EXECUTOR_SCANNED、QUERY_EXECUTOR_SCANNED_OBJECTS、QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED、QUERY_TARGETING_SCANNED_PER_RETURNED、RESTARTS_IN_LAST_HOUR、SWAP_USAGE_FREE、SWAP_USAGE_USED、SYSTEM_CPU_GUEST、SYSTEM_CPU_IOWAIT、SYSTEM_CPU_IRQ、SYSTEM_CPU_KERNEL、SYSTEM_CPU_NICE、SYSTEM_CPU_SOFTIRQ、SYSTEM_CPU_STEAL、SYSTEM_CPU_USER、SYSTEM_MEMORY_AVAILABLE、SYSTEM_MEMORY_FREE、SYSTEM_MEMORY_USED、SYSTEM_NETWORK_IN、SYSTEM_NETWORK_OUT、SYSTEM_NORMALIZED_CPU_GUEST、SYSTEM_NORMALIZED_CPU_IOWAIT、SYSTEM_NORMALIZED_CPU_IRQ、SYSTEM_NORMALIZED_CPU_KERNEL、SYSTEM_NORMALIZED_CPU_NICE、SYSTEM_NORMALIZED_CPU_SOFTIRQ、SYSTEM_NORMALIZED_CPU_STEAL、SYSTEM_NORMALIZED_CPU_USER、TICKETS_AVAILABLE_READS、TICKETS_AVAILABLE_WRITE、OPERATION_THROTTLING_REJECTED_OPERATIONS、またはQUERY_SPILL_TO_DISK_DURING_SORT -
Atlas がメトリクスをレポートする期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。start と end を設定しない場合は、このパラメーターを含めます。
-
Atlas がメトリクスをレポートする間隔を指定する期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。
-
MongoDB Cloud がメトリクスのレポートを開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。
-
MongoDB Cloud がメトリクスのレポートを停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。
atlas api monitoringAndLogs getProcessMeasurements --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20240805001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.GetGroupProcessMeasurementsApiParams{}
sdkResp, httpResp, err := client.MonitoringandLogsApi.
GetGroupProcessMeasurementsWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-08-05+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true"curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-08-05+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true"{
"databaseName": "string",
"end": "2025-05-04T09:42:00Z",
"granularity": "PT1M",
"groupId": "32b6e34b3d91647abb20e7b8",
"hostId": "mongodb.example.com:27017",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"measurements": [
{
"dataPoints": [
{
"timestamp": "2025-05-04T09:42:00Z",
"value": 42.0
}
],
"name": "string",
"units": "BYTES"
}
],
"partitionName": "string",
"processId": "mongodb.example.com:27017",
"start": "2025-05-04T09:42:00Z"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}