Подавление временного ведения журнала для области действия в Serilog

Question

Мне нужно временно отключить ведение журнала для некоторой области. В моем случае есть фоновая задача, которая периодически пытается создать экземпляр некоторого API устройства для каждого доступного COM-порта в системе и посмотреть, не работает ли он. Этот API записывает много информации в журнал в случае сбоя (исключения, внутренние компоненты, вызовы Dispose и т. Д.). В результате журнал переполняется такими ошибками неудачных попыток каждую секунду.

Я придумал решение, которое использует LogContext.PushProperty для идентификации подавленных событий журнала. Однако следующий код ничего не регистрирует:

internal static class Program
{
    public static void Main(String[] args)
    {
        void StartListeningSomething()
        {
            Task.Factory.StartNew(() =>
            {
                while (true)
                {
                    Log.Information("Listening");
                    Thread.Sleep(500);
                }
            }, TaskCreationOptions.LongRunning);
        }

        Log.Logger = new LoggerConfiguration()
            .Enrich.WithThreadId()
            .Filter.ByExcluding(logEvent => logEvent.Properties.ContainsKey("SuppressLogging"))
            .Enrich.FromLogContext()
            .WriteTo.Console(new JsonFormatter())
            .CreateLogger();

        using (LogContext.PushProperty("SuppressLogging", true))
        {
            StartListeningSomething();
            Console.ReadKey(); // Will ignore background thread log messages until key enter
        }

        // We want to start logging events after exiting using block
        // But they won't be logged for listener thread at all

        Console.ReadKey();
    }
}

Все события журнала внутри задачи прослушивателя будут обогащаться свойством «SupressLogging» даже после извлечения его из области.

Answer 1

Единственный найденный мной обходной путь (за исключением утомительной передачи, настроенной ILogger по всему API) состоит из следующих шагов:

• Назначить уникальное значение "SupressLogging" свойство
• Добавить это значение во внутреннюю статическую память
• При выходе из области удалить это значение из хранилища (сделать недействительным)
• В разделе Filter конфигурации регистратора проверьте, что свойство присоединено, и его значение является допустимым (содержится в хранилище).

В следующем коде используется собственный токен IDisposable, чтобы он выглядел как обычный PushProperty

internal static class Program
{
    public static void Main(String[] args)
    {
        void StartListeningSomething()
        {
            Task.Factory.StartNew(() =>
            {
                while (true)
                {
                    Log.Information("Listening");
                    Thread.Sleep(500);
                }
            }, TaskCreationOptions.LongRunning);
        }

        Log.Logger = new LoggerConfiguration()
            .Enrich.WithThreadId()
            .Filter.ByExcluding(logEvent => logEvent.IsSuppressed()) // Check if log event marked with supression property
            .Enrich.FromLogContext()
            .WriteTo.Console(new JsonFormatter())
            .CreateLogger();

        using (SerilogExtensions.SuppressLogging())
        {
            StartListeningSomething();
            Console.ReadKey(); // Will ignore background thread log messages until some key is entered
        }

        // Will start logging events after exiting the using block

        Console.ReadKey();
    }
}

И фактические расширения Serilog:

/// <summary>
///     Provides helper extensions to Serilog logging.
/// </summary>
public static class SerilogExtensions
{
    private const           String        SuppressLoggingProperty = "SuppressLogging";
    private static readonly HashSet<Guid> ActiveSuppressions      = new HashSet<Guid>();

    /// <summary>
    ///     Get disposable token to supress logging for context.
    /// </summary>
    /// <remarks>
    ///     Pushes "SuppressLogging" property with unique value to SerilogContext.
    ///     When disposed, disposes Serilog property push token and invalidates stored value so new log messages are no longer
    ///     supressed.
    /// </remarks>
    public static IDisposable SuppressLogging()
    {
        return new SuppressLoggingDisposableToken();
    }

    /// <summary>
    ///     Determines whether the given log event suppressed.
    /// </summary>
    /// <remarks>
    ///     Also removes "SuppressLogging" property if present.
    /// </remarks>
    public static Boolean IsSuppressed(this LogEvent logEvent)
    {
        Boolean containsProperty = logEvent.Properties.TryGetValue(SuppressLoggingProperty, out var val);
        if (!containsProperty)
            return false;

        logEvent.RemovePropertyIfPresent(SuppressLoggingProperty); //No need for that in logs

        if (val is ScalarValue scalar && scalar.Value is Guid id)
            return ActiveSuppressions.Contains(id);

        return false;
    }

    /// <summary>
    ///     Disposable wrapper around logging supression property push/pop and value generation/invalidation.
    /// </summary>
    private class SuppressLoggingDisposableToken : IDisposable
    {
        private readonly IDisposable _pushPropertyDisposable;
        private readonly Guid        _guid;

        public SuppressLoggingDisposableToken()
        {
            _guid                   = Guid.NewGuid();
            _pushPropertyDisposable = LogContext.PushProperty(SuppressLoggingProperty, _guid);

            ActiveSuppressions.Add(_guid);
        }

        public void Dispose()
        {
            ActiveSuppressions.Remove(_guid);
            _pushPropertyDisposable.Dispose();
        }
    }
}

Полный пример проекта можно найти на github .

Я хотел бы оставить этот вопрос с ответом здесь, а также спросить более опытных пользователей Serilog, что они думают об этой проблеме. Может быть, есть какой-то общий подход к подавлению журнала, который я не нашел?