Grafana und WebDataStudio¶

Zwei Entwicklungswerkzeuge laufen im Aspire-AppHost neben der App, in einer neuen App sind beide eingeschaltet:

Grafana mit Prometheus, Loki, Tempo und einem OpenTelemetry-Collector: Metriken, Logs und Traces jedes Dienstes, die App-Datenbank und fertige Dashboards.
WebDataStudio: die App-Datenbank im Browser, mit Tabellen, SQL, Diagrammen und Exporten.

Beide melden sich mit dem Administrator der App an (dieselbe E-Mail und dasselbe Passwort wie in der App, siehe LOGIN.md) und, wenn Keycloak aktiv ist, zusätzlich über den Keycloak-Knopf. Sie kommen aus den Paketen Nextended.Aspire.Hosting.Grafana und Nextended.Aspire.Hosting.WebDataStudio, die Coworkee.Aspire mitbringt.

Grafana-Übersichtsdashboard

Was Sie bekommen¶

Ressource	Aufgabe
`grafana`	Grafana mit den Datenquellen Prometheus, Loki, Tempo und App database und den Dashboards in einem Ordner mit dem Namen der App
`prometheus`	Metriken der Dienste, vom Collector geschickt (7 Tage)
`loki`	Logs der Dienste
`tempo`	Traces der Dienste, mit Verweisen auf ihre Logs
`otel-collector`	nimmt OTLP der Dienste an und gibt es an die drei weiter
`postgres-exporter`	Metriken des Postgres-Servers (nur mit Postgres)
`webdatastudio`	WebDataStudio mit der Verbindung `MYAPP` zur App-Datenbank

Die Dienste senden weiter an das Aspire-Dashboard; die generierten Service-Defaults schicken dieselben Metriken, Logs und Traces zusätzlich an den Collector (Einstellung GRAFANA_OTLP_ENDPOINT, die der AppHost setzt). Außerdem erfassen sie die Meter von Entity Framework Core und Npgsql.

Dashboards¶

Dashboard	Inhalt
Overview	Anfragen pro Sekunde, Server- und Client-Fehler, p95-Latenz, laufende Anfragen, Echtzeitverbindungen (SignalR); Verkehr, Statuscodes und Latenz je Dienst; meistgenutzte und langsamste Endpunkte; ausgehende Aufrufe; Log-Volumen, langsamste Traces, Warnungen und Fehler
.NET runtime	CPU, Working Set, GC-Heap, Allokationsrate, GC-Pausen und -Sammlungen, Threadpool, Lock-Konflikte, Ausnahmen nach Typ, JIT
Database access	Abfragen, SaveChanges und aktive Kontexte von Entity Framework Core, Cache kompilierter Abfragen, Konkurrenz- und Wiederholungsfehler; Befehlsdauer, Verbindungspool, langsamste Datenbank-Spans
PostgreSQL server	Verbindungen, Größe, Cache-Trefferquote, Deadlocks, Transaktionen und Zeilen je Datenbank (nur Postgres)
App data	Benutzer, aktive Benutzer, Anmeldungen heute und in dieser Woche, Mandanten, Rollen, Anmeldungen und neue Benutzer im Zeitverlauf, letzte Anmeldungen, Benutzer je Rolle, offene und fehlschlagende Outbox-Nachrichten, Ereignisse durch die Outbox, Hintergrundjobs nach Status, offene und fehlgeschlagene Jobs (Postgres und SQL Server)
Logs and traces	alle Logs mit Filtern für Dienst, Level und Text, Log-Volumen je Dienst, Traces mit Fehlern, langsamste Traces

Jedes Dashboard filtert nach Dienst und verweist auf die anderen. Sie werden bei jedem Start bereitgestellt: Speichern Sie eine Kopie (Save as), wenn Sie eine eigene Fassung behalten wollen.

Dashboard App data

Dashboard .NET runtime

Dashboard Database access

Dashboard Logs and traces

Dashboard PostgreSQL server

WebDataStudio mit der App-Datenbank

Anmeldung¶

	Lokale Anmeldung	Keycloak
Grafana	E-Mail und Passwort des Administrators, als Grafana-Server-Admin	Sign in with Keycloak: die Realm-Rolle `Administrator` (oder die E-Mail des Administrators) wird Grafana-Server-Admin, alle anderen Viewer
WebDataStudio	E-Mail und Passwort des Administrators, als Studio-Admin	Keycloak: die Realm-Rolle `Administrator` (oder die E-Mail des Administrators) wird Studio-Admin, alle anderen Viewer

Der generierte AppHost nimmt den Administrator aus src/MyApp.Migrations/DemoUsers.cs, der Datei, die auch der Seed und der Keycloak-Realm lesen:

