Sql Command Monitor

SqlCommandMonitor je NuGet balíček pro snadné sledování a logování všech SQL příkazů (DbCommand) prováděných v aplikacích ASP.NET Core s Entity Framework Core.
Umožňuje zachytávat prováděné SQL příkazy, dobu jejich trvání, počet ovlivněných řádků a související informace o HTTP requestu a volající metodě.

Funkce

• Zachycení SQL příkazů pro všechny typy DbContext.
• Logování:
  • Časové razítko (Timestamp)
  • SQL příkaz (SqlCommand)
  • Počet ovlivněných řádků (AffectedRows)
  • Doba vykonání v ms (DurationMs)
  • Request ID (RequestId)
  • HTTP route (HttpRoute) - HTTP metoda + cesta
  • Volající metoda (CallingMethod)
  • Zdrojový soubor:řádek (SourceFileLine)
• Podpora více DbContextů současně.
• Middleware pro asociaci SQL příkazů s HTTP requesty.
• Endpoint pro získání statistik SQL příkazů (volitelná HTTP Basic autentizace).
• Jednoduchá registrace do DI kontejneru.

Instalace

dotnet add package SqlCommandMonitor

Registrace

builder.Services.AddSqlCommandMonitor(builder.Configuration);

Implementace

builder.Services.AddDbContext<AppDbContext>((sp, options) =>
{
    var interceptor = sp.GetRequiredService<DbCommandMonitorInterceptor>();

    options.UseSqlServer(builder.Configuration.GetConnectionString("default), opts =>
    {
        opts.MigrationsHistoryTable("MigrationHistory_App");
    });

    options.AddInterceptors(interceptor);
});

Přidání middleware a endpointu do pipeline

Middleware by měl být registrován po middlewarech, které mohou spouštět SQL příkazy (např. endpoint), aby bylo možné správně asociovat SQL příkazy s HTTP requestem:

app.UseSqlCommandMonitor();

Tento middleware automaticky přidá endpoint pro získání statistik SQL příkazů:

GET /sql-command-stats

• Endpoint vrací data ve formátu JSON.

• Podporuje volitelnou HTTP Basic autentizaci.

• Pokud je v konfiguraci nastavena sekce BasicAuth, endpoint je chráněn.

• Pokud BasicAuth není nastavena, endpoint je veřejně dostupný.

Příklad statistik SQL příkazů

[
  {
    "Timestamp": "2026-01-06T14:22:10.123Z",
    "RequestId": "26bf23be-105e-427a-a87a-66ac4c6cb24c",
    "HttpRoute": "GET /api/notes/{id}",
    "CallingMethod": "GetNoteById",
    "SourceFileLine": "NoteRepository.cs:45",
    "AffectedRows": null,
    "readRows": 1,
    "DurationMs": 12,
    "SqlCommand": "SELECT [n].[Id], [n].[Title], [n].[Content] FROM [Notes] AS [n] WHERE [n].[Id] = @__id_0"
  },
  {
    "Timestamp": "2026-01-06T14:22:18.456Z",
    "RequestId": "ea6f450c-20d5-474c-9690-cc6f91547e87",
    "HttpRoute": "PUT /api/notes/{id}",
    "CallingMethod": "UpdateNote",
    "SourceFileLine": "NoteRepository.cs:78",
    "AffectedRows": 1,
    "readRows": null,
    "DurationMs": 8,
    "SqlCommand": "UPDATE [Notes] SET [Title] = @p0, [Content] = @p1 WHERE [Id] = @p2"
  }
]

Konfigurace

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

{
  "SqlCommandMonitorOptions": {
    "Enabled": true,
    "MaxBufferSize": 1000,
    "MinimumLogLevel": "Warning",
    "WarningThresholdMs": 50,
    "BasicAuth": {
      "Username": "user",
      "Password": "password"
    }
  }
}

• Enabled – zapnutí / vypnutí monitorování
• MaxBufferSize – maximální počet uložených záznamů
• MinimumLogLevel – minimální úroveň logování
• WarningThresholdMs – prahová hodnota v milisekundách pro logování SQL příkazů jako Warning (příkazy s kratší dobou trvání jsou logovány jako Information)
• BasicAuth – volitelná sekce pro ochranu endpointu přihlašovacími údaji

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

• Enabled – true
• MaxBufferSize – 1000
• MinimumLogLevel – Information
• WarningThresholdMs – 50
• BasicAuth – null (ochrana endpointů je vypnuta)

Tok zpracování SQL příkazů

DbCommandMonitorInterceptor
        │
        ▼
     MonitorData
        │
        ├──► MonitorDataBuffer.Add(...)  (vždy → nejstarší záznamy jsou zahazovány dle MaxBufferSize)
        │                                
        │
        └──► MonitorDataLogger.Log(...)  (filtrováno → MinimumLogLevel, WarningThresholdMs)
                                          
                                          

• Každý zachycený SQL příkaz je vždy přidán do bufferu.

• Při překročení MaxBufferSize jsou automaticky odstraněny nejstarší záznamy.

• Filtrace se aplikuje výhradně na logování.