Utforska instrumentpanelen för .NET.NET Aspire
I de kommande avsnitten upptäcker du hur du skapar ett .NET.NET Aspire projekt och påbörjar följande uppgifter:
Undersök instrumentpanelens funktioner med hjälp av appen som genereras från projektmallen enligt beskrivningen i Snabbstart: Skapa ditt första .NET.NET Aspire projekt.
Gå in i funktionerna i .NET.NET Aspire-instrumentpanelsappen.
Skärmbilderna som visas i den här artikeln visar det mörka temat. Mer information om temaval finns i Temaval.
Instrumentpanelsautentisering
När du kör en .NET.NET Aspire appvärd startar orkestreraren alla appens beroende resurser och öppnar sedan ett webbläsarfönster på instrumentpanelen. Instrumentpanelen .NET.NET Aspire kräver tokenbaserad autentisering för användarna eftersom den visar miljövariabler och annan känslig information.
När instrumentpanelen startas från Visual Studio eller Visual Studio Code (med C# Dev Kit-tillägget) loggas webbläsaren automatiskt in och instrumentpanelen öppnas direkt. Det här är den typiska F5- och inloggningsflödet för autentisering automatiseras av .NET.NET Aspire verktyg.
Men om du startar appvärden från kommandoraden visas inloggningssidan. Konsolfönstret visar en URL som du kan välja på för att öppna instrumentpanelen i webbläsaren.
URL:en innehåller en tokenfrågesträng (med tokenvärdet mappat till den t
namndelen) som används för att logga in till instrumentpanelen. Om konsolen stöder det kan du hålla Ctrl- och sedan välja länken för att öppna instrumentpanelen i webbläsaren. Den här metoden är enklare än att kopiera token från konsolen och klistra in den på inloggningssidan. Om du hamnar på instrumentpanelens inloggningssida utan någon av de tidigare beskrivna metoderna kan du alltid gå tillbaka till konsolen för att kopiera token.
Inloggningssidan accepterar en token och innehåller användbara instruktioner för hur du hämtar token, enligt följande skärmbild:
När du har kopierat token från konsolen och klistrat in den på inloggningssidan väljer du knappen Logga in.
Instrumentpanelen bevarar token som en webbläsarbeständig cookie, som förblir giltig i tre dagar. Beständiga cookies har ett förfallodatum och är giltiga även efter att webbläsaren har stängts. Det innebär att användarna inte behöver logga in igen om de stänger och öppnar webbläsaren igen. Mer information finns i Säkerhetsöverväganden för att köra .NET.NET Aspire-instrumentpanelen dokumentation.
Sidan Resurser
Sidan Resurser är standardstartsidan för .NET.NET Aspire instrumentpanelen. På den här sidan visas alla .NET projekt, containrar och körbara filer som ingår i din .NET Aspire lösning. Startprogrammet innehåller till exempel två projekt:
- apiservice: Ett api-projekt för serverdelen som skapats med minimala API:er.
- webfrontend: Klientdelsgränssnittsprojektet som skapats med Blazor.
Instrumentpanelen innehåller också viktig information om varje resurs:
- Typ: Visar om resursen är ett projekt, en container eller en körbar fil.
- Namn: Namnet på resursen.
-
State: Visar om resursen körs eller inte.
- Fel: I kolumnen State visas fel som ett märke med antalet fel. Det är användbart att snabbt förstå vilka resurser som rapporterar fel. Om du väljer märket går du till semantiska loggar för resursen med filtret på felnivå.
- Starttid: När resursen började köras.
- Källa: Platsen för resursen på enheten.
- slutpunkter: En eller flera URL:er för att nå den resurs som körs direkt.
- Loggar: En länk till resursloggsidan.
-
Actions: En uppsättning åtgärder som kan utföras på resursen:
- Stoppa/Starta: Stoppa (eller Starta) resursen beroende på aktuell tillstånd.
- Konsolloggar: Navigera till resursens konsolloggar.
-
Ellips: En undermeny med extra resursspecifika åtgärder:
- Visa information: Visa resursinformationen.
- Konsollogg: Navigera till resursens konsolloggar.
- Strukturerade loggar: Navigera till resursens strukturerade loggar.
- Traces: Navigera till resursens spårningar.
- Mått: Navigera till resursens mått.
- Starta om: Stoppa och starta sedan resursen.
Överväg följande skärmbild av resurssidan:
Resursåtgärder
Varje resurs har en uppsättning tillgängliga åtgärder som är villkorligt aktiverade baserat på resursens aktuella tillstånd. Om en resurs till exempel körs aktiveras åtgärden Stoppa. Om resursen stoppas aktiveras åtgärden Starta. På samma sätt inaktiveras vissa åtgärder när de inte är tillgängliga, till exempel att vissa resurser inte har strukturerade loggar. I dessa situationer är åtgärden Strukturerade loggar inaktiverad.
Stoppa eller starta en resurs
Med instrumentpanelen .NET.NET Aspire kan du stoppa eller starta en resurs genom att välja knappen Stoppa eller knappen Starta i kolumnen Åtgärder. Överväg följande skärmbild av resurssidan med knappen Stoppa markerad:
När du väljer Stoppaslutar resursen att köras och kolumnen State uppdateras för att återspegla ändringen.
Not
När felsökaren är ansluten för projektresurser kopplas den på nytt vid omstart.
Knappen Starta aktiveras, så att du kan starta resursen igen. Dessutom visar instrumentpanelen ett popup-meddelande om resultatet av åtgärden:
När en resurs är i ett tillstånd som inte körs aktiveras knappen Starta. Om du väljer Starta startas resursen och kolumnen State uppdateras för att återspegla ändringen. Knappen Stoppa aktiveras, så att du kan stoppa resursen igen. Instrumentpanelen visar ett popup-meddelande om resultatet av åtgärden:
Dricks
Resurser som är beroende av andra resurser som stoppas eller startas om kan uppleva tillfälliga fel. Detta är ett förväntat beteende och löses vanligtvis när de beroende resurserna är i ett Kör tillstånd igen.
Resursundermenyåtgärder
Om du väljer den vågräta ellipsikonen i kolumnen Åtgärder öppnas en undermeny med ytterligare resursspecifika åtgärder. Förutom de inbyggda resursundermenyåtgärderna kan du också definiera anpassade resursåtgärder genom att definiera anpassade kommandon. Mer information finns i Anpassade resurskommandon i .NET.NET Aspire. Tänk på följande skärmbild för de inbyggda resursundermenyåtgärderna:
Följande undermenyåtgärder är tillgängliga:
- Visa information: Visa resursinformationen.
- Konsollogg: Navigera till resursens konsolloggar.
- Strukturerade loggar: Navigera till resursens strukturerade loggar.
- Traces: Navigera till resursens spårningar.
- Mått: Navigera till resursens mått.
- Starta om: Stoppa och starta sedan resursen.
Viktig
Det kan finnas resurser med inaktiverade undermenyåtgärder. De är nedtonade när de är inaktiverade. Följande skärmbild visar till exempel inaktiverade undermenyåtgärder:
Kopiera eller öppna i textvisualiserare
Om du vill visa en textvisualiserare av vissa kolumner visas en lodrät ellipsikon vid hovring. Välj ikonen för att visa tillgängliga alternativ:
- Kopiera till Urklipp
- Öppna i
Överväg följande skärmbild av alternativen på ellipsmenyn:
När du väljer alternativet Öppna i textvisualiserare öppnas en modal dialogruta med texten som visas i ett större format. Överväg följande skärmbild av dialogrutan för ändring av textvisualiseraren:
Vissa värden formateras som JSON eller XML. I dessa fall aktiverar textvisualiseraren Välj format listrutan för att växla mellan de olika formaten.
Resursinformation
Du kan få fullständig information om varje resurs genom att välja ellipsknappen i kolumnen Actions och sedan välja Visa information. Sidan Information innehåller en omfattande vy över resursen:
Sökfältet längst upp till höger på instrumentpanelen ger också möjlighet att filtrera listan, vilket är användbart för .NET.NET Aspire projekt med många resurser. Om du vill välja vilka typer av resurser som visas kan du släppa pilen till vänster om textrutan filter:
I det här exemplet visas endast containrar i listan. Om du till exempel aktiverar Använd Redis för cachelagring när du skapar ett .NET Aspire projekt bör du se en Redis container i listan:
Körbara filer är fristående processer. Du kan konfigurera ett .NET.NET Aspire projekt för att köra en fristående körbar fil under start, men standardmallarna för start innehåller inga körbara filer som standard.
Följande skärmbild visar ett exempel på ett projekt som har fel:
Om du väljer märket för antal fel navigerar du till sidan Strukturerade loggar med ett filter som tillämpas för att endast visa loggarna som är relevanta för resursen:
Om du vill se loggposten i detalj för felet väljer du knappen Visa för att öppna ett fönster under listan med information om strukturerad loggpost:
Mer information och exempel på strukturerade loggar finns på sidan Strukturerade loggar avsnittet.
Not
Resurssidan är inte tillgänglig om instrumentpanelen startas utan en konfigurerad resurstjänst. Instrumentpanelen startar på sidan Strukturerade loggar i stället. Detta är standardupplevelsen när instrumentpanelen körs i fristående läge utan ytterligare konfiguration.
Mer information om hur du konfigurerar en resurstjänst finns i Instrumentpanelskonfiguration.
Övervakningssidor
Instrumentpanelen .NET.NET Aspire innehåller olika sätt att visa loggar, spårningar och mått för din app. Med den här informationen kan du spåra appens beteende och prestanda och diagnostisera eventuella problem som uppstår.
Sidan Konsolloggar
Sidan Konsolloggar visar text som varje resurs i din app har skickat till standardutdata. Loggar är ett användbart sätt att övervaka hälsotillståndet för din app och diagnostisera problem. Loggar visas på olika sätt beroende på källan, till exempel projekt, container eller körbar fil.
När du öppnar sidan Konsolloggar måste du välja en källa i listrutan Välj en resurs.
Om du väljer ett projekt återges liveloggarna med en stiliserad uppsättning färger som motsvarar loggens allvarlighetsgrad. grön för information som exempel. Överväg följande exempel på skärmbild av projektloggar med det apiservice
projektet valt:
När fel inträffar är de formaterade i loggarna så att de är lätta att identifiera. Överväg följande exempel på skärmbild av projektloggar med fel:
Om du väljer en container eller körbar fil skiljer sig formateringen från ett projekt, men utförlig beteendeinformation är fortfarande tillgänglig. Tänk dig följande exempel på en skärmbild av en containerlogg med den cache
containern vald:
Resursrepliker
När projektresurser replikeras med hjälp av WithReplicas-API:et representeras de i resursväljaren under en resurspost på den översta nivån med en ikon som indikator. Varje replikerad resurs visas under resursposten på den översta nivån med motsvarande unika namn. Tänk dig följande exempel på en skärmbild av en replikerad projektresurs:
Föregående skärmbild visar projektet catalogservice (application)
med två repliker, catalogservice-2bpj2qdq6k
och catalogservice-6ljdin0hc0
. Varje replik har en egen uppsättning loggar som kan visas genom att välja repliknamnet.
Sidan Strukturerade loggar
.NET Aspire konfigurerar automatiskt dina projekt med loggning med hjälp av OpenTelemetry. Gå till sidan Strukturerade loggar för att visa semantiska loggar för ditt .NET.NET Aspire projekt. semantisk eller strukturerad loggning gör det enklare att lagra och köra frågor mot logghändelser, eftersom log-event-meddelandemallen och meddelandeparametrarna bevaras, i stället för att bara omvandla dem till ett formaterat meddelande. Du ser en ren struktur för de olika loggar som visas på sidan med hjälp av kolumner:
- Resurs: Resursen som loggen kommer från.
- nivå: Loggnivån för posten, till exempel information, varning eller fel.
- Tidsstämpel: Tidpunkten då loggen inträffade.
- Meddelande: Information om loggen.
- Trace: En länk till relevant spårning för loggen, om tillämpligt.
- Information: Ytterligare information eller metadata om loggposten.
Överväg följande exempel på skärmbild av semantiska loggar:
Filtrera strukturerade loggar
Sidan strukturerade loggar innehåller också ett sökfält för att filtrera loggarna efter tjänst, nivå eller meddelande. Du använder listrutan nivå för att filtrera efter loggnivå. Du kan också filtrera efter vilken loggegenskap som helst genom att välja knappen filterikon, vilket öppnar dialogrutan avancerat filter.
Överväg följande skärmbilder som visar de strukturerade loggarna, filtrerade för att visa objekt med "Hosting" i meddelandetexten:
Sidan Spårningar
Gå till sidan Traces för att visa alla spårningar för din app. .NET .NET Aspire konfigurerar automatiskt spårning för de olika projekten i din app. Distribuerad spårning är en diagnostikteknik som hjälper tekniker att lokalisera fel och prestandaproblem i program, särskilt sådana som kan distribueras över flera datorer eller processer. Mer information finns i .NET distribuerad spårning. Den här tekniken spårar begäranden via ett program och korrelerar arbete som utförs av olika programintegreringar. Spårningar hjälper också till att identifiera hur lång tid det tog för olika steg i begäran att slutföras. Spårningssidan visar följande information:
- Tidsstämpel: När spårningen har slutförts.
- Namn: Namnet på spårningen, prefixet med projektnamnet.
- Sträcker sig över: De resurser som ingår i begäran.
- Varaktighet: Den tid det tog att slutföra begäran. Den här kolumnen innehåller en radiell ikon som illustrerar varaktigheten för begäran i jämförelse med de andra i listan.
Filtrera spårningar
Spårningssidan innehåller också ett sökfält för att filtrera spårningarna efter namn eller intervall. Använd ett filter och observera att spårningsresultaten uppdateras omedelbart. Överväg följande skärmbild av spårningar med ett filter som tillämpas på weather
och lägg märke till hur sökordet är markerat i resultaten:
När du filtrerar spårningar i dialogrutan Lägg till filter fylls markeringen Värde i förväg med tillgängliga värden för den valda parametern när du har valt en Parameter och motsvarande Villkor. Överväg följande skärmbild av dialogrutan Lägg till filter med parametern http.route
vald:
Kombinera telemetri från flera resurser
När en resurs har flera repliker kan du filtrera telemetri för att visa data från alla instanser samtidigt. Välj den överordnade resursen, märkt (application)
, enligt följande skärmbild:
När du har valt den överordnade resursen visar spårningssidan telemetri från alla instanser av resursen.
Spårningsinformation
Sidan med spårningsinformation innehåller olika detaljer som är relevanta för begäran, inklusive:
- Spårningsinformation: När spårningen startade.
- Varaktighet: Den tid det tog att slutföra begäran.
- Resurser: Antalet resurser som ingår i begäran.
- Djup: Antalet lager som ingår i begäran.
- Total Spans: Det totala antalet intervall som ingår i begäran.
Varje intervall representeras som en rad i tabellen och innehåller ett Namn. Intervall visar även felikonen om ett fel uppstod inom det specifika intervallet för spårningen. Intervall som har en typ av klient/konsument, men som inte har något intervall på servern, visar en pilikon och sedan måladressen. Detta representerar ett klientanrop till ett system utanför .NET.NET Aspire projektet. Till exempel en HTTP-begäran om ett externt webb-API eller ett databasanrop.
På sidan spårningsinformation finns det en knappen Visa loggar som tar dig till sidan med strukturerade loggar med ett filter som används för att endast visa loggarna som är relevanta för begäran. Överväg ett exempel på en skärmbild som visar sidan med strukturerade loggar med ett filter som tillämpas för att endast visa loggarna som är relevanta för spårningen:
Sidan strukturerade loggar beskrivs mer detaljerat på sidan Strukturerade loggar avsnittet.
Spårningsexempel
Varje spårning har en färg som genereras för att skilja mellan intervall – en färg för varje resurs. Färgerna återspeglas både på sidan spårningar och spårningsinformationssidan. När spårningar visar en pilikon färgas även dessa ikoner för att matcha målspårningens intervall. Tänk dig följande exempel på en skärmbild av spårningar:
Du kan också välja knappen Visa för att navigera till en detaljerad vy över begäran och hur lång tid den har ägnat åt att resa genom varje programlager. Överväg ett exempel på ett val av en spårning för att visa dess information:
För varje spann i spårningen väljer du Visa för att se mer information:
Rulla nedåt i spann information smärta för att se fullständig information. Längst ned i fönstret spaninformation visar vissa intervalltyper, till exempel det här anropet till en cache, tidsintervall för händelser:
När det finns fel återger sidan en felikon bredvid spårningsnamnet. Överväg ett exempel på en skärmbild av spårningar med fel:
Och motsvarande detaljerade vy över spårningen med fel:
Sidan Mått
Gå till sidan Mått för att visa måtten för din app. .NET .NET Aspire konfigurerar automatiskt mått för de olika projekten i din app. Mått är ett sätt att mäta hälsotillståndet för ditt program och kan användas för att övervaka appens prestanda över tid.
Varje måttpubliceringsprojekt i din app har egna mått. Sidan mått visar ett urvalsfönster för varje mätare på den översta nivån och motsvarande instrument som du kan välja för att visa måttet.
Tänk på följande exempel på skärmbilden av måttsidan, där webfrontend
projektet är valt och System.Net.Http
mätarens http.client.request.duration
mått valt:
Förutom måttdiagrammet innehåller måttsidan ett alternativ för att visa data som en tabell i stället. Överväg följande skärmbild av måttsidan med tabellvyn vald:
Under diagrammet finns en lista med filter som du kan använda för att fokusera på de data som intresserar dig. I följande skärmbild filtreras till exempel fältet http.request.method för att endast visa GET-begäranden:
Du kan också välja att välja antalet mått som visas för den lodräta åtkomsten i stället för dess värden:
Mer information om mått finns i inbyggda mått i .NET.
Exempel
Instrumentpanelen .NET Aspire stöder och visar OpenTelemetryExemplar. Ett exempel länkar en måttdatapunkt till den åtgärd som registrerade den, som fungerar som en brygga mellan mått och spårningar.
Exempel är användbara eftersom de ger ytterligare kontext om varför ett specifikt måttvärde registrerades. Om du till exempel ser en ökning av svarstiden i måttet http.client.request.duration
kan ett exempel peka på en specifik spårning eller ett visst spann som orsakade toppen, vilket hjälper dig att förstå rotorsaken.
Exempel visas i måttdiagrammet som en liten rund punkt bredvid datapunkten. När du hovra över indikatorn visar en knappbeskrivning exempelinformationen enligt följande skärmbild:
Föregående skärmbild visar exempelinformationen för måttet http.client.request.duration
. Exempelinformationen omfattar:
- Resursnamn.
- Åtgärden utfördes, i det här fallet en HTTP GET till
/catalog/images/{id}
. - Motsvarande värde och tidsstämpel.
Om du väljer exempelindikatorn öppnas sidan med spårningsinformation, där du kan visa spårningen som är associerad, till exempel tänk på följande skärmbild:
Mer information finns i OpenTelemetry Docs: Exemplars.
Temaval
Som standard är temat inställt på att följa systemtemat, vilket innebär att instrumentpanelen använder samma tema som operativsystemet. Du kan också välja temat Light eller Dark för att åsidosätta systemtemat. Temaval sparas.
Följande skärmbild visar dialogrutan för temaval med standardtemat System valt:
Om du föredrar temat Ljus kan du välja det i dialogrutan för temaval:
Genvägar till instrumentpanelen
Instrumentpanelen .NET.NET Aspire innehåller olika genvägar för att hjälpa du navigerar och styr olika delar av instrumentpanelen. Om du vill visa kortkommandon trycker du på Skift + ?eller välj frågemarkeringsikonen i det övre högra hörnet på instrumentpanelen:
Följande genvägar är tillgängliga:
paneler:
- +: Öka panelens storlek.
- -: Minska panelens storlek.
- Skift + r: Reset panelstorlek.
- Skift + t: Tväxlingspanelens orientering.
- Skift + x: Stäng panelen.
Sidnavigering:
- r: Gå till Resources.
- c: Gå till Console Logs.
- s: Gå till Strunkerade loggar.
- t: Gå till Ttävlingar.
- m: Gå till Metrics.
webbplatsomfattande navigering:
- ?: Måste hjälp.
- Shift + s: Gå till Settings.
Nästa steg
.NET Aspire