Udostępnij za pośrednictwem

Narzędzie do monitorowania i zbierania danych diagnostycznych (dotnet-monitor)

  • Artykuł

Ten artykuł dotyczy wersji ✔️ dotnet-monitor 6.0.0 lub nowszej

Instalowanie

Istnieją dwa sposoby pobierania dotnet-monitor:

  • dotnet global tool:

    Aby zainstalować najnowszą wersję dotnet-monitor pakietu NuGet, użyj polecenia dotnet tool install :

    dotnet tool install --global dotnet-monitor

  • Obraz platformy Docker:

    Pobierz obraz platformy Docker do użycia w środowiskach z wieloma kontenerami:

    docker pull mcr.microsoft.com/dotnet/monitor

Streszczenie

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

opis

Narzędzie dotnet-monitor globalne to sposób monitorowania aplikacji .NET w środowiskach produkcyjnych i zbierania artefaktów diagnostycznych (na przykład zrzutów, śladów, dzienników i metryk) na żądanie lub używania zautomatyzowanych reguł do zbierania w określonych warunkach.

Opcje

  • --version

    Wyświetla wersję narzędzia dotnet-monitor.

  • -h|--help

    Pokazuje pomoc wiersza polecenia.

Polecenia

Polecenie
dotnet monitor collect
dotnet monitor config show
dotnet monitor generatekey

dotnet-monitor collect

Monitoruj aplikacje .NET, zezwalaj na zbieranie artefaktów diagnostycznych i wysyłaj wyniki do wybranego miejsca docelowego.

Streszczenie

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

Opcje

  • -h|--help

    Pokazuje pomoc wiersza polecenia.

  • -u|--urls <urls>

    Powiązania dla interfejsu API HTTP. Wartość domyślna to https://localhost:52323.

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

    Włącz publikowanie metryk w celu /metrics kierowania. Wartość domyślna to true

  • --metricUrls <urls>

    Powiązania dla interfejsu API HTTP metryk. Wartość domyślna to http://localhost:52325.

  • --diagnostic-port <path>

    W pełni kwalifikowana ścieżka i nazwa pliku portu diagnostycznego, z którym mogą łączyć się wystąpienia środowiska uruchomieniowego. Określanie tej opcji powoduje umieszczenie dotnet-monitor w trybie "nasłuchiwania". Jeśli nie zostanie określony, dotnet-monitor jest w trybie "połącz".

    W systemie Windows musi to być prawidłowa nazwa potoku o nazwie. W systemach Linux i macOS musi to być prawidłowa ścieżka gniazda domeny systemu Unix.

  • --no-auth

    Wyłącza uwierzytelnianie klucza interfejsu API. Wartość domyślna to false.

    Zdecydowanie zaleca się, aby ta opcja nie była używana w środowiskach produkcyjnych.

  • --temp-apikey

    Generuje tymczasowy klucz interfejsu dotnet-monitor API dla wystąpienia.

  • --no-http-egress

    Wyłącza ruch wychodzący artefaktów diagnostycznych za pośrednictwem odpowiedzi HTTP. Po określeniu artefakty muszą być wychodzące przy użyciu dostawcy ruchu wychodzącego.

dotnet-monitor — pokaż konfigurację

Pokazuje konfigurację, tak jakby dotnet-monitor collect została wykonana z tymi parametrami.

Streszczenie

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

Opcje

  • -h|--help

    Pokazuje pomoc wiersza polecenia.

  • -u|--urls <urls>

    Powiązania dla interfejsu API HTTP. Wartość domyślna to https://localhost:52323.

    Ta wartość jest mapowana na konfigurację urls jako klucz.

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

    Włącz publikowanie metryk w celu /metrics kierowania. Wartość domyślna to true.

    Ta wartość jest mapowana na konfigurację Metrics:Enabled jako klucz.

  • --metricUrls <urls>

    Powiązania dla interfejsu API HTTP metryk. Wartość domyślna to http://localhost:52325.

    Ta wartość jest mapowana na konfigurację Metrics:Endpoints jako klucz.

  • --diagnostic-port <path>

    W pełni kwalifikowana ścieżka i nazwa pliku portu diagnostycznego, z którym mogą łączyć się wystąpienia środowiska uruchomieniowego. Określanie tej opcji powoduje umieszczenie dotnet-monitor w trybie "nasłuchiwania". Jeśli nie zostanie określony, dotnet-monitor jest w trybie "połącz".

    W systemie Windows musi to być prawidłowa nazwa potoku o nazwie. W systemach Linux i macOS musi to być prawidłowa ścieżka gniazda domeny systemu Unix.

    Ta wartość jest mapowana na konfigurację DiagnosticPort:EndpointName jako klucz.

  • --no-auth

    Wyłącza uwierzytelnianie klucza interfejsu API. Wartość domyślna to false.

    Zdecydowanie zaleca się, aby ta opcja nie była używana w środowiskach produkcyjnych.

    Ta wartość nie jest mapowana na konfigurację.

  • --temp-apikey

    Generuje tymczasowy klucz interfejsu dotnet-monitor API dla wystąpienia.

    Ta wartość jest mapowana na konfigurację Authentication:MonitorApiKey jako klucz.

  • --no-http-egress

    Wyłącza ruch wychodzący artefaktów diagnostycznych za pośrednictwem odpowiedzi HTTP. Po określeniu artefakty muszą być wychodzące przy użyciu dostawcy ruchu wychodzącego.

    Ta wartość nie jest mapowana na konfigurację.

  • --level

    Poziom konfiguracji. Full konfiguracja może wyświetlać poufne informacje. Istnieją dwa poziomy:

    • Full - Pełna konfiguracja bez konieczności ponownego redacjonowania żadnych wartości.
    • Redacted - Pełna konfiguracja, ale poufne informacje, takie jak znane wpisy tajne, są redagowane.

  • --show-sources

    Określa, z którego źródła konfiguracji jest podana każda efektywna wartość konfiguracji.

dotnet-monitor generatekey

Generowanie klucza interfejsu API i skrótu na potrzeby uwierzytelniania HTTP.

Streszczenie

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

Opcje

  • -h|--help

    Pokazuje pomoc wiersza polecenia.

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

    Format danych wyjściowych, w którym informacje o kluczu interfejsu API są zapisywane w standardowych danych wyjściowych.

    Dozwolone wartości to:

    • Cmd — Dane wyjściowe w formacie używanym w wierszu polecenia systemu Windows lub plikach wsadowych.
    • Json — Dane wyjściowe w formacie obiektu JSON.
    • MachineJson — Dane wyjściowe w formacie obiektu JSON bez komentarzy i wyjaśnień. Przydatne w scenariuszach automatyzacji.
    • PowerShell — Dane wyjściowe w formacie używanym w monitach i skryptach programu PowerShell.
    • Shell — Dane wyjściowe w formacie używanym w powłokach systemu Linux, takich jak powłoka Bash.
    • Text — Dane wyjściowe w formacie zwykłego tekstu.

Zobacz też