PrimaLogger 2.1.0

PrimaLogger v2.1

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

Быстрый старт по версиям .NET

.NET 8/7/6 (Minimal API / Новый стиль)

Program.cs:

using PrimaLogger.Configuration;

var builder = WebApplication.CreateBuilder(args);
// или для консольных приложений:
// var builder = Host.CreateApplicationBuilder(args);

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

// Остальные сервисы
builder.Services.AddControllers();

var app = builder.Build();

// Конфигурация pipeline
app.MapControllers();
app.Run();

appsettings.json:

{
  "Logging": {
    "PrimaLogger": {
      "ApplicationName": "MyModernApp",
      "Console": {
        "Enabled": true,
        "MinimumLevel": "Information"
      }
    }
  }
}

.NET 5 (Generic Host)

Program.cs:

using Microsoft.Extensions.Hosting;
using PrimaLogger.Configuration;

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureServices((hostContext, services) =>
            {
                // Добавляем PrimaLogger
                services.AddPrimaLogger(hostContext.Configuration);
                
                // Остальные сервисы
                services.AddControllers();
            })
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
}

.NET Core 3.1/3.0 (Generic Host)

Program.cs:

using Microsoft.Extensions.Hosting;
using PrimaLogger.Configuration;

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureServices((hostContext, services) =>
            {
                // Добавляем PrimaLogger
                services.AddPrimaLogger(hostContext.Configuration);
            })
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
}

.NET Core 2.2/2.1 (WebHost)

Program.cs:

using Microsoft.AspNetCore;
using Microsoft.AspNetCore.Hosting;
using PrimaLogger.Configuration;

public class Program
{
    public static void Main(string[] args)
    {
        CreateWebHostBuilder(args).Build().Run();
    }

    public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
        WebHost.CreateDefaultBuilder(args)
            .ConfigureServices((hostContext, services) =>
            {
                // Добавляем PrimaLogger
                services.AddPrimaLogger(hostContext.Configuration);
            })
            .UseStartup<Startup>();
}

.NET Framework 4.6.1+ (классический ASP.NET)

Program.cs:

using PrimaLogger.Configuration;
using Microsoft.Extensions.Logging;

public class Program
{
    public static void Main(string[] args)
    {
         ServiceCollection serviceCollection = new ServiceCollection();
         Config = new ConfigurationBuilder()
             .SetBasePath(Directory.GetParent(AppContext.BaseDirectory).FullName)
             .AddJsonFile("appsettings.json", false)
             .Build();
         serviceCollection.AddSingleton<IConfigurationRoot>(Config);
         serviceCollection.AddPrimaLogger(Config);
         IServiceProvider serviceProvider = serviceCollection.BuildServiceProvider();
         var logger = serviceProvider.GetRequiredService<ILogger<Program>>(); //вызываем где надо, используем как логгер
    }
}

Установка пакетов:

<package id="PrimaLogger" version="2.1.0" />
<package id="Unity.AspNet.Mvc" version="5.11.1" />
<package id="Microsoft.Extensions.Configuration" version="2.1.0" />
<package id="Microsoft.Extensions.Configuration.Json" version="2.1.0" />

appsettings.json:

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

Global.asax.cs (с Unity контейнером):

using System.Web.Mvc;
using System.Web.Optimization;
using System.Web.Routing;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Unity;
using Unity.AspNet.Mvc;
using Unity.Lifetime;
using PrimaLogger.Configuration;

public class MvcApplication : System.Web.HttpApplication
{
    protected void Application_Start()
    {
        // Стандартная инициализация MVC
        AreaRegistration.RegisterAllAreas();
        FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
        RouteConfig.RegisterRoutes(RouteTable.Routes);
        BundleConfig.RegisterBundles(BundleTable.Bundles);
        
        // Настройка DI
        RegisterDependencies();
    }
    
