День 2323. #ЧтоНовенького
Запись Логов по Требованию с Буферизацией. Окончание
Начало

2. Буферизация по запросу
Для веб-приложений ASP.NET Core буферизация по запросу обеспечивает более детальный контроль, поддерживая отдельные буферы для каждого HTTP-запроса. Подходит для отслеживания полного контекста отдельных взаимодействий пользователей.

Добавляем буферизацию по запросу:

builder.Services.AddPerIncomingRequestBuffer(o =>
{
  // Логи Information от API контроллеров
  o.Rules.Add(
   new LogBufferingFilterRule(
    categoryPrefix: "MyApp.Controllers",
    logLevel: LogLevel.Information));

  o.AutoFlushDuration = TimeSpan.FromSeconds(5);
});

Ключевое отличие от глобальной буферизации - когда HTTP-запрос завершается, буфер очищается и все его логи удаляются.

Очистка буфера по запросу
Чтобы выдать буферизованные логи для определённого запроса, внедрите класс PerRequestLogBuffer:

[ApiController]
[Route("[controller]")]
public class OrderController : ControllerBase
{
  private ILogger<OrderController> _logger;
  private PerRequestLogBuffer _buffer;

  public OrderController(
   ILogger<OrderController> logger,
   PerRequestLogBuffer buffer)
  {
    _logger = logger;
    _buffer = buffer;
  }

  [HttpPost]
  public IActionResult CreateOrder(
   OrderRequest request)
  {
    try
    {
      _logger.LogInformation("Заказ для клиента {CustomerId}", request.CustomerId);
      // Обработка заказа…
      _logger.LogInformation("Заказ {OrderId} создан", orderId);

      return Ok(new { OrderId = orderId });
    }
    catch (Exception ex)
    {
      _logger.LogError(ex, "Сбой заказа");
      _buffer.Flush();
      return StatusCode(500, "Сбой создания заказа");
    }
  }
}

Запись (flush) буфера по запросу также записывает глобальный буфер, гарантируя, что все соответствующие логи будут записаны при возникновении ошибки.

Динамические обновления конфигурации
Если вы используете провайдер конфигурации, поддерживающий перезагрузки (например, File Configuration Provider), вы можете обновить правила буферизации без перезапуска приложения.

Это особенно ценно в производственных сценариях, где может потребоваться временно увеличить детализацию логов для диагностики проблемы, а затем вернуться к обычным уровням после её устранения.

Рекомендации
1. Стратегия буферизации
Буферизуйте подробные логи с уровня Information, но позвольте логам Error и Critical записываться немедленно. Это гарантирует, что важные проблемы всегда будут видны, а подробный контекст будет доступен только при необходимости.

2. Создайте явные триггеры записи (flush)
Определите конкретные условия, при которых контекст лога имеет значение, и добавьте явные вызовы записи:
- При исключениях или ошибках,
- Когда операции превышают ожидаемую продолжительность,
- Когда обнаружено что-то подозрительное.

3. Добавьте выборку логов для максимальной эффективности
Для приложений с большим объёмом логов используйте буферизацию и выборку:
- Фильтруйте обычные логи для уменьшения общего объёма,
- Буферизируйте подробные логи для записи контекста очистки при необходимости.

Ограничения
-.NET 9 и выше,
- Точный порядок логов может не сохраняться (временные метки сохраняются),
- Области (scope) логов не поддерживаются,
- Некоторые расширенные свойства записи логов (например, ActivitySpanId) не сохраняются.

Производительность
Буферизация логов — это компромисс между памятью и хранилищем:
- Буферизованные логи потребляют память, пока они не будут либо записаны, либо отброшены,
- Записывая логи только в определённых сценариях, вы можете радикально сократить расходы на хранение.
Для больших распределённых приложений накладные расходы памяти минимальны по сравнению с потенциальной экономией хранилища.

Источник: https://devblogs.microsoft.com/dotnet/emit-logs-on-demand-with-log-buffering/