Hilfsprogramm für die diagnostische Überwachung und Sammlung (dotnet-monitor)

  • Artikel

Dieser Artikel gilt für: ✔️ dotnet-monitor 6.0.0 und höhere Versionen

Installieren

Zum Herunterladen von dotnet-monitor gibt es zwei Möglichkeiten:

  • Globales dotnet-Tool:

    Verwenden Sie zum Installieren der neuesten Releaseversion des NuGet-Paketsdotnet-monitor den Befehl dotnet tool install:

    dotnet tool install --global dotnet-monitor

  • Docker-Image:

    Laden Sie ein Docker-Image für die Verwendung in Umgebungen mit mehreren Containern herunter:

    docker pull mcr.microsoft.com/dotnet/monitor

Übersicht

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

Beschreibung

Das globale dotnet-monitor-Tool ist eine Möglichkeit, .NET-Anwendungen in Produktionsumgebungen zu überwachen und Diagnoseartefakte (z. B. Speicherabbilder, Ablaufverfolgungen, Protokolle und Metriken) bei Bedarf oder mithilfe automatisierter Regeln für die Sammlung nach bestimmten Bedingungen zu erfassen.

Optionen

  • --version

    Zeigt die Version des Hilfsprogramms „dotnet-monitor“ an.

  • -h|--help

    Zeigt die Hilfe für die Befehlszeile an.

Befehle

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

dotnet-monitor collect

Überwachen Sie .NET-Anwendungen, erlauben Sie das Sammeln von Diagnoseartefakten, und senden Sie die Ergebnisse an ein ausgewähltes Ziel.

Übersicht

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

Optionen

  • -h|--help

    Zeigt die Hilfe für die Befehlszeile an.

  • -u|--urls <urls>

    Bindungen für die HTTP-API. Der Standardwert ist https://localhost:52323.

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

    Ermöglichen Sie die Veröffentlichung von Metriken an die /metrics-Route. Die Standardeinstellung ist true.

  • --metricUrls <urls>

    Bindungen für die Metrik-HTTP-API. Der Standardwert ist http://localhost:52325.

  • --diagnostic-port <path>

    Der vollqualifizierte Pfad und Dateiname des Diagnoseports, mit dem Runtime-Instanzen eine Verbindung herstellen können. Wenn Sie diese Option angeben, wird dotnet-monitor in den Modus „listen“ versetzt. Wenn sie nicht angegeben wird, befindet dotnet-monitor sich im Modus „connect“.

    Unter Windows muss dies ein gültiger Named Pipe-Name sein. Unter Linux und macOS muss dies ein gültiger Unix Domain Socket-Pfad sein.

  • --no-auth

    Deaktiviert die API-Schlüsselauthentifizierung. Der Standardwert ist false.

    Es wird dringend davon abgeraten, diese Option in Produktionsumgebungen zu verwenden.

  • --temp-apikey

    Generiert einen temporären API-Schlüssel für die dotnet-monitor-Instanz.

  • --no-http-egress

    Deaktiviert den Ausgang von Diagnoseartefakten über die HTTP-Antwort. Wenn diese Option angegeben wird, müssen Artefakte über einen Ausgangsanbieter ausgehen.

dotnet-monitor config show

Zeigt die Konfiguration so an, wie dotnet-monitor collect mit diesen Parametern ausgeführt würde.

Übersicht

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

Optionen

  • -h|--help

    Zeigt die Hilfe für die Befehlszeile an.

  • -u|--urls <urls>

    Bindungen für die HTTP-API. Der Standardwert ist https://localhost:52323.

    Dieser Wert wird der Konfiguration als urls-Schlüssel zugeordnet.

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

    Ermöglichen Sie die Veröffentlichung von Metriken an die /metrics-Route. Der Standardwert ist true.

    Dieser Wert wird der Konfiguration als Metrics:Enabled-Schlüssel zugeordnet.

  • --metricUrls <urls>

    Bindungen für die Metrik-HTTP-API. Der Standardwert ist http://localhost:52325.

    Dieser Wert wird der Konfiguration als Metrics:Endpoints-Schlüssel zugeordnet.

  • --diagnostic-port <path>

    Der vollqualifizierte Pfad und Dateiname des Diagnoseports, mit dem Runtime-Instanzen eine Verbindung herstellen können. Wenn Sie diese Option angeben, wird dotnet-monitor in den Modus „listen“ versetzt. Wenn sie nicht angegeben wird, befindet dotnet-monitor sich im Modus „connect“.

    Unter Windows muss dies ein gültiger Named Pipe-Name sein. Unter Linux und macOS muss dies ein gültiger Unix Domain Socket-Pfad sein.

    Dieser Wert wird der Konfiguration als DiagnosticPort:EndpointName-Schlüssel zugeordnet.

  • --no-auth

    Deaktiviert die API-Schlüsselauthentifizierung. Der Standardwert ist false.

    Es wird dringend davon abgeraten, diese Option in Produktionsumgebungen zu verwenden.

    Dieser Wert wird nicht der Konfiguration zugeordnet.

  • --temp-apikey

    Generiert einen temporären API-Schlüssel für die dotnet-monitor-Instanz.

    Dieser Wert wird der Konfiguration als Authentication:MonitorApiKey-Schlüssel zugeordnet.

  • --no-http-egress

    Deaktiviert den Ausgang von Diagnoseartefakten über die HTTP-Antwort. Wenn diese Option angegeben wird, müssen Artefakte über einen Ausgangsanbieter ausgehen.

    Dieser Wert wird nicht der Konfiguration zugeordnet.

  • --level

    Konfigurationsebene. Die Full-Konfiguration kann vertrauliche Informationen anzeigen. Es gibt zwei Ebenen:

    • Full: Die vollständige Konfiguration ohne Bearbeitung von Werten.
    • Redacted: Die vollständige Konfiguration, in der vertrauliche Informationen, z. B. bekannte Geheimnisse, bearbeitet werden.

  • --show-sources

    Gibt an, von welcher Konfigurationsquelle die einzelnen effektiven Konfigurationswerte bereitgestellt werden.

dotnet-monitor generatekey

Generieren Sie einen API-Schlüssel und einen Hash für die HTTP-Authentifizierung.

Übersicht

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

Optionen

  • -h|--help

    Zeigt die Hilfe für die Befehlszeile an.

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

    Das Ausgabeformat, in dem die API-Schlüsselinformationen in die Standardausgabe geschrieben werden.

    Zulässige Werte sind:

    • Cmd: Ausgaben in einem Format, das in der Windows-Eingabeaufforderung oder in Batchdateien verwendet werden kann.
    • Json: Ausgaben im Format eines JSON-Objekts.
    • MachineJson: Ausgaben im Format eines JSON-Objekts ohne Kommentare und Erklärungen. Für Automatisierungsszenarien nützlich.
    • PowerShell: Ausgaben in einem Format, das in PowerShell-Eingabeaufforderungen und -Skripts verwendet werden kann.
    • Shell: Ausgaben in einem Format, das in Linux-Shells wie Bash verwendet werden kann.
    • Text: Ausgaben in einem Nur-Text-Format.

Weitere Informationen