Retornar métricas do Atlas Search para um índice em um namespace
Retorna a série de dados de métricas do Atlas Search dentro da faixa de tempo fornecida para um namespace e nome de índice no processo especificado. Você deve ter a role somente leitura do projeto ou superior para visualizar os tipos de métricas do Atlas Search.
parâmetros de caminho
-
Combinação de nome de host e porta IANA que atende ao processo do MongoDB. O host deve ser o nome do host, o nome de domínio totalmente qualificado (FQDN) ou o endereço de protocolo da Internet (IPv4 ou IPv6) do host que executa o processo do MongoDB (mongod ou mongos). 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})$. -
Etiqueta legível para humanos que identifica o índice.
-
Rótulo legível por humanos que identifica o banco de dados.
-
Etiqueta legível para humanos que identifica a collection.
-
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})$.
parâmetros de query
-
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.
-
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.
-
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.
-
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. -
Lista que contém as medições que o MongoDB Atlas relata para a série de dados associada.
Não mais do que
10elementos. Os valores sãoINDEX_SIZE_ON_DISK,NUMBER_OF_DELETES,NUMBER_OF_ERROR_QUERIES,NUMBER_OF_GETMORE_COMMANDS,NUMBER_OF_INDEX_FIELDS,NUMBER_OF_INSERTS,NUMBER_OF_SUCCESS_QUERIES,NUMBER_OF_UPDATES,REPLICATION_LAGouTOTAL_NUMBER_OF_QUERIES.
atlas api monitoringAndLogs getIndexMeasurements --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20230101001/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.GetGroupHostFtsMetricIndexMeasurementsApiParams{}
sdkResp, httpResp, err := client.MonitoringandLogsApi.
GetGroupHostFtsMetricIndexMeasurementsWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true"curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true"{
"collectionName": "string",
"databaseName": "string",
"end": "2025-05-04T09:42:00Z",
"granularity": "PT1M",
"groupId": "32b6e34b3d91647abb20e7b8",
"indexIds": [
"string"
],
"indexStatsMeasurements": [
{
"dataPoints": [
{
"timestamp": "2025-05-04T09:42:00Z",
"value": 42.0
}
],
"name": "string",
"units": "BYTES"
}
],
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"processId": "mongodb.example.com:27017",
"start": "2025-05-04T09:42:00Z"
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"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": 429,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Too Many Requests",
"errorCode": "RATE_LIMITED"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}