experimental: 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 função "somente leitura" do projeto ou superior para visualizar os tipos de métricas do Atlas Search . Este comando está invocando o endpoint com OperationID: 'getIndexMetrics'. Para obter mais informações sobre sinalizadores, formato de --file e exemplos, consulte: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and- Registros/operation/getIndexMetrics
Sintaxe
atlas api monitoringAndLogs getIndexMetrics [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
--collectionName | string | true | etiqueta legível por humanos que identifica a collection |
--databaseName | string | true | etiqueta legível por humanos que identifica o banco de dados |
--end | string | false | data e hora em que o MongoDB Cloud para de reportar as métricas |
--envelope | false | sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope | |
--granularity | string | true | duração que especifica o intervalo no qual o Atlas relata as métricas |
--groupId | string | true | string exclusiva de dígitos hexadecimais 24que identifica seu projeto |
-h, --help | false | ajuda para getIndexMetrics | |
--indexName | string | true | etiqueta legível por humanos que identifica o índice |
--metrics | array de strings | true | lista que contém as medições que o MongoDB Atlas relata para a série de dados associada |
--output | string | false | formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON". |
--output-file | string | false | no qual gravar a saída da API. Esse sinalizador é necessário quando a saída de um endpoint é binária (por exemplo: gzip) e o comando não é piped (por exemplo: comando atlas > out.zip) |
--period | string | false | duração durante a qual o Atlas relata as métricas |
--processId | string | true | combinação de nome de host e porta IANA que atende ao processo do MongoDB |
--start | string | false | data e hora em que o MongoDB Cloud começa a relatar as métricas |
--version | string | false | Versão da API a ser usada ao chamar a chamada da API [opções: "2023-01-01"], o padrão é a versão mais recente ou o valor de configuração dos perfis api_version, se definido Este valor é padronizado como "2023-01a01". |
Opções herdadas
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
-P, --profile | string | false | Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |