Obtenha medições de host, processo e sistema

Nesta página

Resource

Parâmetros do caminho da solicitação
Solicitar parâmetros de query
Parâmetros do corpo da solicitação
Resposta
Exemplo de solicitação
Exemplo de resposta
Cabeçalho de resposta
Corpo de resposta

O Cloud Manager não oferecerá mais suporte para Automação, Backup e Monitoramento do MongoDB 3.6 e 4.0 após 30 de agosto de 2024. Faça upgrade da sua versão do MongoDB ou migre para o Atlas.

A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.: O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .

As medições do host fornecem dados sobre o estado do processo MongoDB. O Monitoramento coleta medições de host por meio dos comandos MongoDB serverStatus e dbStats .

As medições de sistema e processo fornecem dados sobre o uso da CPU dos hosts que executam o MongoDB. A automação coleta essas medições. As medições de sistema e processo exigem a automação do Cloud Manager.

Esse endpoint retorna esses tipos de medição.

Observação

Para calcular algumas séries de métricas, o Cloud Manager obtém a taxa entre cada dois ponto adjacentes. Para essa série de métricas, o primeiro ponto de dados tem um valor nulo, pois o Cloud Manager não pode calcular uma taxa para o primeiro ponto de dados dado o intervalo de tempo da query.

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

GET /groups/{PROJECT-ID}/hosts/{HOST-ID}/measurements?granularity={ISO-8601-PERIOD}&period={ISO-8601-PERIOD}

Parâmetros do caminho da solicitação

Nome	Tipo	Descrição
ID do projeto	string	Identificador exclusivo do projeto que possui o host.
ID DE HOST	string	Identificador único do host que atende ao processo do MongoDB.

Solicitar parâmetros de query

Parâmetros de query únicos

Esse endpoint aceita os seguintes parâmetros de query para filtrar as medições retornadas:

Nome

Tipo

Descrição

granularity

Required

string

Duração em ISO 8601 notação que especifica o intervalo entre pontos de dados de medição.

A granularidade de medição pode ser expressa como dias, horas, minutos, segundos e milissegundos usando a seguinte notação:

P (para o período) seguido por:

D por dias (se desejado)
T por tempo (após dias)
H por horas
M por minutos
S por segundos

Por exemplo:

Notação	duração
`PT30S`	30 segundos
`P1T12H`	1 dia, 12 horas
`PT0.5S`	500 milissegundos

período

string

Duração em ISO 8601 notação que especifica até que ponto no passado para recuperar as medições.

Por exemplo, para solicitar as últimas 36 horas, inclua este parâmetro de query: period=P1DT12H.

iniciar

string

Carimbo 8601 de data/hora na ISO formato de data e hora em UTC para o início do período para o qual recuperar as medições. Se você especificar start , também deverá especificar end e não pode especificar period.

end

string

Carimbo de data/hora na ISO 8601 formato de data e hora em UTC para o final do período para o qual recuperar as medições. Se você especificar end , também deverá especificar start e não pode especificar period.

string

Medições a serem retornadas. Se m não for especificado, todas as medições serão retornadas.

Para especificar valores múltiplos para m, você deve repetir o parâmetro m .

Por exemplo:

../measurements?m=CONNECTIONS&m=OPCOUNTER_CMD&m=OPCOUNTER_QUERY

Você deve especificar medições que são válidas para o host. Cloud Manager retornará um erro se alguma medição especificada for inválida para obter medições disponíveis, consulte Tipos de medição.

Observação

Cada solicitação de medição deve incluir o parâmetro de query period ou os parâmetros de query start e end .

Parâmetros de query comuns

Esse endpoint também aceita os parâmetros de query comuns a todos os endpoints que retornam uma única resposta:

Nome

Tipo

Descrição

Default

pageNum

inteiro

Número da página (com base em índice 1).

1

itemsPerPage

inteiro

Número de itens a serem devolvidos por página, até um máximo de 500.

100

pretty

booleano

Indica se o corpo da resposta deve estar em formato prettyprint.

false

envelope

booleano

Indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure "envelope" : true na query.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

Nome	Descrição
`status`	Código de resposta HTTP
`content`	Corpo de resposta esperado

Para endpoints que retornam uma lista de resultados, o objeto results é um envelope. O Cloud Manager adiciona o campo status ao corpo da resposta.

none

Parâmetros do corpo da solicitação

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Resposta

Nome	Tipo	Descrição
Nome do Banco de Dados	string	Banco de dados ao qual a medição se aplica. Preenchido apenas para Obter medições de reconhecimento de data center .
end	string	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC para o final do período coberto pelas medições retornadas.
granularidade	string	Duração em ISO 8601 notação que especifica o tamanho do intervalo que cada ponto de dados cobre. Por exemplo, `PT5M` especifica uma granularidade 5minutos.
groupId	string	Identificador único do projeto que possui o host.
hostId	string	Identificador único do host ao qual as medições pertencem.
medições	array de objetos	Cada objeto nesta array representa uma medição e os pontos de dados para esta medição.
metrics.dataPoints	array de objetos	Cada objeto representa um único ponto de dados. Se não houver nenhum ponto de dados disponível para um determinado momento no tempo, esse `value` será definido como `null`.
metrics.dataPoints.timestamp	string	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC para o início do intervalo de tempo que esse ponto de dados representa.
metrics.dataPoints.value	float	Valor deste ponto de dados.
metrics.name	string	Nome da medição. Os valores aceitos são fornecidos na página Tipos de Medição .
metrics.units	string	Como essa medição é contabilizada. As unidades aceitas são: `PERCENT` `MILLISECONDS` `BYTES` `GIGABYTES` `BYTES_PER_SECOND` `MEGABYTES_PER_SECOND` `GIGABYTES_PER_HOUR` `SCALAR_PER_SECOND` `SCALAR`
partitionName	string	Nome da partição de disco que armazena o reconhecimento de data center de processos MongoDB. Preenchido apenas para obter medições de partição de disco .
processId	string	FQDN e porta do processo MongoDB.
iniciar	string	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC para o início do período coberto pelas medições retornadas.

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/measurements?granularity={TIME-INCREMENT}&period={PERIOD}&pretty=true"

Exemplo de resposta

Cabeçalho de resposta

HTTP/1.1 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

HTTP/1.1 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}

Corpo de resposta

{
  "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"
}

Voltar

Medições

Partição de Disco