Logging

Overview #

Adds the logging capability, by default uses Serilog for logging with optional extensions (sinks):

• Console
• File
• Seq

Installation #

dotnet add package Genocs.Logging

Dependencies #

• Genocs.Core

Usage #

Extend Program.cs -> CreateBuilder() with UseLogging() that will add the required services and configure ILogger available in ASP.NET Core framework.

using Genocs.Logging;

StaticLogger.EnsureInitialized();

var builder = WebApplication.CreateBuilder(args);

builder.Host
        .UseLogging();

...

// Last line of the Main method
Log.CloseAndFlush();

Then, simply inject ILogger<T> (being ASP.NET Core built-in abstraction) to write the logs.

public class SomeService
{
    private readonly ILogger<SomeService> _logger;

    public SomeService(ILogger<SomeService> logger)
    {
        _logger = logger;
    }

    public void Foo()
    {
        _logger.LogInformation("Foo");
    }
}

Options #

enabled - enables/disables logging. Default: true.

level - sets the minimum level of logs that should be written. Default: Information.

excludePaths - optional endpoints that should be excluded from logging (e.g. while performing the health checks by other services).

excludeProperties - optional properties that should be excluded from logging (e.g. passwords, tokens, etc.).

minimumLevelOverrides - overrides the minimum level of logs for specific namespaces (e.g. Microsoft or System).

console.enabled - enables/disables console logger.

elk.enabled - enables/disables ELK logger

elk.url - URL to ELK endpoint.

elk.username - username for ELK endpoint.

elk.password - password for ELK endpoint.

elk.indexFormat - index format for ELK endpoint.

file.enabled - enables/disables file logger.

file.path - path to the file logs.

file.interval - how often should the new file with logs be created.

loki.enabled - enables/disables Loki logger.

loki.url - URL to Loki endpoint.

loki.batchPostingLimit - batch posting limit for Loki.

loki.queueLimit - queue limit for Loki.

loki.period - period for Loki.

loki.lokiUsername - username for Loki endpoint.

loki.lokiPassword - password for Loki endpoint.

mongo.enabled - enables/disables Mongo logger.

seq.enabled - enables/disables Seq logger.

seq.url - URL to Seq API.

seq.apiKey - API key (if provided) used while sending logs to Seq.

azure.enabled - enables/disables Azure Application Insights logger. Default: false.

azure.connectionString - Azure Application Insights connection string

azure.enableTracing - Azure Application Insights tracing. Default: false.

azure.enableMetrics - Azure Application Insights metrics. Default: false.

console.enabled - enables/disables logging in console. Default: false.

console.enableStructured - enables/disables structured logging in console. Default: false.

console.enableTracing - enables/disables tracing in console. Default: false.

console.enableMetrics - enables/disables metrics in console. Default: false.

appsettings.json

"logger": {
    "enabled": true,
    "level": "Information",
    "excludePaths": ["/", "/healthz", "/alive", "/metrics"],
    "minimumLevelOverrides": {
    "microsoft": "Information",
    "system": "Warning"
  },
  "excludeProperties": [
    "api_key",
    "access_key",
    "ApiKey",
    "ApiSecret",
    "ClientId",
    "ClientSecret",
    "ConnectionString",
    "Password",
    "Email",
    "Login",
    "Secret",
    "Token"
  ],
  "azure": {
    "enabled": false,
    "connectionString": "AppInsightsConnectionString",
    "enableTracing": false,
    "enableMetrics": false
  },
  "console": {
    "enabled": true,
    "enableStructured": false,
    "enableTracing": false,
    "enableMetrics": false
  },
  "elk": {
    "enabled": false,
    "basicAuthEnabled": false,
    "url": "http://localhost:9200",
    "username": "user",
    "password": "user",
    "indexFormat": "user"
  },
  "file": {
    "enabled": true,
    "path": "logs/logs.txt",
    "interval": "day"
  },
  "loki": {
    "enabled": false,
    "url": "http://localhost:3100",
    "batchPostingLimit": 100,
    "queueLimit": 100,
    "period": "00:00:10",
    "lokiUsername": "user",
    "lokiPassword": "password"
  },    
  "mongo": {
    "enabled": false
  },  
  "seq": {
    "enabled": true,
    "url": "http://localhost:5341",
    "apiKey": "secret"
  },
  "tags": {}
}