ToolsToLive.Logging 10.0.1

ToolsToLive.Logging

versioning: 10.2.4, where

• 10 supported .Net version
• 2 library major version
• 4 library minor version

Configuration example

{
  "LogsSettings": {
    "ApplicationName": "AppName",
    "MinimumLevel": "Information",
    "NamespaceMinimumLevels": [
      {
        "Namespace": "Microsoft",
        "MinimumLevel": "Warning"
      }
    ],
    "ConsoleSinkSettings": {
      "Enabled": true,
      "RestrictedToMinimumLevel": "Warning",
      "Format": "Text"
    },
    "FileSinkSettings": {
      "Enabled": false,
      "Path": "logfiles/mylog_.log",
      "Format": "Json"
    },
    "HttpSinkSettings": {
      "Enabled": false,
      "RequestUri": ""
    },
    "ElasticSinkSettings": {
      "Enabled": false,
      "RequestUri": "http://elasticsearch:9200",
      "IgnoreCertificateValidation": true,
      "UserName": "elastic",
      "Password": "*************"
    }
  }
}

A complete example with every setting is in config.example.json.

Output format

Format of the console and file sinks:

• Text (default) — text rendered by OutputTemplate or the built-in template.
• Json — one line of compact JSON (CLEF) per event, written by RenderedCompactJsonFormatter from Serilog.Formatting.Compact. OutputTemplate is ignored. A multi-line exception stays inside one line, so a container log collector keeps the event as a single record.

The fields of a JSON event:

Unlike {Message:lj} of the text templates, @m puts string values in quotes: User "John" signed in. A template that already quotes a placeholder gets doubled quotes. Numbers and dates in @m use the invariant culture, as in the text output. The values themselves are also written as separate properties.

The file sink keeps buffering, daily rolling and the retention limit in both formats.

Elasticsearch sink

By default the sink creates its index templates at start, and the application does not start if Elasticsearch is unavailable. Three settings of ElasticSinkSettings make the application independent of it:

FallbackToConsole covers a batch Elasticsearch did not take: no connection, a timeout, a rejected login, retries used up. A single document Elasticsearch rejected inside an accepted batch, such as on a field type conflict, is not a delivery failure and does not reach the console.

A user with BootstrapMethod: None needs the cluster privilege monitor and the index privileges create_doc and auto_configure on logs-generic-*. Without the cluster privilege nothing reaches Elasticsearch.

How to use

var builder = WebApplication.CreateBuilder(args);

builder.Host.UseSerilog((context, loggerConfiguration) =>
{
    loggerConfiguration.ConfigureLogging(context.Configuration.GetSection("LogsSettings"));
});