Konfiguration av instrumentpanel

Instrumentpanelen konfigureras när den startas. Konfigurationen omfattar klientdels- och OpenTelemetry Protocol-adresser (OTLP), resurstjänstens slutpunkt, autentisering, telemetrigränser med mera.

När instrumentpanelen startas med Aspire AppHost-projektet konfigureras den automatiskt för att visa appens resurser och telemetri. Konfiguration tillhandahålls när instrumentpanelen startas i fristående läge.

Det finns många sätt att tillhandahålla konfiguration:

• Kommandoradsargument.
• Miljövariabler. Den : avgränsare bör ersättas med dubbelt understreck (__) i miljövariabelnamn.
• Valfritt JSON konfigurationsfil. Inställningen ASPIRE_DASHBOARD_CONFIG_FILE_PATH kan användas för att ange en JSON konfigurationsfil.

Tänk på följande exempel som visar hur du konfigurerar instrumentpanelen när den startas från en Docker container:

docker run --rm -it -p 18888:18888 -p 4317:18889 -d --name aspire-dashboard \
    -e DASHBOARD__TELEMETRYLIMITS__MAXLOGCOUNT='1000' \
    -e DASHBOARD__TELEMETRYLIMITS__MAXTRACECOUNT='1000' \
    -e DASHBOARD__TELEMETRYLIMITS__MAXMETRICSCOUNT='1000' \
    mcr.microsoft.com/dotnet/aspire-dashboard:9.5

docker run --rm -it -p 18888:18888 -p 4317:18889 -d --name aspire-dashboard `
    -e DASHBOARD__TELEMETRYLIMITS__MAXLOGCOUNT='1000' `
    -e DASHBOARD__TELEMETRYLIMITS__MAXTRACECOUNT='1000' `
    -e DASHBOARD__TELEMETRYLIMITS__MAXMETRICSCOUNT='1000' `
    mcr.microsoft.com/dotnet/aspire-dashboard:9.5

Du kan också konfigurera samma värden med hjälp av en JSON konfigurationsfil som anges med hjälp av ASPIRE_DASHBOARD_CONFIG_FILE_PATH:

{
  "Dashboard": {
    "TelemetryLimits": {
      "MaxLogCount": 1000,
      "MaxTraceCount": 1000,
      "MaxMetricsCount": 1000
    }
  }
}

Gemensam konfiguration

Klientdelsautentisering

Autentiseringen av klientdelsslutpunkten på instrumentpanelen konfigureras med Dashboard:Frontend:AuthMode. Klientdelen kan skyddas med OpenID Connect (OIDC) eller webbläsartokenautentisering.

Autentisering med webbläsartoken fungerar av klientdelen som ber om en token. Token kan antingen anges i användargränssnittet eller anges som ett frågesträngsvärde på inloggningssidan. Till exempel https://localhost:1234/login?t=TheToken. När token har autentiserats sparas en autentisering cookie i webbläsaren och webbläsaren omdirigeras till appen.

OTLP-autentisering

OTLP-slutpunktsautentiseringen konfigureras med Dashboard:Otlp:AuthMode. OTLP-slutpunkten kan skyddas med en API-nyckel eller klientcertifikatautentisering.

API-nyckelautentisering fungerar genom att kräva att varje OTLP-begäran har ett giltigt x-otlp-api-key huvudvärde. Den måste matcha antingen den primära eller sekundära nyckeln.

Client certifikatautentisering verifierar TLS-anslutningens klientcertifikat. När en begäran med ett klientcertifikat tas emot utförs två uppsättningar verifiering:

• ASP.NET Core validering av certifikatautentisering: Som standard verifierar detta att certifikatet kedjas till en betrodd rot på datorn, att certifikatet inte har upphört att gälla och att värdet för utökad nyckelanvändning är lämpligt för Client Autentisering. Mer information om den här valideringen och hur du konfigurerar den finns i Konfigurera ASP.NET Core certifikatverifiering.
• Valfri explicit lista över tillåtna certifikat: Du kan också konfigurera en explicit lista över tillåtna certifikat med hjälp av AllowedCertificates. Om AllowedCertificates har konfigurerats och ett klientcertifikat inte matchar något av tumavtrycken i listan avvisas begäran. Om inga tillåtna certifikat anges godkänns alla certifikat som klarar minimiverifieringen.

Tillåtna certifikat

När du använder klientcertifikatautentisering kan du välja att konfigurera en explicit lista över tillåtna certifikat med .AllowedCertificates Varje tillåtet certifikat i Dashboard:Otlp:AllowedCertificates samlingen stöder följande egenskaper:

I följande exempel visas hur du konfigurerar tillåtna certifikat med hjälp av JSON konfiguration:

{
  "Dashboard": {
    "Otlp": {
      "AllowedCertificates": [
        {
          "Thumbprint": "HEX_SHA256_THUMBPRINT"
        }
      ]
    }
  }
}

Eller använda miljövariabler för konfiguration:

export Dashboard__Otlp__AllowedCertificates__0__Thumbprint="HEX_SHA256_THUMBPRINT"

OTLP CORS

Resursdelning mellan ursprung (CORS) kan konfigureras så att webbläsarappar kan skicka telemetri till instrumentpanelen.

Som standard är webbläsarappar begränsade från att göra API-anrop mellan domäner. Detta påverkar sändning av telemetri till instrumentpanelen eftersom instrumentpanelen och webbläsarappen alltid finns på olika domäner. Om du vill konfigurera CORS använder du avsnittet Dashboard:Otlp:Cors och anger de tillåtna ursprungen och rubrikerna:

{
  "Dashboard": {
    "Otlp": {
      "Cors": {
        "AllowedOrigins": "http://localhost:5000,https://localhost:5001"
      }
    }
  }
}

Överväg följande konfigurationsalternativ:

Resurser

Instrumentpanelen ansluter till en resurstjänst för att läsa in och visa resursinformation. Klienten är konfigurerad på instrumentpanelen för hur du ansluter till tjänsten.

Klientautentiseringen för resurstjänsten har konfigurerats med Dashboard:ResourceServiceClient:AuthMode. Klienten kan konfigureras för att stödja API-nyckel- eller klientcertifikatautentisering.

Telemetrigränser

Telemetri lagras i minnet. För att undvika överdriven minnesanvändning har instrumentpanelen gränser för antalet och storleken på lagrad telemetri. När gränsen för antal nås läggs ny telemetri till och den äldsta telemetrin tas bort. När en storleksgräns nås trunkeras data till gränsen.

Telemetrigränser har olika omfång beroende på telemetrityp:

• MaxLogCount och MaxTraceCount delas mellan resurser. Till exempel konfigurerar ett MaxLogCount värde på 5 000 instrumentpanelen att lagra upp till 5 000 totala loggposter för alla resurser.
• MaxMetricsCount är per resurs. Till exempel konfigurerar ett MaxMetricsCount-värde på 10 000 instrumentpanelen att lagra upp till 10 000 måttdatapunkter per resurs.

Annan

Nästa steg