Retornar medidas para um processo do MongoDB
Retorna medições de disco, partição ou host por processo para o host especificado para o projeto especificado. O valor retornado pode ser um dos seguintes:
- Taxa de transferência das operações de E/S para a partição de disco usada para o processo do MongoDB
- Porcentagem de tempo durante a qual é feita a solicitação da partição emitida e atendida
- Latência por tipo de operação da partição de disco usada para o processo do MongoDB
- Quantidade de espaço em disco livre e usada na partição de disco usada para o processo MongoDB
- Medições para o host, como uso de CPU ou número de operações de entrada/saída
Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto.
parâmetros de caminho
-
Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.
AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$. -
Combinação de nome de host e porta Internet Assigned Numbers Authority (IANA) que atende ao processo do MongoDB. O host deve ser o nome do host, o FQDN (nome de domínio totalmente qualificado) ou o endereço IPv4 ou IPv6 do host que executa o processo do MongoDB (
mongodoumongos). A porta deve ser a porta IANA na qual o processo do MongoDB escuta as solicitações.O formato deve corresponder ao seguinte padrão:
^([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})$.
parâmetros de query
-
Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON
envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.O valor padrão é
false. -
Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
O valor padrão é
false.Prettyprint -
Um ou mais tipos de medição a serem solicitados para esse processo do MongoDB. Se omitido, o recurso retorna todas as medições. Para especificar valores múltiplos para
m, repita o parâmetrompara cada valor. Especifique as medições que se aplicam ao host especificado. O MongoDB Cloud retornará um erro se você especificar um medição inválida.Pelo menos
1, mas não mais de10elementos. Os valores sãoASSERT_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_OPERATIONSouQUERY_SPILL_TO_DISK_DURING_SORT. -
Duração durante a qual o Atlas relata as métricas. Este parâmetro expressa seu valor no formato de duração ISO 8601 em UTC. Inclua este parâmetro se você não configurar o início e término.
-
Duração que especifica o intervalo no qual o Atlas relata as métricas. Este parâmetro expressa seu valor no formato de duração ISO 8601 em UTC.
-
Data e hora em que o MongoDB Cloud começa a relatar as métricas. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC. Inclua esse parâmetro se você não definir o ponto.
-
Data e hora em que o MongoDB Cloud para de reportar as métricas. Este parâmetro expressa seu valor no formato de carimbo de data/hora ISO 8601 em UTC. Insira esee parâmetro quando você não definir o período.
atlas api monitoringAndLogs getGroupProcessMeasurements --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250312001/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.2025-03-12+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.2025-03-12+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"
}