PrimaLogger 2.0.1

PrimaLogger v2.0

Упрощенная обёртка над Serilog с конфигурацией через appsettings.json. Поддержка Console, File и Elasticsearch с автоматическим определением совместимости.

Быстрый старт

Настройка в Program.cs

using PrimaLogger.Configuration;

var builder = Host.CreateApplicationBuilder(args);

// Добавляем PrimaLogger
builder.Services.AddPrimaLogger(builder.Configuration);

var host = builder.Build();
host.Run();

Конфигурация в appsettings.json

{
  "Logging": {
    "PrimaLogger": {
      "ApplicationName": "MyApp",
      "Console": {
        "Enabled": true,
        "MinimumLevel": "Information"
      },
      "File": {
        "Path": "logs/app-.log",
        "MinimumLevel": "Debug"
      }
    }
  }
}

Использование в коде

public class UserController : ControllerBase
{
    private readonly ILogger<UserController> _logger;
    
    public UserController(ILogger<UserController> logger)
    {
        _logger = logger;
    }
    
    public IActionResult Login(string userId)
    {
        _logger.LogInformation("User {UserId} attempting login", userId);
        return Ok();
    }
}

Полная конфигурация

{
  "Logging": {
    "PrimaLogger": {
      "ApplicationName": "MyWebApp",
      "CustomProperties": {
        "Environment": "Production",
        "Version": "1.0.0",
        "ServiceName": "api-service"
      },
      "Console": {
        "Enabled": true,
        "MinimumLevel": "Information",
        "OutputTemplate": "{Timestamp:HH:mm:ss} [{Level:u3}] {Message:lj}{NewLine}{Exception}"
      },
      "File": {
        "Path": "logs/app-.log",
        "MinimumLevel": "Debug",
        "OutputTemplate": "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] [{ThreadId}] {Message:lj}{NewLine}{Exception}",
        "RollingInterval": "Day",
        "FileSizeLimitBytes": 104857600,
        "RetainedFileCountLimit": 31,
        "RollOnFileSizeLimit": true,
        "Shared": false,
        "Encoding": "UTF-8"
      },
      "ErrorFile": {
        "Path": "logs/errors-.log",
        "MinimumLevel": "Error",
        "RollingInterval": "Day",
        "RetainedFileCountLimit": 90
      },
      "Elasticsearch": {
        "MinimumLevel": "Information",
        "Options": {
          "Nodes": [
            "https://elasticsearch-01.domain.com:9200",
            "https://elasticsearch-02.domain.com:9200"
          ],
          "DataStreamName": "logs-mywebapp-production",
          "BootstrapMethod": "Silent",
          "ApiKey": "",
          "BufferOptions": {
            "ConcurrentConsumers": 4,
            "InboundBufferMaxSize": 500000,
            "OutboundBufferMaxSize": 5000
          }
        }
      }
    }
  }
}

Автоматическая совместимость с Elasticsearch

• Elasticsearch >= 7.9: Современный режим с Data Streams
• Elasticsearch 7.3-7.8: Legacy режим с индексами
• Elasticsearch < 7.3 или недоступен: Автоматическое отключение с предупреждением

Справочник параметров конфигурации

PrimaLoggerConfig - основные настройки

ConsoleLoggerOptions - консольный вывод

FileLoggerOptions - файловое логирование

ElasticsearchSinkOptions - настройки Elasticsearch

ElasticsearchLoggerOptions - подключение к Elasticsearch

ElasticsearchBufferOptions - буферизация и производительность

BootstrapMethod - создание индексов

RollingInterval - интервалы ротации файлов

Готовые конфигурации BufferOptions

// Низкая нагрузка (по умолчанию)
"BufferOptions": {
  "ConcurrentConsumers": 1,
  "InboundBufferMaxSize": 100000,
  "OutboundBufferMaxSize": 1000
}

// Высокая нагрузка
"BufferOptions": {
  "ConcurrentConsumers": 4,
  "InboundBufferMaxSize": 500000,
  "OutboundBufferMaxSize": 5000
}

// Очень низкая нагрузка
"BufferOptions": {
  "ConcurrentConsumers": 1,
  "InboundBufferMaxSize": 10000,
  "OutboundBufferMaxSize": 100
}

Уровни логирования

Шаблоны вывода (Output Templates)

Консоль - простой

"[{Level:u3}] {Message:lj}{NewLine}{Exception}"

Результат: [INF] User logged in successfully

Файл - с контекстом

"{Timestamp:yyyy-MM-dd HH:mm:ss.fff} [{Level:u3}] [{ThreadId}] {SourceContext}: {Message:lj}{NewLine}{Exception}"

Результат: 2024-01-15 14:30:25.123 [INF] [1] MyApp.Controllers.UserController: User logged in successfully

Основные переменные

• {Timestamp} - время события
• {Level} - уровень логирования
• {Message} - текст сообщения
• {ThreadId} - ID потока
• {SourceContext} - имя класса/логгера
• {Application} - название приложения
• {Environment} - окружение
• {Exception} - информация об исключении

Синки отключены по умолчанию

Если секция отсутствует в конфигурации, соответствующий sink отключен:

{
  "Logging": {
    "PrimaLogger": {
      "ApplicationName": "MyApp"
      // Console, File, ErrorFile, Elasticsearch - все отключены
    }
  }
}

Глобальный минимальный уровень

Автоматически выбирается самый низкий уровень из всех включенных sink'ов.

Elasticsearch проверка при старте

При запуске приложения выполняется проверка доступности и версии Elasticsearch (таймаут 5 секунд).