Dela via

Fristående .NET.NET Aspire instrumentpanel

  • Artikel

Den .NET.NET Aspire instrumentpanelen ger ett bra användargränssnitt för att visa telemetri. Instrumentpanelen:

  • Levereras som en containeravbildning som kan användas med valfri OpenTelemetry aktiverad app.
  • Kan användas fristående utan rest för .NET Aspire.

En skärmbild av den .NET.NET Aspire instrumentpanelen som körs i fristående läge.

Starta instrumentpanelen

Instrumentpanelen startas med hjälp av kommandoraden Docker.

docker run --rm -it -d \
    -p 18888:18888 \
    -p 4317:18889 \
    --name aspire-dashboard \
    mcr.microsoft.com/dotnet/aspire-dashboard:9.0

Föregående Docker kommando:

  • Startar en container från mcr.microsoft.com/dotnet/aspire-dashboard:9.0 avbildningen.
  • Containern exponerar två portar:
    • Mappa instrumentpanelens OTLP-port 18889 till värdens port 4317. Port 4317 tar emot OpenTelemetry data från appar. Appar skickar data med OpenTelemetry Protocol (OTLP).
    • Mappa instrumentpanelens port 18888 till värdens port 18888. Port 18888 har instrumentpanelens användargränssnitt. Gå till http://localhost:18888 i webbläsaren för att visa instrumentpanelen.

Logga in på instrumentpanelen

Data som visas på instrumentpanelen kan vara känsliga. Som standard skyddas instrumentpanelen med autentisering som kräver en token för inloggning.

När instrumentpanelen körs från en fristående container skrivs inloggningstoken ut till containerloggarna. När du har kopierat den markerade token till inloggningssidan väljer du knappen Inloggning.

Skärmbild av containerloggarna för .NET.NET Aspire instrumentpanelen.

Dricks

För att undvika inloggningen kan du inaktivera autentiseringskravet genom att ange DOTNET_DASHBOARD_UNSECURED_ALLOW_ANONYMOUS miljövariabeln till true. Ytterligare konfiguration finns i Instrumentpanelskonfiguration.

Mer information om hur du loggar in på instrumentpanelen finns i Instrumentpanelsautentisering.

Utforska instrumentpanelen

Instrumentpanelen erbjuder ett användargränssnitt för att visa telemetri. Se dokumentationen för att utforska telemetrifunktionen:

Även om det inte finns någon begränsning för var instrumentpanelen körs, är instrumentpanelen utformad som ett utvecklingsverktyg och ett kortsiktigt diagnostikverktyg. Instrumentpanelen bevarar telemetri i minnet, vilket skapar vissa begränsningar:

  • Telemetri tas bort automatiskt om telemetrigränser överskrids.
  • Ingen telemetri sparas när instrumentpanelen startas om.

Instrumentpanelen har också funktioner för att visa .NET.NET Aspire resurser. Resursfunktionerna på instrumentpanelen inaktiveras när de körs i fristående läge. Om du vill aktivera resursgränssnittet lägga till konfiguration för en resurstjänst.

Skicka telemetri till instrumentpanelen

Appar skickar telemetri till instrumentpanelen med OpenTelemetry Protocol (OTLP). Instrumentpanelen måste exponera en port för att ta emot OpenTelemetry data och appar har konfigurerats för att skicka data till den adressen.

Ett Docker-kommando visades tidigare för att starta instrumentpanelen. Den konfigurerade containern för att ta emot OpenTelemetry data på port 4317. OTLP-slutpunktens fullständiga adress är http://localhost:4317.

Konfigurera OpenTelemetry SDK

Appar samlar in och skickar telemetri med hjälp av språkets OpenTelemetry SDK.

Viktiga OpenTelemetry SDK-alternativ att konfigurera:

  • OTLP-slutpunkt, som ska matcha instrumentpanelens konfiguration, till exempel http://localhost:4317.
  • OTLP-protokoll, där instrumentpanelen för närvarande endast stöder OTLP/gRPC-protokollet. Konfigurera program att använda protokollet grpc.

Så här konfigurerar du program:

  • Använd OpenTelemetry SDK-API:er i programmet, eller
  • Starta appen med kända miljövariabler:
    • OTEL_EXPORTER_OTLP_PROTOCOL med värdet grpc.
    • OTEL_EXPORTER_OTLP_ENDPOINT med värdet http://localhost:4317.

Prov

Ett exempel på hur du använder den fristående instrumentpanelen finns i exempelappen fristående .NET.NET Aspire instrumentpanel.

Nästa steg

Konfigurera .NET.NET Aspire-instrumentpanelen