Pr.BuildingBlocks.Cms.Logging 1.0.0

Pr.BuildingBlocks.Cms.Logging

Współdzielona konfiguracja obserwowalności dla mikroserwisów CMS: Sentry + structured console logging, z bezpiecznymi domyślnymi wartościami nadpisywalnymi przez appsettings.json lub kod.

Co dostarcza

• Sentry (Sentry.AspNetCore) — aktywowane wyłącznie gdy ustawiony jest DSN.
  • Środowisko wyprowadzane z ASPNETCORE_ENVIRONMENT (poprawne tagowanie per klaster).
  • Filtr odrzucający spodziewane wyjątki biznesowe (BaseException i pochodne z Pr.BuildingBlocks.Cms.Core) — nie zalewają Sentry błędami 4xx.
  • Bezpieczne domyślne: SendDefaultPii=false, MaxRequestBodySize=None, TracesSampleRate=0.05, MinimumEventLevel=Error.
  • Opcjonalny profiling (Sentry.Profiling) sterowany flagą EnableProfiling (+ ProfilesSampleRate > 0).
• Structured console logging — JSON na produkcji (parsowalne w log aggregation), czytelny simple w Development, ze scope'ami i znacznikiem UTC. Ustawiane jako nadpisywalny default.

Użycie

using Pr.BuildingBlocks.Cms.Logging;

var builder = WebApplication.CreateBuilder(args);

// Domyślna konfiguracja; DSN brany z Sentry:Dsn / Sentry__Dsn.
builder.AddObservability();

var app = builder.Build();

// Middleware tracingu Sentry (no-op gdy Sentry nieaktywne).
app.UseObservability();

Nadpisywanie domyślnych

Precedencja (od najniższej): domyślne z kodu → sekcja Sentry w appsettings.json → callback.

1. Przez appsettings.json (sekcja Sentry; structured console przez Logging:Console):

{
  "Sentry": {
    "Dsn": "https://...@sentry.io/...",
    "TracesSampleRate": 0.2
  },
  "Logging": {
    "Console": { "FormatterName": "simple" }
  }
}

W prod DSN zwykle podajesz przez Sentry__Dsn.

2. Przez kod (najwyższy priorytet):

builder.AddObservability(options =>
{
    options.TracesSampleRate = 0.2;
    options.EnableProfiling = true;
    options.ProfilesSampleRate = 0.1;
});

Walidacja (TracesSampleRate/ProfilesSampleRate w [0,1], MaxBreadcrumbs >= 0, profiling wymaga dodatniego sample rate) rzuca ArgumentException z jasnym komunikatem na etapie rejestracji.

API

// Konfiguracja (Program.cs, przed Build()).
public static WebApplicationBuilder AddObservability(
    this WebApplicationBuilder builder,
    Action<LoggingOptions>? configure = null);

// Pipeline (po Build()).
public static WebApplication UseObservability(this WebApplication app);

Pełna lista ustawień (nazwy property = klucze sekcji Sentry): zob. LoggingOptions.

Zależności

• Sentry.AspNetCore, Sentry.Profiling
• Pr.BuildingBlocks.Cms.Core (kontrakt BaseException)
• Microsoft.AspNetCore.App (shared framework)