Книги
C#
Глава 5. Хорошие практики программирования
Журналирование

C#:
Журналирование

Как это сделать:

В C# вы можете использовать встроенное пространство имен System.Diagnostics или сторонние библиотеки, такие как NLog или log4net. Вот быстрый пример использования интерфейса ILogger, доступного в .NET Core:

using Microsoft.Extensions.Logging;
using System;

public class Program
{
    public static void Main()
    {
        using var loggerFactory = LoggerFactory.Create(builder => {
            builder.AddConsole();
        });

        ILogger logger = loggerFactory.CreateLogger<Program>();

        logger.LogInformation("Это информационное сообщение.");
        logger.LogWarning("Это предупреждение.");
        logger.LogError("Это сообщение об ошибке.");
    }
}

Пример вывода:

info: Program[0]
      Это информационное сообщение.
warn: Program[0]
      Это предупреждение.
fail: Program[0]
      Это сообщение об ошибке.

Подробнее

История логирования в разработке программного обеспечения почти так же стара, как и само программирование; она эволюционировала от простых операторов печати до сложных, настраиваемых систем. Изначально логирование осуществлялось путем записи в файлы или консоль, но теперь это расширяется до более сложных структур, таких как системы агрегации логов и платформы распределенного трассирования (например, ELK стек или Jaeger).

Альтернативы встроенному логированию в .NET включают сторонние библиотеки:

  • NLog: универсальный и легкий в настройке с большим количеством функций для маршрутизации, форматирования и фильтрации логов.
  • log4net: вдохновленный библиотекой Java log4j, он высоко настраиваем из XML и поддерживает разнообразие репозиториев логов.

Когда речь заходит о деталях реализации, выбор вашей абстракции логирования (например, Microsoft.Extensions.Logging) и подлежащего логирования провайдера может значительно повлиять на производительность и надежность вашего приложения. Крайне важно соответствующим образом настроить уровни логирования и убедиться, что запись логов не становится узким местом.

Также, структурированное логирование - когда вы логируете не просто строки, но пары ключ-значение или объекты - позволяет получать более точные и оперативные логи, которые легче запросить и проанализировать.

См. также

Обработка ошибокОрганизация кода в функции