Dela via


Verktyg för diagnostikövervakning och insamling (dotnet-monitor)

Den här artikeln gäller för: ✔️ dotnet-monitor version 6.0.0 och senare versioner

Installera

Det finns två sätt att ladda ned dotnet-monitor:

  • dotnet global tool:

    Om du vill installera den senaste versionen av dotnet-monitor NuGet-paketet använder du installationskommandot för dotnet-verktyget:

    dotnet tool install --global dotnet-monitor
    
  • Docker-avbildning:

    Ladda ned en Docker-avbildning för användning i miljöer med flera containrar:

    docker pull mcr.microsoft.com/dotnet/monitor
    

Sammanfattning

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

beskrivning

Det dotnet-monitor globala verktyget är ett sätt att övervaka .NET-program i produktionsmiljöer och samla in diagnostiska artefakter (till exempel dumpar, spårningar, loggar och mått) på begäran eller använda automatiserade regler för insamling under angivna förhållanden.

Alternativ

  • --version

    Visar versionen av dotnet-monitor-verktyget.

  • -h|--help

    Visar kommandoradshjälp.

Kommandon

Command
dotnet monitor collect
dotnet monitor config show
dotnet monitor generatekey

dotnet-monitor collect

Övervaka .NET-program, tillåt insamling av diagnostiska artefakter och skicka resultatet till ett valt mål.

Sammanfattning

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

Alternativ

  • -h|--help

    Visar kommandoradshjälp.

  • -u|--urls <urls>

    Bindningar för HTTP-API:et. Standard är https://localhost:52323.

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

    Aktivera publicering av mått som ska /metrics dirigeras. Standardvärdet är true

  • --metricUrls <urls>

    Bindningar för http-api:et för mått. Standard är http://localhost:52325.

  • --diagnostic-port <path>

    Den fullständigt kvalificerade sökvägen och filnamnet för diagnostikporten som körningsinstanser kan ansluta till. Om du anger det här alternativet placeras dotnet-monitor det i lyssningsläge. När det inte anges dotnet-monitor är det i "anslut"-läge.

    I Windows måste detta vara ett giltigt namn på pipe. I Linux och macOS måste detta vara en giltig Unix Domain Socket-sökväg.

  • --no-auth

    Inaktiverar API-nyckelautentisering. Standard är false.

    Vi rekommenderar starkt att det här alternativet inte används i produktionsmiljöer.

  • --temp-apikey

    Genererar en tillfällig API-nyckel för instansen dotnet-monitor .

  • --no-http-egress

    Inaktiverar utgående diagnostikartefakter via HTTP-svaret. När det anges måste artefakter utgående med hjälp av en utgående provider.

dotnet-monitor config show

Visar konfigurationen, som om dotnet-monitor collect den kördes med dessa parametrar.

Sammanfattning

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

Alternativ

  • -h|--help

    Visar kommandoradshjälp.

  • -u|--urls <urls>

    Bindningar för HTTP-API:et. Standard är https://localhost:52323.

    Det här värdet mappas till konfigurationen urls som nyckel.

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

    Aktivera publicering av mått som ska /metrics dirigeras. Standard är true.

    Det här värdet mappas till konfigurationen Metrics:Enabled som nyckel.

  • --metricUrls <urls>

    Bindningar för http-api:et för mått. Standard är http://localhost:52325.

    Det här värdet mappas till konfigurationen Metrics:Endpoints som nyckel.

  • --diagnostic-port <path>

    Den fullständigt kvalificerade sökvägen och filnamnet för diagnostikporten som körningsinstanser kan ansluta till. Om du anger det här alternativet placeras dotnet-monitor det i lyssningsläge. När det inte anges dotnet-monitor är det i "anslut"-läge.

    I Windows måste detta vara ett giltigt namn på pipe. I Linux och macOS måste detta vara en giltig Unix Domain Socket-sökväg.

    Det här värdet mappas till konfigurationen DiagnosticPort:EndpointName som nyckel.

  • --no-auth

    Inaktiverar API-nyckelautentisering. Standard är false.

    Vi rekommenderar starkt att det här alternativet inte används i produktionsmiljöer.

    Det här värdet mappas inte till konfigurationen.

  • --temp-apikey

    Genererar en tillfällig API-nyckel för instansen dotnet-monitor .

    Det här värdet mappas till konfigurationen Authentication:MonitorApiKey som nyckel.

  • --no-http-egress

    Inaktiverar utgående diagnostikartefakter via HTTP-svaret. När det anges måste artefakter utgående med hjälp av en utgående provider.

    Det här värdet mappas inte till konfigurationen.

  • --level

    Konfigurationsnivå. Full konfiguration kan visa känslig information. Det finns två nivåer:

    • Full – Den fullständiga konfigurationen utan redigering av några värden.
    • Redacted – Den fullständiga konfigurationen men känslig information, till exempel kända hemligheter, redigeras.
  • --show-sources

    Identifierar från vilken konfigurationskälla varje effektivt konfigurationsvärde anges.

dotnet-monitor generatekey

Generera en API-nyckel och hash för HTTP-autentisering.

Sammanfattning

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

Alternativ

  • -h|--help

    Visar kommandoradshjälp.

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

    Utdataformatet där API-nyckelinformationen skrivs till standardutdata.

    De tillåtna värdena är:

    • Cmd – Utdata i ett format som kan användas i Windows-kommandotolken eller batchfilerna.
    • Json – Utdata i ett format av ett JSON-objekt.
    • MachineJson – Utdata i ett format av ett JSON-objekt utan kommentarer och förklaring. Användbart för automatiseringsscenarier.
    • PowerShell – Utdata i ett format som kan användas i PowerShell-prompter och skript.
    • Shell – Utdata i ett format som kan användas i Linux-gränssnitt som Bash.
    • Text – Utdata i ett format som är oformaterad text.

Se även