var administrator = DemoUsers.All.First(u => u.IsAdmin);
options.Administrator = new(administrator.Email, administrator.Password);

Ohne options.Administrator bekommen beide Werkzeuge den Benutzer admin mit einem generierten Passwort: dem Parameter myapp-admin-password im Aspire-Dashboard.

Mit Keycloak legt der AppHost die Clients myapp-grafana und myapp-webdatastudio mit ihren Weiterleitungsadressen im Realm der App an und gibt den Realm-Benutzern ihre Realm-Rollen (KeycloakUser.Roles; der generierte AppHost ergänzt Administrator für Benutzer mit IsAdmin). Jeder Client des Realms bekommt die Rollen im Claim roles. Die Container erreichen Keycloak über das Container-Netz, der Browser über seine eigene Adresse: Keycloak nennt sich dann mit der Adresse des Browsers (KC_HOSTNAME), sodass alle Tokens denselben Aussteller tragen.

Ein- und ausschalten¶

CLI¶

Beide Optionen sind eingeschaltet, solange sie nicht abgeschaltet werden:

coworkee new Shop --grafana false --web-data-studio false

coworkee options beschreibt sie mit Vor- und Nachteilen.

Studio¶

Architektur hat unter Infrastruktur je eine Karte; die Vorlagen Business app, Collaboration, SaaS platform und Everything schalten beide ein, Local demo nur WebDataStudio, Minimal keines. Die Container erscheinen in der Zusammenfassung rechts und auf der Prüfseite.

Spec¶

{
  "name": "Shop",
  "options": {
    "grafana": true,
    "webDataStudio": false
  }
}

AppHost¶

In einer bestehenden App schalten die Zeilen in src/MyApp.AppHost/AppHost.cs die Werkzeuge; löschen Sie eine Zeile (oder rufen Sie WithoutGrafana() / WithoutWebDataStudio() auf), um das Werkzeug abzuschalten, und fügen Sie sie hinzu, um es einzuschalten:

var app = builder.AddCoworkeeApp("myapp", options =>
{
    var administrator = DemoUsers.All.First(u => u.IsAdmin);
    options.Administrator = new(administrator.Email, administrator.Password);
    options.UseGrafana();
    options.UseWebDataStudio();
});

DemoUsers braucht using MyApp.Migrations;. Beide Aufrufe nehmen einen Callback für die Ressource, z. B. options.UseGrafana(grafana => grafana.WithDataVolume()) oder options.UseWebDataStudio(studio => studio.WithReadOnly()); danach sind app.Grafana und app.WebDataStudio die Resource-Builder.

Eine App, die vor diesen Optionen erzeugt wurde, braucht außerdem den zweiten Exporter in MyApp.ServiceDefaults/Extensions.cs, damit Grafana ihre Telemetrie bekommt:

if (builder.Configuration["GRAFANA_OTLP_ENDPOINT"] is { Length: > 0 } grafana)
{
    void Grafana(OtlpExporterOptions o) => (o.Endpoint, o.Protocol, o.Headers) = (new Uri(grafana), OtlpExportProtocol.Grpc, string.Empty);
    telemetry.WithLogging(l => l.AddOtlpExporter("grafana", Grafana)).WithMetrics(m => m.AddOtlpExporter("grafana", Grafana)).WithTracing(t => t.AddOtlpExporter("grafana", Grafana));
}

telemetry ist dabei der Builder von builder.Services.AddOpenTelemetry(), und der Exporter für das Aspire-Dashboard wird je Signal angehängt (AddOtlpExporter()) statt mit UseOtlpExporter(), das sich nicht mit einem zweiten Exporter verträgt.

Datenbanken¶

Datenbank	Grafana	WebDataStudio
Postgres	Datenquelle App database, postgres_exporter, alle Dashboards	Verbindung zur Datenbank
SQL Server	Datenquelle App database (Benutzer `sa`), alle Dashboards außer PostgreSQL server	Verbindung zur Datenbank
SQLite	keine Datenbank-Datenquelle und kein Dashboard App data	die Datenbankdatei, aus `.data` eingebunden
`UseDatabase(...)`	keine Datenbank-Datenquelle	Verbindung mit dem übergebenen Connection-String

Nur für die Entwicklung

Beide Werkzeuge kommen nur im Run-Modus dazu: aspire publish und azd up lassen sie weg, weil ein Deployment sein eigenes Monitoring mitbringt und kein Datenbank-Studio mit dem Passwort des Administrators öffnen sollte. Generierte Konfigurationen landen in src/MyApp.AppHost/observability/.generated (von git ignoriert).