Utilidad de recopilación y supervisión de diagnósticos (dotnet-monitor)

  • Artículo

Este artículo se aplica a: ✔️ dotnet-monitor versión 6.0.0 y posteriores

Instalar

Existen dos formas de descargar dotnet-monitor:

  • Herramienta global dotnet:

    Para instalar la versión de lanzamiento más reciente del paquete NuGet de dotnet-monitor, use el comando dotnet tool install:

    dotnet tool install --global dotnet-monitor

  • Imagen de Docker:

    Descargue una imagen de Docker para su uso en entornos multicontenedor:

    docker pull mcr.microsoft.com/dotnet/monitor

Sinopsis

dotnet-monitor [-h|--help] [--version] <command>

Descripción

La herramienta global dotnet-monitor es una manera de supervisar las aplicaciones .NET en entornos de producción y recopilar artefactos de diagnóstico (por ejemplo, volcados, seguimientos, registros y métricas) bajo demanda o mediante reglas automatizadas para la recopilación en condiciones especificadas.

Opciones

  • --version

    Muestra la versión de la utilidad dotnet-monitor.

  • -h|--help

    Muestra la ayuda de la línea de comandos.

Comandos

Get-Help
dotnet monitor collect
dotnet monitor config show
dotnet monitor generatekey

dotnet-monitor collect

Supervise las aplicaciones .NET, permita la recopilación de artefactos de diagnóstico y envíe los resultados a un destino elegido.

Sinopsis

dotnet-monitor collect [-h|--help] [-u|--urls] [-m|--metrics] [--metricUrls] [--diagnostic-port] [--no-auth] [--temp-apikey] [--no-http-egress]

Opciones

  • -h|--help

    Muestra la ayuda de la línea de comandos.

  • -u|--urls <urls>

    Enlaces para la API de HTTP. El valor predeterminado es https://localhost:52323.

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

    Habilite la publicación de métricas para la ruta /metrics. Valor predeterminado: true

  • --metricUrls <urls>

    Enlaces para la API de HTTP de métricas. El valor predeterminado es http://localhost:52325.

  • --diagnostic-port <path>

    La ruta de acceso completa y el nombre de archivo del puerto de diagnóstico al que se pueden conectar las instancias en tiempo de ejecución. Al especificar esta opción, se coloca dotnet-monitor en modo "escuchar". Cuando no se especifica, dotnet-monitor está en modo "conectar".

    En Windows, debe ser un nombre de canalización con nombre válido. En Linux y macOS, debe ser una ruta de acceso de socket de dominio Unix válida.

  • --no-auth

    Deshabilita la autenticación de clave de API. El valor predeterminado es false.

    Se recomienda encarecidamente que esta opción no se use en entornos de producción.

  • --temp-apikey

    Genera una clave de API temporal para la instancia dotnet-monitor.

  • --no-http-egress

    Deshabilita la salida de artefactos de diagnóstico a través de la respuesta HTTP. Cuando se especifica, los artefactos se deben enviar mediante un proveedor de salida.

dotnet-monitor config show

Muestra la configuración, como si dotnet-monitor collect se ejecutara con estos parámetros.

Sinopsis

dotnet-monitor config show [-h|--help] [-u|--urls] [-m|--metrics] [--metricUrls] [--diagnostic-port] [--no-auth] [--temp-apikey] [--no-http-egress] [--level] [--show-sources]

Opciones

  • -h|--help

    Muestra la ayuda de la línea de comandos.

  • -u|--urls <urls>

    Enlaces para la API de HTTP. El valor predeterminado es https://localhost:52323.

    Este valor se asigna a la configuración como la clave urls.

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

    Habilite la publicación de métricas para la ruta /metrics. El valor predeterminado es true.

    Este valor se asigna a la configuración como la clave Metrics:Enabled.

  • --metricUrls <urls>

    Enlaces para la API de HTTP de métricas. El valor predeterminado es http://localhost:52325.

    Este valor se asigna a la configuración como la clave Metrics:Endpoints.

  • --diagnostic-port <path>

    La ruta de acceso completa y el nombre de archivo del puerto de diagnóstico al que se pueden conectar las instancias en tiempo de ejecución. Al especificar esta opción, se coloca dotnet-monitor en modo "escuchar". Cuando no se especifica, dotnet-monitor está en modo "conectar".

    En Windows, debe ser un nombre de canalización con nombre válido. En Linux y macOS, debe ser una ruta de acceso de socket de dominio Unix válida.

    Este valor se asigna a la configuración como la clave DiagnosticPort:EndpointName.

  • --no-auth

    Deshabilita la autenticación de clave de API. El valor predeterminado es false.

    Se recomienda encarecidamente que esta opción no se use en entornos de producción.

    Este valor no está asignado a la configuración.

  • --temp-apikey

    Genera una clave de API temporal para la instancia dotnet-monitor.

    Este valor se asigna a la configuración como la clave Authentication:MonitorApiKey.

  • --no-http-egress

    Deshabilita la salida de artefactos de diagnóstico a través de la respuesta HTTP. Cuando se especifica, los artefactos se deben enviar mediante un proveedor de salida.

    Este valor no está asignado a la configuración.

  • --level

    Nivel de configuración. La configuración Full puede mostrar información confidencial. Hay dos niveles:

    • Full: la configuración completa sin ninguna redacción de ningún valor.
    • Redacted: se redacta la configuración completa excepto la información confidencial, como secretos conocidos.

  • --show-sources

    Identifica desde qué origen de configuración se proporciona cada valor de configuración efectivo.

dotnet-monitor generatekey

Genere una clave de API y un hash para la autenticación HTTP.

Sinopsis

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

Opciones

  • -h|--help

    Muestra la ayuda de la línea de comandos.

  • -o|--output <Cmd|Json|MachineJson|PowerShell|Shell|Text>

    El formato de salida en el que se escribe la información de la clave de API en la salida estándar.

    Entre los valores permitidos se incluyen los siguientes:

    • Cmd: salidas en un formato utilizable en el símbolo del sistema de Windows o archivos por lotes.
    • Json: salidas en un formato de un objeto JSON.
    • MachineJson: salidas en un formato de un objeto JSON sin comentarios y explicación. Resulta útil en escenarios de automatización.
    • PowerShell: salidas en un formato utilizable en las solicitudes y scripts de PowerShell.
    • Shell: salidas en un formato utilizable en shells de Linux como Bash.
    • Text: salidas en un formato que es texto sin formato.

Consulte también