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

  • Статья

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

Установка

Скачать dotnet-monitorможно двумя способами:

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

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

    dotnet tool install --global dotnet-monitor

  • Образ Docker:

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

    docker pull mcr.microsoft.com/dotnet/monitor

Краткий обзор

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

Описание

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

Варианты

  • --version

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

  • -h|--help

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

Команды

Команда
dotnet monitor collect
dotnet monitor config show
ключ создания dotnet monitor

dotnet-monitor collect

Мониторинг приложений .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 находится в режиме "connect".

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

  • --no-auth

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

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

  • --temp-apikey

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

  • --no-http-egress

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

dotnet-monitor config show

Показывает конфигурацию, как если бы 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 находится в режиме "connect".

    В 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

Создайте ключ 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 — выходные данные в формате обычного текста.

См. также: