Reo.Core.Logging 10.0.210

Reo.Core.Logging

Описание пакета

Reo.Core.Logging — это библиотека для настройки и валидации конфигурации логгирования с использованием Serilog. Пакет обеспечивает проверку корректности настроек, таких как Enrich, Using, WriteTo, и других, через FluentValidation. Это позволяет избежать ошибок в конфигурации приложения на этапе запуска, а также упрощает интеграцию с системами логгирования, такими как Graylog, ElasticSearch и консоль.

Решаемые проблемы

• Обеспечение обязательного наличия критически важных настроек логгирования.
• Валидация структуры конфигурации для предотвращения ошибок в работе логгирования.
• Поддержка нескольких целевых систем логгирования (Console, Graylog, ElasticSearch).

Основные компоненты

1. Serilog Класс, представляющий настройки Serilog. Содержит свойства:

   • Using — список используемых пакетов (например, Serilog.Sinks.Console).
   • Enrich — список расширений для обогащения логов (например, FromLogContext).
   • WriteTo — массив объектов WriteTo, определяющих, куда отправлять логи.

2. WriteTo Класс, описывающий целевую систему логгирования. Содержит:

   • Name — имя цели (например, Console, Graylog, Elastic).
   • Args — словарь аргументов для настройки цели (например, hostnameOrAddress, nodeUris).

3. SerilogSectionValidator Валидатор, проверяющий обязательные поля в Serilog, такие как Enrich, Using, и WriteTo. Генерирует ошибки, если конфигурация не соответствует требованиям.

4. WriteToSectionValidator Валидатор, проверяющий корректность настроек для каждой цели логгирования. Например, для Elastic проверяет наличие nodeUris, indexFormat, и т.д.

5. ReoLoggerSectionNotFoundException Исключение, выбрасываемое, если секция Serilog отсутствует в конфигурации.

Требования

• .NET версии: 8.0, 9.0
• Зависимости:
  • Serilog
  • FluentValidation

Установка

NuGet Package Manager

Install-Package Reo.Core.Logging

.NET CLI

dotnet add package Reo.Core.Logging

Настройка

Регистрация в DI-контейнере (ASP.NET Core)

Добавьте следующий код в Program.cs или Startup.cs:

var builder = WebApplication.CreateBuilder(args);
builder.Host.UseSerilog((context, configuration) =>
 configuration.ReadFrom.Configuration(context.Configuration));

Конфигурационные параметры

Пример appsettings.json:

{
 "Serilog": {
 "Using": ["Serilog.Sinks.Console", "Serilog.Sinks.Graylog"],
 "Enrich": ["FromLogContext", "WithThreadId"],
 "WriteTo": [
 {
 "Name": "Console",
 "Args": {
 "outputTemplate": "{Timestamp:yyyy-MM-dd HH:mm:ss.fff} [{Level}] {Message}{NewLine}{Exception}"
 }
 },
 {
 "Name": "Graylog",
 "Args": {
 "serverUri": "http://graylog-server:12201",
 "messageTemplate": "{Message}"
 }
 }
 ]
 }
}

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

Пример 1: Настройка логгирования в ASP.NET Core

var app = builder.Build();
app.UseSerilog(); // Используется по умолчанию при использовании UseSerilog в Host

Пример 2: Проверка конфигурации в коде

var configuration = new ConfigurationBuilder()
 .AddJsonFile("appsettings.json")
 .Build();

var validator = new SerilogSectionValidator();
var serilogConfig = new Options.Serilog();
configuration.GetSection("Serilog").Bind(serilogConfig);
validator.ValidateAndThrow(serilogConfig);

Лицензия

Данный пакет распространяется под лицензией MIT.