TaskHub.Shared

Logging

Logging in TaskHub.Shared is built on Serilog and standardized across every microservice. The goal is structured, queryable logs — every event is a typed record with named properties, not a printf-style string.

🎯 What You Get

• Structured logging — fields like service.name, correlation.id, and user.id are first-class properties, not interpolated strings.
• Multi-sink output — console for local dev, Grafana Loki for production aggregation, easy to add file or Seq.
• Trace correlation — every log line carries the active TraceId/SpanId from OpenTelemetry, so logs and traces are linkable in Grafana.
• Request logging — each HTTP request emits a single summary line with status code, duration, and route.
• Sensitive data filtering — JWT tokens and headers are redacted via destructuring policies.

📦 Modules

Module	Purpose
TaskHub.Observability.Logger	Serilog bootstrap, ILogService abstraction, request-logging middleware.
TaskHub.Observability.OpenTelemetry	Provides the Activity context that the logger enriches against.

See Logger usage for hands-on registration and examples.

⚙️ Minimal Configuration

"Serilog": {
  "Using": [ "Serilog.Sinks.Grafana.Loki" ],
  "MinimumLevel": "Information",
  "WriteTo": [
    { "Name": "Console" },
    {
      "Name": "GrafanaLoki",
      "Args": {
        "uri": "http://loki:3100",
        "labels": [
          { "key": "app",   "value": "task-service" },
          { "key": "env",   "value": "production" }
        ]
      }
    }
  ]
}

The FullHostBuilder calls AddAppSerilog() automatically — services don’t need to wire Serilog by hand.

🧭 Log Level Guidance

Level	When
Verbose	Tight inner loops, payload dumps. Off by default.
Debug	Local diagnostic detail.
Information	One-per-request summaries, lifecycle events (started, completed). Default minimum.
Warning	Recoverable problems — retries fired, fallback used, validation rejected input.
Error	A request failed unexpectedly. Pair with an exception.
Fatal	The host cannot continue. Reserved for startup failures.

✅ Best Practices

• Use message templates, not string interpolation: log.Information("Job {JobId} published", id) — not $"Job {id} published". Templates preserve JobId as a queryable field.
• Don’t log secrets: tokens, passwords, full request bodies. The destructuring policy handles common cases but custom DTOs need attention.
• Keep messages short: rich detail belongs in tags/properties, not the message string.
• One log per layer event: don’t re-log the same exception at every catch site — log once at the boundary that knows what to do about it.

🔍 Querying in Loki

{app="task-service"} | json | result.code != 0 | line_format " "

The result.code and result.isSuccess fields come from the Response system — every Result instance auto-tags the active log scope.

---

For deep configuration (custom enrichers, sink chaining, async wrapping) see Logger usage and Logger architecture.

This site is open source. Improve this page.