    private void RegisterDependencies()
    {
        var container = new UnityContainer();
        
        // Создаем конфигурацию из Web.config
        var configBuilder = new ConfigurationBuilder()
            .AddConfiguration(System.Configuration.ConfigurationManager.AppSettings);
        var configuration = configBuilder.Build();
        
        // Создаем ServiceCollection и добавляем PrimaLogger
        var services = new ServiceCollection();
        services.AddPrimaLogger(configuration);
        
        // Регистрируем PrimaLogger сервисы в Unity
        var serviceProvider = services.BuildServiceProvider();
        
        container.RegisterInstance<Microsoft.Extensions.Logging.ILoggerFactory>(
            serviceProvider.GetService<Microsoft.Extensions.Logging.ILoggerFactory>(), 
            new ContainerControlledLifetimeManager());
            
        container.RegisterType(typeof(Microsoft.Extensions.Logging.ILogger<>), 
            typeof(Microsoft.Extensions.Logging.Logger<>), 
            new ContainerControlledLifetimeManager());
        
        // Регистрируем ваши сервисы
        container.RegisterType<IUserService, UserService>();
        
        // Устанавливаем resolver
        DependencyResolver.SetResolver(new UnityDependencyResolver(container));
    }
}

Альтернативный вариант с Autofac:

// В Global.asax.cs
private void RegisterDependencies()
{
    var builder = new ContainerBuilder();
    
    // Создаем конфигурацию
    var configBuilder = new ConfigurationBuilder()
        .AddConfiguration(System.Configuration.ConfigurationManager.AppSettings);
    var configuration = configBuilder.Build();
    
    // Создаем ServiceCollection и добавляем PrimaLogger
    var services = new ServiceCollection();
    services.AddPrimaLogger(configuration);
    
    // Регистрируем в Autofac
    builder.Populate(services);
    
    // Регистрируем контроллеры
    builder.RegisterControllers(typeof(MvcApplication).Assembly);
    
    var container = builder.Build();
    DependencyResolver.SetResolver(new AutofacDependencyResolver(container));
}

Конфигурация (универсальная для всех версий .NET Core/.NET 5+)

Минимальная конфигурация в appsettings.json:

{
  "Logging": {
    "PrimaLogger": {
      "ApplicationName": "MyApp",
      "Console": {
        "Enabled": true,
        "MinimumLevel": "Information"
      }
    }
  }
}

Полная конфигурация в appsettings.json:

{
  "Logging": {
    "PrimaLogger": {
      "ApplicationName": "UpdatersWebApp.Debug",
      "CustomProperties": {
        "Environment": "Development",
        "Version": "1.0.0",
        "ServiceName": "updaters-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} [{Level:u3}] {SourceContext}: {Message:lj}{NewLine}{Exception}",
        "RollingInterval": "Day",
        "FileSizeLimitBytes": 104857600,
        "RetainedFileCountLimit": 30,
        "RollOnFileSizeLimit": true,
        "Shared": false,
        "Encoding": "UTF-8"
      },
      "ErrorFile": {
        "Path": "logs/errors-.log",
        "MinimumLevel": "Error",
        "OutputTemplate": "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {SourceContext}: {Message:lj}{NewLine}{Exception}",
        "RollingInterval": "Day",
        "FileSizeLimitBytes": 104857600,
        "RetainedFileCountLimit": 90,
        "Encoding": "UTF-8"
      },
      "Logstash": {
        "MinimumLevel": "Information",
        "Options": {
          "Host": "elk-stack-server",
          "Port": 5000,
          "Protocol": "Tcp"
        }
      }
    }
  }
}

Использование в коде (одинаково для всех версий)

В контроллерах:

using Microsoft.Extensions.Logging;
using Microsoft.AspNetCore.Mvc; // или System.Web.Mvc для .NET Framework

public class UserController : Controller
{
    private readonly ILogger<UserController> _logger;
    
    public UserController(ILogger<UserController> logger)
    {
        _logger = logger;
    }
    
    public IActionResult Login(string userId)
    {
        _logger.LogInformation("User {UserId} attempting login", userId);
        
        try
        {
            // Логика авторизации
            _logger.LogDebug("Validating credentials for {UserId}", userId);
            
            // Успешная авторизация
            _logger.LogInformation("User {UserId} logged in successfully", userId);
            return Ok();
        }
        catch (Exception ex)
        {
            _logger.LogError(ex, "Login failed for user {UserId}", userId);
            return BadRequest("Login failed");
        }
    }
}

В сервисах:

public class UserService
{
    private readonly ILogger<UserService> _logger;
    
    public UserService(ILogger<UserService> logger)
    {
        _logger = logger;
    }
    
    public async Task ProcessUserAsync(string userId)
    {
        _logger.LogDebug("Starting user processing for {UserId}", userId);
        
        using (_logger.BeginScope("UserId: {UserId}", userId))
        {
            try
            {
                await DoSomeWorkAsync(userId);
                _logger.LogInformation("User processing completed successfully");
            }
            catch (Exception ex)
            {
                _logger.LogError(ex, "Failed to process user");
                throw;
            }
        }
    }
}

В консольных приложениях:

public class Program
{
    private static ILogger<Program> _logger;
    
    public static async Task Main(string[] args)
    {
        // Настройка для консольного приложения
        var builder = Host.CreateApplicationBuilder(args);
        builder.Services.AddPrimaLogger(builder.Configuration);
        
        var host = builder.Build();
        _logger = host.Services.GetRequiredService<ILogger<Program>>();
        
        _logger.LogInformation("Application starting");
        
        try
        {
            await RunApplicationLogicAsync();
            _logger.LogInformation("Application completed successfully");
        }
        catch (Exception ex)
        {
            _logger.LogFatal(ex, "Application terminated unexpectedly");
        }
    }
}

Logstash интеграция

PrimaLogger поддерживает отправку логов в Logstash через различные протоколы:

Logstash TCP (рекомендуется)

{
  "Logstash": {
    "MinimumLevel": "Information",
    "Options": {
      "Host": "elk-stack-server",
      "Port": 5000,
      "Protocol": "Tcp"
    }
  }
}

Logstash UDP (быстрее, но менее надежен)

{
  "Logstash": {
    "MinimumLevel": "Information",
    "Options": {
      "Host": "elk-stack-server",
      "Port": 5000,
      "Protocol": "Udp"
    }
  }
}

Автоматический fallback при недоступности Logstash

Если Logstash недоступен, логи продолжат записываться в Console и File:

[WAR] Logstash недоступен: Connection refused
[WAR] • Host: elk-stack-server:5000 (TCP)
[WAR] • Logstash sink отключен, продолжаем работу с локальными sinks

Различия в конфигурации между версиями .NET

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

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

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

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

LogstashSinkOptions - настройки Logstash

LogstashLoggerOptions - подключение к Logstash

LogLevelOverrides - переопределение уровней для категорий

По умолчанию PrimaLogger снижает уровень логирования для шумных компонентов:

Можно переопределить эти настройки:

{
  "LogLevelOverrides": {
    "Categories": {
      "Microsoft.EntityFrameworkCore.Database.Command": "Debug",
      "MyApp.Namespace": "Verbose"
    }
  }
}

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

Мониторинг и диагностика

Логирование запуска

При инициализации PrimaLogger автоматически логирует информацию о конфигурации:

[INF] PrimaLogger инициализирован для MyApp
[INF] Активные sinks: Console(Information), File(Debug), Logstash(Information) | Минимальный уровень: Debug

Обработка ошибок Logstash

При проблемах с Logstash:

[WAR] Logstash недоступен: Connection refused
[WAR] • Host: logs.example.com:5000 (TCP)
[WAR] • Logstash sink отключен, продолжаем работу с локальными sinks