.NET Разработчик: “День 1784. #ЗаметкиНаПолях Лучшие Практики Логирования с Serilog. Окон…”

День 1784. #ЗаметкиНаПолях
Лучшие Практики Логирования с Serilog. Окончание
Начало

4. Обогатите логи с помощью CorrelationId
Свойство CorrelationId помогает отслеживать логи, относящиеся к одному и тому же запросу. Это также работает в нескольких приложениях. Для этого необходимо передать CorrelationId через HTTP-заголовок, например, X-Correlation-Id. В примере ниже создадим промежуточное ПО для добавления CorrelationId:


public class RequestLoggingMiddleware
{
  private const string HEADER = "X-Correlation-Id";
  private RequestDelegate _next;

  public RequestLoggingMiddleware(
   RequestDelegate next)
  {
    _next = next;
  }

  public Task Invoke(HttpContext ctx)
  {
    var cId = GetCorrelationId(ctx);

    using (LogContext.PushProperty(
     "CorrelationId", cId))
    {
      return _next.Invoke(ctx);
    }
  }

  private static string GetCorrelationId(
   HttpContext ctx)
  {
    ctx.Request.Headers.TryGetValue(
      HEADER, out StringValues cId);

    return cId.FirstOrDefault() ?? ctx.TraceIdentifier;
  }
}

Затем добавим промежуточное ПО в конвейер. Обратите внимание, что порядок регистрации важен. Если вам нужен CorrelationId во всех логах, нужно зарегистрировать его в начале:

app.UseMiddleware<RequestContextLoggingMiddleware>();

5. Логируйте важные события приложений
К важным событиям можно отнести информацию о текущем запросе, ошибках, сбоях, неожиданных значениях, точках ветвления и т. д. Одни предпочитают использовать шаблон Result для обработки сбоев приложения. Поэтому понадобится специальное промежуточное ПО для логирования результатов обработки запросов. Другие используют исключения для достижения той же функциональности. Использование исключений для управления потоком — плохая практика. Но все же не забудьте добавить глобальный обработчик для необработанных исключений.

Итого
Все структурированные логи имеют одну и ту же структуру. Это облегчает фильтрацию и поиск конкретной информации в них. Также они предоставляют больше контекста и подробную информацию об ошибках приложений, облегчают выявление и устранение проблем.
Вы можете использовать LogContext в Serilog, чтобы обогатить ваши логи значением CorrelationId, что позволит легко отслеживать все записи, относящиеся к одному запросу.
Когда вы настроите структурированное ведение журнала, вам понадобится искать и анализировать свои журналы. Seq — отличный инструмент для этого, который можно бесплатно использовать для локальной разработки.

Источник: https://www.milanjovanovic.tech/blog/5-serilog-best-practices-for-better-structured-logging