Table of Contents

Configuration

If you have not read it yet, start with Introduction for the overall story.

Logging volume and shape for a host are driven from the Monitoring section in that host’s appsettings.json. The same block is used across WebApp, AdminPanel, Api, and similar clients in the SaaS template; adjust Service.Name per app so dashboards and exports can tell hosts apart.

Monitoring:Service

Field Why it matters
Name Friendly label for this host inside monitoring and log export (for example CanBeYours.AdminPanel).
HealthCheckPath Path exposed for liveness checks; keep it stable if your reverse proxy or orchestrator probes it.

Monitoring:Logging

These settings map to LoggingSettings in the Monitoring module. They control OpenTelemetry log export (console while developing, Mongo when Monitoring is active)—not the presence of DevKit’s HTTP/MediatR log lines, which are emitted through normal ILogger; they help you decide how much of that stream is processed and stored.

Field What you usually do
MinimumLogLevel Floor for what gets exported (for example Information in dev, Warning in noisy production).
Filters Per category overrides (for example raise Microsoft and Microsoft.AspNetCore to Warning so framework chatter does not drown your app).
IncludeFormattedMessage Include human-readable formatted text in exported records.
IncludeScopes Include log scopes (useful with ASP.NET Core’s request scopes and correlation IDs).
ParseStateValues Parse structured state into exported fields where supported.

The template’s Admin Panel ships a block like the following (trim or extend Filters for your own noise profile):

{
  "Monitoring": {
    "Service": {
      "Name": "CanBeYours.AdminPanel",
      "HealthCheckPath": "/health"
    },
    "Logging": {
      "IncludeFormattedMessage": true,
      "IncludeScopes": true,
      "ParseStateValues": true,
      "MinimumLogLevel": "Information",
      "Filters": {
        "Microsoft": "Warning",
        "Microsoft.AspNetCore": "Warning",
        "Hangfire.BackgroundJobServer": "Warning",
        "Hangfire.Server.BackgroundServerProcess": "Warning"
      }
    }
  }
}

Live files you can compare against: AdminPanel/appsettings.json, WebApp/appsettings.json, and Api/appsettings.json.

For dashboards, retention, and Mongo-backed views of logs, continue with the Monitoring module introduction.