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ů v JSON formátu.
• Jednoduchá registrace do DI kontejneru.

Instalace

dotnet add package SqlCommandMonitor

Registrace

Pro jeden DbContext:

builder.Services.AddSqlCommandMonitor<AppDbContext>(
    options =>
    {
        options.UseSqlServer(builder.Configuration.GetConnectionString("Default"), opts =>
        {
            opts.MigrationsHistoryTable("MigrationHistory_App");
        });
    },
    builder.Configuration
);

Pro jeden DbContext s přístupem k IServiceProvider:

builder.Services.AddSqlCommandMonitor<AppDbContext>(
    (sp, options) =>
    {
        options.UseSqlServer(builder.Configuration.GetConnectionString("Default"), opts =>
        {
            opts.MigrationsHistoryTable("MigrationHistory_App");
        });
    },
    builder.Configuration
);

Pro více DbContextů současně:

builder.Services.AddSqlCommandMonitor(
    (sp, options) =>
    {
        options.UseSqlServer(builder.Configuration.GetConnectionString("Default"), opts =>
        {
            opts.MigrationsHistoryTable("MigrationHistory_App");
        });
    },
    builder.Configuration,
    UseDbContext<AppDbContext>(),
    UseDbContext<AuditDbContext>(),
    UseDbContext<LogDbContext>()
);

Přidání middleware do pipeline

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

app.UseSqlCommandMonitor();

Konfigurace

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

{
  "SqlCommandMonitorOptions": {
    "Enabled": true,
    "MaxBufferSize": 1_000,
    "MinimumLogLevel": "Information"
  }
}

Endpoint pro získání statistik SQL příkazů

Pro získání statistik SQL příkazů je k dispozici endpoint /sql-command-stats, který vrací data ve formátu JSON.

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": 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,
    "DurationMs": 8,
    "SqlCommand": "UPDATE [Notes] SET [Title] = @p0, [Content] = @p1 WHERE [Id] = @p2"
  }
]