Utilitário de monitoramento e coleta de diagnóstico (dotnet-monitor)

Este artigo se aplica a: ✔️ dotnet-monitor versão 6.0.0 e versões posteriores

Instalar

Há duas formas de baixar dotnet-monitor:

• Ferramenta global dotnet:

  Para instalar a versão mais recente do dotnet-monitorpacote NuGet, use o comando dotnet tool install:

  dotnet tool install --global dotnet-monitor
  

• Docker image:

  Baixe 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>

Descrição

A ferramenta global dotnet-monitor é uma maneira de monitorar aplicativos .NET em ambientes de produção e coletar artefatos de diagnóstico (por exemplo, despejos, rastreamentos, logs e métricas) sob demanda ou usando regras automatizadas para coleta em 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

dotnet-monitor collect

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>

  Associações para a API HTTP. O padrão é https://localhost:52323.

• -m|--metrics [true|false]

  Habilite a publicação de métricas para /metrics rotear. O padrão é true

• --metricUrls <urls>

  Associações para API HTTP de métricas. O padrã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 runtime podem se conectar. Especificar essa opção coloca dotnet-monitor o modo 'listen'. Quando não especificado, dotnet-monitor fica no modo 'connect'.

  No Windows, esse deve ser um nome de pipe nomeado válido. No Linux e no macOS, esse deve ser um caminho válido do Soquete de domínio Unix.

• --no-auth

  Desabilita a autenticação da chave de API. O padrão é false.

  É altamente recomendável que essa opção não seja usada em ambientes de produção.

• --temp-apikey

  Gera uma chave de API temporária para a instância dotnet-monitor.

• --no-http-egress

  Desabilita a saída de artefatos de diagnóstico por meio da resposta HTTP. Quando especificados, os artefatos devem ser saídas usando um provedor de saída.

dotnet-monitor config show

Mostra a configuração, como se dotnet-monitor collect tivesse sido executado 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>

  Associações para a API HTTP. O padrão é https://localhost:52323.

  Esse valor é mapeado para a configuração como a chave urls.

• -m|--metrics [true|false]

  Habilite a publicação de métricas para /metrics rotear. O padrão é true.

  Esse valor é mapeado para a configuração como a chave Metrics:Enabled.

• --metricUrls <urls>

  Associações para API HTTP de métricas. O padrão é http://localhost:52325.

  Esse valor é mapeado para a configuração como a chave Metrics:Endpoints.

• --diagnostic-port <path>

  O caminho totalmente qualificado e o nome do arquivo da porta de diagnóstico à qual as instâncias de runtime podem se conectar. Especificar essa opção coloca dotnet-monitor o modo 'listen'. Quando não especificado, dotnet-monitor fica no modo 'connect'.

  No Windows, esse deve ser um nome de pipe nomeado válido. No Linux e no macOS, esse deve ser um caminho válido do Soquete de domínio Unix.

  Esse valor é mapeado para a configuração como a chave DiagnosticPort:EndpointName.

• --no-auth

  Desabilita a autenticação da chave de API. O padrão é false.

  É altamente recomendável que essa 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 instância dotnet-monitor.

  Esse valor é mapeado para a configuração como a chave Authentication:MonitorApiKey.

• --no-http-egress

  Desabilita a saída de artefatos de diagnóstico por meio da resposta HTTP. Quando especificados, os artefatos devem ser saídas usando um provedor de saída.

  Esse valor não é mapeado na configuração.

• --level

  Nível de configuração. A configuração Full pode mostrar informações confidenciais. Há dois níveis:

  • Full - A configuração completa sem nenhuma redação de nenhum valor.
  • Redacted - A configuração completa, mas informações confidenciais, como segredos conhecidos, são redigidas.

• --show-sources

  Identifica de qual fonte de configuração cada valor de configuração efetivo é fornecido.

dotnet-monitor generatekey

Gere uma chave de API e um hash para autenticação HTTP.

Sinopse

dotnet-monitor generatekey [-h|--help] [-o|--output] [-e|--expiration]

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 de chave de API são gravadas na saída padrão.

  Os valores permitidos são:

  • Cmd - Gera uma saída em um formato utilizável no Prompt de Comando do Windows ou arquivos em lote.
  • Json - Gera uma saída em um formato de um objeto JSON.
  • MachineJson - Gera saída em um formato de um objeto JSON sem comentários e explicação. Útil para cenários de automação.
  • PowerShell - Gera uma saída em um formato utilizável em prompts e scripts do PowerShell.
  • Shell - Gera uma saída em um formato utilizável em shells do Linux, como Bash.
  • Text - Gera uma saída em um formato de texto sem formatação.

• -e|--expiration <expiration>

  O tempo de expiração após o qual a chave de API gerada não será mais aceita. O valor deve estar no formato TimeSpan (por exemplo, "7.00:00:00" por 7 dias). Padrão: "7.00:00:00" (7 dias).

Consulte também

• dotnet/dotnet-monitor