Utilitário de monitoramento e coleta de diagnóstico (dotnet-monitor)
Este artigo aplica-se a: ✔️ dotnet-monitor
versão 6.0.0 e versões posteriores
Instalar
Há duas maneiras de fazer o download dotnet-monitor
:
Ferramenta global dotnet:
Para instalar a versão mais recente do
dotnet-monitor
pacote NuGet, use o comando dotnet tool install :dotnet tool install --global dotnet-monitor
Imagem do Docker:
Faça o download de uma imagem do Docker para uso em ambientes de vários contêineres:
docker pull mcr.microsoft.com/dotnet/monitor
Sinopse
dotnet-monitor [-h|--help] [--version] <command>
Description
A dotnet-monitor
ferramenta global é uma maneira de monitorar aplicativos .NET em ambientes de produção e coletar artefatos de diagnóstico (por exemplo, dumps, rastreamentos, logs e métricas) sob demanda ou usando regras automatizadas para coleta sob condições especificadas.
Opções
--version
Exibe a versão do utilitário dotnet-monitor.
-h|--help
Mostra a ajuda da linha de comando.
Comandos
Comando |
---|
dotnet monitor coletar |
dotnet monitor config show |
dotnet monitor generatekey |
dotnet-monitor coletar
Monitore aplicativos .NET, permita coletar artefatos de diagnóstico e envie os resultados para um destino escolhido.
Sinopse
dotnet-monitor collect [-h|--help] [-u|--urls] [-m|--metrics] [--metricUrls] [--diagnostic-port] [--no-auth] [--temp-apikey] [--no-http-egress]
Opções
-h|--help
Mostra a ajuda da linha de comando.
-u|--urls <urls>
Ligações para a API HTTP. A predefinição é
https://localhost:52323
.-m|--metrics [true|false]
Habilite a publicação de métricas para
/metrics
roteamento. O padrão étrue
--metricUrls <urls>
Ligações para a API HTTP de métricas. A predefinição é
http://localhost:52325
.--diagnostic-port <path>
O caminho totalmente qualificado e o nome do arquivo da porta de diagnóstico à qual as instâncias de tempo de execução podem se conectar. Especificar esta opção coloca
dotnet-monitor
no modo 'ouvir'. Quando não especificado,dotnet-monitor
está no modo 'conectar'.No Windows, esse deve ser um nome de pipe nomeado válido. No Linux e macOS, este deve ser um caminho de soquete de domínio Unix válido.
--no-auth
Desabilita a autenticação de chave de API. A predefinição é
false
.É altamente recomendável que esta opção não seja usada em ambientes de produção.
--temp-apikey
Gera uma chave de API temporária para a
dotnet-monitor
instância.--no-http-egress
Desabilita a saída de artefatos de diagnóstico por meio da resposta HTTP. Quando especificado, os artefatos devem ser egressos usando um provedor de saída.
dotnet-monitor config show
Mostra a configuração, como se dotnet-monitor collect
tivesse sido executada com esses parâmetros.
Sinopse
dotnet-monitor config show [-h|--help] [-u|--urls] [-m|--metrics] [--metricUrls] [--diagnostic-port] [--no-auth] [--temp-apikey] [--no-http-egress] [--level] [--show-sources]
Opções
-h|--help
Mostra a ajuda da linha de comando.
-u|--urls <urls>
Ligações para a API HTTP. A predefinição é
https://localhost:52323
.Esse valor é mapeado na configuração como a
urls
chave.-m|--metrics [true|false]
Habilite a publicação de métricas para
/metrics
roteamento. A predefinição étrue
.Esse valor é mapeado na configuração como a
Metrics:Enabled
chave.--metricUrls <urls>
Ligações para a API HTTP de métricas. A predefinição é
http://localhost:52325
.Esse valor é mapeado na configuração como a
Metrics:Endpoints
chave.--diagnostic-port <path>
O caminho totalmente qualificado e o nome do arquivo da porta de diagnóstico à qual as instâncias de tempo de execução podem se conectar. Especificar esta opção coloca
dotnet-monitor
no modo 'ouvir'. Quando não especificado,dotnet-monitor
está no modo 'conectar'.No Windows, esse deve ser um nome de pipe nomeado válido. No Linux e macOS, este deve ser um caminho de soquete de domínio Unix válido.
Esse valor é mapeado na configuração como a
DiagnosticPort:EndpointName
chave.--no-auth
Desabilita a autenticação de chave de API. A predefinição é
false
.É altamente recomendável que esta opção não seja usada em ambientes de produção.
Esse valor não é mapeado na configuração.
--temp-apikey
Gera uma chave de API temporária para a
dotnet-monitor
instância.Esse valor é mapeado na configuração como a
Authentication:MonitorApiKey
chave.--no-http-egress
Desabilita a saída de artefatos de diagnóstico por meio da resposta HTTP. Quando especificado, os artefatos devem ser egressos usando um provedor de saída.
Esse valor não é mapeado na configuração.
--level
Nível de configuração.
Full
A configuração pode mostrar informações confidenciais. Existem dois níveis:Full
- A configuração completa sem qualquer edição de quaisquer valores.Redacted
- A configuração completa, mas informações confidenciais, como segredos conhecidos, é editada.
--show-sources
Identifica a partir de qual fonte de configuração cada valor de configuração efetivo é fornecido.
dotnet-monitor generatekey
Gere uma chave de API e hash para autenticação HTTP.
Sinopse
dotnet-monitor generatekey [-h|--help] [-o|--output]
Opções
-h|--help
Mostra a ajuda da linha de comando.
-o|--output <Cmd|Json|MachineJson|PowerShell|Shell|Text>
O formato de saída no qual as informações da chave da API são gravadas na saída padrão.
Os valores permitidos são:
Cmd
- Saídas em um formato utilizável no prompt de comando do Windows ou arquivos em lote.Json
- Saídas em um formato de um objeto JSON.MachineJson
- Saídas em um formato de um objeto JSON sem comentários e explicações. Útil para cenários de automação.PowerShell
- Saídas em um formato utilizável em prompts e scripts do PowerShell.Shell
- Saídas em um formato utilizável em shells Linux como Bash.Text
- Saídas em um formato que é texto simples.