Поделиться через

Служебная программа мониторинга диагностики и сбора (dotnet-monitor)

  • Статья

Эта статья относится к: версии 6.0.0 и более поздних версий. ✔️ dotnet-monitor

Установка

Существует два способа скачивания dotnet-monitor:

  • Средство dotnet global:

    Чтобы установить последнюю версию пакета NuGet dotnet-monitor, используйте команду dotnet tool install.

    dotnet tool install --global dotnet-monitor

  • Образ Docker:

    Скачайте образ Docker для использования в многоконтейнерных средах:

    docker pull mcr.microsoft.com/dotnet/monitor

Краткие сведения

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

Description

Глобальное dotnet-monitor средство — это способ мониторинга приложений .NET в рабочих средах и сбора диагностических артефактов (например, дампов, трассировок, журналов и метрик) по запросу или использования автоматических правил для сбора в указанных условиях.

Параметры

  • --version

    Отображает версию программы dotnet-monitor.

  • -h|--help

    Отображение справки в командной строке.

Команды

Команда
Сбор данных монитора dotnet
Показать конфигурацию dotnet monitor
Dotnet Monitor generatekey

сбор данных dotnet-monitor

Отслеживайте приложения .NET, разрешайте собирать диагностические артефакты и отправлять результаты в выбранное место назначения.

Краткие сведения

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

Параметры

  • -h|--help

    Отображение справки в командной строке.

  • -u|--urls <urls>

    Привязки для API HTTP. По умолчанию — https://localhost:52323.

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

    Включите публикацию метрик для /metrics маршрутизации. Значение по умолчанию: true.

  • --metricUrls <urls>

    Привязки для API HTTP метрик. По умолчанию — http://localhost:52325.

  • --diagnostic-port <path>

    Полный путь и имя файла порта диагностики, к которому могут подключаться экземпляры среды выполнения. Указание этого параметра помещает dotnet-monitor в режим прослушивания. Если он не указан, dotnet-monitor находится в режиме подключения.

    В Windows это должно быть допустимое имя именованного канала. В Linux и macOS это должен быть допустимый путь к сокету домена Unix.

  • --no-auth

    Отключает проверку подлинности ключа API. По умолчанию — false.

    Настоятельно рекомендуется использовать этот параметр в рабочих средах.

  • --temp-apikey

    Создает временный ключ API для экземпляра dotnet-monitor .

  • --no-http-egress

    Отключает исходящий трафик диагностических артефактов через HTTP-ответ. При указании артефакты должны быть исходящими с помощью поставщика исходящего трафика.

Показать конфигурацию dotnet-monitor

Показывает конфигурацию, как если бы dotnet-monitor collect она была выполнена с этими параметрами.

Краткие сведения

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

Параметры

  • -h|--help

    Отображение справки в командной строке.

  • -u|--urls <urls>

    Привязки для API HTTP. По умолчанию — https://localhost:52323.

    Это значение сопоставляется с конфигурацией в качестве urls ключа.

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

    Включите публикацию метрик для /metrics маршрутизации. По умолчанию — true.

    Это значение сопоставляется с конфигурацией в качестве Metrics:Enabled ключа.

  • --metricUrls <urls>

    Привязки для API HTTP метрик. По умолчанию — http://localhost:52325.

    Это значение сопоставляется с конфигурацией в качестве Metrics:Endpoints ключа.

  • --diagnostic-port <path>

    Полный путь и имя файла порта диагностики, к которому могут подключаться экземпляры среды выполнения. Указание этого параметра помещает dotnet-monitor в режим прослушивания. Если он не указан, dotnet-monitor находится в режиме подключения.

    В Windows это должно быть допустимое имя именованного канала. В Linux и macOS это должен быть допустимый путь к сокету домена Unix.

    Это значение сопоставляется с конфигурацией в качестве DiagnosticPort:EndpointName ключа.

  • --no-auth

    Отключает проверку подлинности ключа API. По умолчанию — false.

    Настоятельно рекомендуется использовать этот параметр в рабочих средах.

    Это значение не сопоставляется с конфигурацией.

  • --temp-apikey

    Создает временный ключ API для экземпляра dotnet-monitor .

    Это значение сопоставляется с конфигурацией в качестве Authentication:MonitorApiKey ключа.

  • --no-http-egress

    Отключает исходящий трафик диагностических артефактов через HTTP-ответ. При указании артефакты должны быть исходящими с помощью поставщика исходящего трафика.

    Это значение не сопоставляется с конфигурацией.

  • --level

    Уровень конфигурации. Full конфигурация может отображать конфиденциальную информацию. Существует два уровня:

    • Full — полная конфигурация без каких-либо повторов каких-либо значений.
    • Redacted — полная конфигурация, но конфиденциальная информация, например известные секреты, редактируется.

  • --show-sources

    Определяет, из какого источника конфигурации предоставляется каждое эффективное значение конфигурации.

dotnet-monitor generatekey

Создайте ключ API и хэш для проверки подлинности HTTP.

Краткие сведения

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

Параметры

  • -h|--help

    Отображение справки в командной строке.

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

    Формат выходных данных, в котором данные ключа API записываются в стандартные выходные данные.

    Допустимые значения:

    • Cmd — выходные данные в формате, который можно использовать в командной строке Windows или пакетных файлах.
    • Json — выходные данные в формате объекта JSON.
    • MachineJson — выходные данные в формате объекта JSON без комментариев и объяснений. Полезно для сценариев автоматизации.
    • PowerShell — Выходные данные в формате, который можно использовать в запросах и сценариях PowerShell.
    • Shell — Выходные данные в формате, который можно использовать в оболочках Linux, таких как Bash.
    • Text — выходные данные в формате, который является обычным текстом.

См. также