Visualização pública: forneça comentários em: retorna um arquivo de log compactado (.gz) que contém uma faixa de mensagens de log para o host especificado para o projeto especificado.
O MongoDB atualiza os logs de processo e auditar da infraestrutura de backend do cluster a cada cinco minutos. Os registros são armazenados em blocos de aproximadamente cinco minutos de duração, mas essa duração pode variar. Se você pesquisar arquivos de log na API, recomendamos a sondagem a cada cinco minutos, embora as sondagens consecutivas possam conter alguns registros sobrepostos. Esse recurso não está disponível para clusters gratuitos M0, clusters M2, M5, flexíveis ou sem servidor. Para usar esse recurso, a chave de API solicitante deve ter a role Somente leitura de acesso a dados do projeto ou superior. A API não suporta chamadas diretas com o esquema de resposta JSON. Você deve solicitar um esquema de resposta gzip usando um cabeçalho de aceitação do formato: "Aceitar: aplicação/vnd.atlas.YYYY-MM-DD+gzip".
Este comando é gerado automaticamente e 1 corresponde:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring- e-Logs/operation/getHostLogs.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api monitoringAndLogs getHostLogs [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--endDate | int | false | Especifica a data e a hora do ponto final do intervalo de mensagens de log a serem recuperadas, no número de segundos decorridos desde a UNIX epoch. Esse valor terá como padrão 24 horas após a data de início. Se a data de início também não for especificada, o valor será padronizado para a hora da solicitação. |
--envelope | envelope | false | Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de 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 query. 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. |
--groupId | string | true | Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint [/groups](#tag/Projects/operation/listProjects) para recuperar 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. |
-h, --help | false | ajuda para getHostLogs | |
--hostName | string | true | Etiqueta legível por humanos que identifica o host que armazena os arquivos de log que você deseja baixar. |
--logName | string | true | Rótulo legível por humanos que identifica o arquivo de registro que você deseja retornar. Para retornar registros de auditoria, habilite a auditoria de banco de dados para o projeto especificado. |
--output | string | false | formato de API preferido, pode ser ["gzip"] Este valor padrão é "gzip". |
--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) |
--startDate | int | false | Especifica a data e a hora do ponto de partida do intervalo de mensagens de log a serem recuperadas, no número de segundos decorridos desde a época do UNIX. Esse valor terá como padrão 24 horas antes da data final. Se a data de término também não for especificada, o valor padrão será 24 horas antes da hora da solicitação. |
--version | string | false | Versão da API a ser usada ao chamar a chamada da API [opções: "2023-01-01", "2023-02-01"], os padrões para a versão mais recente ou os perfis api_version valor de configuração se definido Este valor padrão é "2023-02-01". |
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. |
Exemplos
Retorna um arquivo de log do MongoDB compactado (.gz) contendo mensagens de log para o host especificado
Execute o comando abaixo.
atlas api monitoringAndLogs getHostLogs --version 2023-02-01 --endDate 1609545600 --envelope false --groupId [your-project-id] --hostName [your-host-name] --logName mongodb --startDate 1609459200