Retornar latência de query em nível de cluster

Nesta página

Resource

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

Retorna uma lista de medições delatência de query em nível de cluster para o namespace especificado.

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

Resource

GET /groups/{PROJECT-ID}/clusters/{hostClusterId}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements

Parâmetros do caminho da solicitação

Parâmetro	Tipo	Descrição
ID do projeto	string	(Obrigatório.) 24exclusiva -string de dígitos hexadecimais que identifica o projeto que contém o namespace.
hostClusterId	string	(Obrigatório.) Identificador exclusivo do cluster que contém o namespace.
clusterView	string	(Obrigatório.) Nome que identifica a topologia do cluster. Os valores incluem: `PRIMARY` `SECONDARY` `INDIVIDUAL_PROCESS`
Nome do Banco de Dados	string	(Obrigatório.) Nome que identifica o banco de dados.
collectionName	string	(Obrigatório.) Nome que identifica a collection.

Solicitar parâmetros de query

Todos os parâmetros são opcionais.

Nome	Tipo	Descrição	Default
pretty	booleano	Indica se o corpo da resposta deve estar em um prettyprint formato.	`false`
envelope	booleano	Indica se deseja ou não envolver a resposta em um envelope.	`false`
metrics	array	Lista que contém as métricas a serem recuperadas para a série de dados associada. Se você não especificar este parâmetro, o recurso retornará a série de dados para todas as métricas de latência de query.	Todos
período	string	Duração em ISO 8601 notação que especifica até que ponto no passado para recuperar as medições. Se você especificar esse valor, não poderá especificar `start` e `end`. 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`.

Métricas

Métrica	Descrição
`TOTAL_LATENCY`	Taxa que indica a duração total da operação combinada do servidor em uma coleção (duração total combinada da operação do servidor/intervalo de coleta em segundos).
`READS_LATENCY`	Taxa que indica a duração total da operação de leitura combinada em uma collection (duração total da operação de leitura combinada / intervalo de collection em segundos).
`WRITES_LATENCY`	Taxa que indica a duração total da operação de gravação combinada em uma collection (duração total da operação de gravação combinada / intervalo de collection em segundos).
`COMMANDS_LATENCY`	Taxa que indica a duração total da operação de comando combinada em uma collection (duração total da operação de comando combinada / intervalo de collection em segundos).
`AVERAGE_TOTAL_OPS_LATENCY`	Duração total da operação do servidor dividida pela contagem total de operações do servidor em todos os tipos de operação.
`AVERAGE_READS_LATENCY`	Duração da operação de leitura dividida pela contagem de operações de leitura.
`AVERAGE_WRITES_LATENCY`	Duração da operação de gravação dividida pela contagem de operações de gravação.
`AVERAGE_COMMANDS_LATENCY`	Duração da operação de comando dividida pela contagem de operações de comando.
`TOTAL_OPS_P50_VALUE`	50º percentil no histograma de latência.
`READS_P50_VALUE`	50percentil no histograma de latência de leitura.
`WRITES_P50_VALUE`	50percentil no histograma de latência de gravação.
`COMMANDS_P50_VALUE`	50percentil no histograma de latência de comando.
`TOTAL_OPS_P95_VALUE`	95º percentil no histograma de latência.
`READS_P95_VALUE`	95percentil no histograma de latência de leitura.
`WRITES_P95_VALUE`	95percentil no histograma de latência de gravação.
`COMMANDS_P95_VALUE`	95percentil no histograma de latência de comando.
`TOTAL_OPS_P99_VALUE`	99o percentil no histograma de latência em todas as operações.
`READS_P99_VALUE`	99percentil no histograma de latência de leitura.
`WRITES_P99_VALUE`	99percentil no histograma de latência de gravação.
`COMMANDS_P99_VALUE`	99percentil no histograma de latência de comando.
`TOTAL_OPS`	Taxa que indica o número total de operações realizadas em uma collection (total de operações / intervalo de collection).
`READS_OPS`	Taxa que indica o número de operações de leitura realizadas em uma collection (operações de leitura/intervalo de collection).
`WRITES_OPS`	Taxa que indica o número de operações de gravação realizadas em uma collection (operações de gravação/intervalo de collection).
`COMMANDS_OPS`	Taxa que indica o número de operações de comando realizadas em uma collection (operações de comando/intervalo de collection).

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
collectionName	string	Nome que identifica a collection.
Nome do Banco de Dados	string	Nome que identifica o banco de dados.
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.
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	24exclusiva -string de dígitos hexadecimais que identifica o projeto que contém o namespace.
links	array de objetos	Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays `links` nas respostas incluem pelo menos um link chamado `self`. Os relacionamentos entre URLs são explicados na Especificação de links da web.
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 medida. Os valores aceitos são fornecidos na página Tipos de medição .
metrics.units	string	Como essa medição é quantidade.
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 para o qual recuperar as medições.

Exemplo de solicitação

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}'

Exemplo de resposta

Cabeçalho de resposta

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

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

Voltar

Desafixar namespaces

Retornar namespaces classificados de um cluster