Sql Command Monitor Dashboard

SqlCommandMonitorDashboard poskytuje UI vrstvu nad SqlCommandMonitor pro vizualizaci DbCommand událostí.

Pro správnou funkčnost je nutné mít v aplikaci zaregistrován SqlCommandMonitor, který tyto události zachytává.

Funkce

• Zobrazení SQL příkazů v reálném čase
• Barevné zvýraznění doby vykonání (Duration) podle konfigurovatelných prahových hodnot
• Zobrazení volající metody (Calling Method) a zdrojového souboru (Source File)
• Filtrování podle (Warnings / Critical)
• Filtrování dle vazby na Request ID
• Podpora reverzní proxy
• Volitelná autentizace pomocí BasicAuth

Instalace

dotnet add package SqlCommandMonitorDashboard

Registrace

builder.Services.AddSqlCommandMonitorDashboard(builder.Configuration);

Přidání middleware do pipeline

app.UseSqlCommandMonitorDashboard();

Konfigurace

Možnosti monitorování SQL příkazů lze nakonfigurovat pomocí SqlCommandMonitorDashboardOptions při registraci služby.

{
  "SqlCommandMonitorDashboardOptions": {
    "Enabled": true,
    "MapBlazorHub": true,
    "ProxyPrefix": "/myapp",
    "Path": "/sql-command-monitor",
    "CookieName": "sql_command_monitor",
    "BasicAuth": {
      "Username": "user",
      "Password": "password",
      "TokenSalt": "<generate-random-string>"
    },
    "DurationThresholds": {
      "WarningMs": 100,
      "CriticalMs": 500
    }
  }
}

• Enabled – zapnutí / vypnutí dashboardu
• MapBlazorHub – přepínač mapování Blazor Hubu (SignalR) pro WebApplication hosting model. Dashboard používá Blazor Server komponenty a vyžaduje SignalR endpoint.
• Path – cesta, na které bude dashboard dostupný
• ProxyPrefix – předpona pro správné fungování dashboardu za reverzní proxy (např. "/myapp/sql-command-monitor")
• CookieName – název cookie, která bude použita pro autentizaci přístupu k dashboardu
• BasicAuth – autentizační údaje pro základní HTTP autentizaci (aktivní pouze pokud jsou vyplněny všechny parametry)
  • Username – uživatelské jméno
  • Password – heslo
  • TokenSalt – sůl pro generování tokenů pro autentizaci (musí být náhodný řetězec s minimální délkou 16 znaků)
• DurationThresholds – nastavení prahových hodnot pro zobrazení varování a kritických příkazů na dashboardu (prahové hodnoty ovlivňují pouze vizuální zvýraznění na dashboardu, neovlivňují samotnou exekuci SQL příkazu)
  • WarningMs – prahová hodnota v milisekundách pro zobrazení varování
  • CriticalMs – prahová hodnota v milisekundách pro zobrazení kritického stavu

Pokud není konfigurace uvedena v appsettings.json, použijí se následující výchozí hodnoty:

• Enabled – true
• MapBlazorHub – false
• Path – "/sql-command-monitor"
• CookieName – "sql_command_monitor"
• WarningMs – 100
• CriticalMs – 500

Poznámka k MapBlazorHub

• Pro WebApplication je MapBlazorHub respektován:
  • true = mapuje se MapBlazorHub()
  • false = MapBlazorHub() se nemapuje (vhodné, pokud ho mapuje host aplikace jinak)
• Pro legacy pipeline přes IApplicationBuilder (UseRouting + UseEndpoints) se Blazor Hub mapuje vždy v rámci UseSqlCommandMonitorDashboard(), protože je pro dashboard nutný.

Bezpečnostní doporučení

• Dashboard by neměl být vystaven veřejně bez autentizace
• Doporučuje se omezit přístup pomocí BasicAuth
• Přístup bez autentizace povolit pouze ve vývojovém prostředí