Share via

Nástroj pro monitorování a shromažďování diagnostických dat (dotnet-monitor)

  • Článek

Tento článek se týká: ✔️ dotnet-monitor verze 6.0.0 a novějších verzí.

Instalace

Existují dva způsoby, jak stáhnout dotnet-monitor:

  • dotnet global tool:

    Pokud chcete nainstalovat nejnovější vydanou dotnet-monitor verzi balíčku NuGet, použijte příkaz dotnet install tool:

    dotnet tool install --global dotnet-monitor

  • Image Dockeru:

    Stažení image Dockeru pro použití ve vícekontejnerových prostředích:

    docker pull mcr.microsoft.com/dotnet/monitor

Synopse

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

Description

Globální dotnet-monitor nástroj je způsob, jak monitorovat aplikace .NET v produkčních prostředích a shromažďovat diagnostické artefakty (například výpisy, trasování, protokoly a metriky) na vyžádání nebo pomocí automatizovaných pravidel pro shromažďování dat za zadaných podmínek.

Možnosti

  • --version

    Zobrazí verzi nástroje dotnet-monitor.

  • -h|--help

    Zobrazí nápovědu příkazového řádku.

Příkazy

Příkaz
dotnet monitor collect
dotnet monitor config show
dotnet monitor generatekey

dotnet-monitor collect

Monitorujte aplikace .NET, povolte shromažďování diagnostických artefaktů a odesílejte výsledky do zvoleného cíle.

Synopse

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

Možnosti

  • -h|--help

    Zobrazí nápovědu příkazového řádku.

  • -u|--urls <urls>

    Vazby pro rozhraní HTTP API. Výchozí je https://localhost:52323.

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

    Povolte publikování metrik pro /metrics směrování. Výchozí hodnota je true

  • --metricUrls <urls>

    Vazby pro rozhraní HTTP API metrik. Výchozí je http://localhost:52325.

  • --diagnostic-port <path>

    Plně kvalifikovaná cesta a název souboru diagnostického portu, ke kterému se mohou instance modulu runtime připojit. Zadáním této možnosti přejdete dotnet-monitor do režimu naslouchání. Pokud není zadaný, dotnet-monitor je v režimu připojení.

    Ve Windows musí jít o platný název pojmenovaného kanálu. V systémech Linux a macOS se musí jednat o platnou cestu k soketu domény systému Unix.

  • --no-auth

    Zakáže ověřování pomocí klíče rozhraní API. Výchozí je false.

    Důrazně doporučujeme, aby se tato možnost nepoužívala v produkčních prostředích.

  • --temp-apikey

    Vygeneruje dočasný klíč rozhraní API pro dotnet-monitor instanci.

  • --no-http-egress

    Zakáže výchozí přenos diagnostických artefaktů prostřednictvím odpovědi HTTP. Pokud je zadaná, artefakty musí být výchozí přenos dat pomocí zprostředkovatele výchozího přenosu dat.

dotnet-monitor config show

Zobrazuje konfiguraci, jako by dotnet-monitor collect byla provedena s těmito parametry.

Synopse

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

Možnosti

  • -h|--help

    Zobrazí nápovědu příkazového řádku.

  • -u|--urls <urls>

    Vazby pro rozhraní HTTP API. Výchozí je https://localhost:52323.

    Tato hodnota se mapuje na konfiguraci jako urls klíč.

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

    Povolte publikování metrik pro /metrics směrování. Výchozí je true.

    Tato hodnota se mapuje na konfiguraci jako Metrics:Enabled klíč.

  • --metricUrls <urls>

    Vazby pro rozhraní HTTP API metrik. Výchozí je http://localhost:52325.

    Tato hodnota se mapuje na konfiguraci jako Metrics:Endpoints klíč.

  • --diagnostic-port <path>

    Plně kvalifikovaná cesta a název souboru diagnostického portu, ke kterému se mohou instance modulu runtime připojit. Zadáním této možnosti přejdete dotnet-monitor do režimu naslouchání. Pokud není zadaný, dotnet-monitor je v režimu připojení.

    Ve Windows musí jít o platný název pojmenovaného kanálu. V systémech Linux a macOS se musí jednat o platnou cestu k soketu domény systému Unix.

    Tato hodnota se mapuje na konfiguraci jako DiagnosticPort:EndpointName klíč.

  • --no-auth

    Zakáže ověřování pomocí klíče rozhraní API. Výchozí je false.

    Důrazně doporučujeme, aby se tato možnost nepoužívala v produkčních prostředích.

    Tato hodnota není namapována na konfiguraci.

  • --temp-apikey

    Vygeneruje dočasný klíč rozhraní API pro dotnet-monitor instanci.

    Tato hodnota se mapuje na konfiguraci jako Authentication:MonitorApiKey klíč.

  • --no-http-egress

    Zakáže výchozí přenos diagnostických artefaktů prostřednictvím odpovědi HTTP. Pokud je zadaná, artefakty musí být výchozí přenos dat pomocí zprostředkovatele výchozího přenosu dat.

    Tato hodnota není namapována na konfiguraci.

  • --level

    Úroveň konfigurace. Full konfigurace může zobrazovat citlivé informace. Existují dvě úrovně:

    • Full – Úplná konfigurace bez jakékoli změny hodnot.
    • Redacted – Úplná konfigurace, ale citlivé informace, jako jsou známé tajné kódy, se redigují.

  • --show-sources

    Určuje, ze kterého zdroje konfigurace jsou poskytnuty všechny efektivní hodnoty konfigurace.

dotnet-monitor generatekey

Vygenerujte klíč rozhraní API a hodnotu hash pro ověřování HTTP.

Synopse

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

Možnosti

  • -h|--help

    Zobrazí nápovědu příkazového řádku.

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

    Výstupní formát, ve kterém se informace o klíči rozhraní API zapisují do standardního výstupu.

    Povolené hodnoty jsou:

    • Cmd – Výstupy ve formátu použitelném v příkazovém řádku Windows nebo v dávkových souborech.
    • Json – Výstupy ve formátu objektu JSON.
    • MachineJson – Výstupy ve formátu objektu JSON bez komentářů a vysvětlení. Užitečné pro scénáře automatizace.
    • PowerShell – Výstupy ve formátu použitelném v powershellových výzev a skriptech.
    • Shell – Výstupy ve formátu použitelném v prostředích Linuxu, jako je Bash.
    • Text – Výstupy ve formátu prostého textu.

Viz také