LoggingOverheadBenchmark.cs

// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

using BenchmarkDotNet.Attributes;
using Microsoft.Extensions.DependencyInjection;
using MicroBenchmarks;

namespace Microsoft.Extensions.Logging
{
    [BenchmarkCategory(Categories.Libraries)]
    public class LoggingOverhead : LoggingBenchmarkBase
    {
        private ILogger _logger;

        [GlobalSetup]
        public void Setup()
        {
            var services = new ServiceCollection();
            services.AddLogging();
            services.AddSingleton<ILoggerProvider, LoggerProvider<NoopLogger>>();
            _logger = services.BuildServiceProvider().GetService<ILoggerFactory>().CreateLogger("Logger");
        }

        [Benchmark]
        public void NoArguments_FilteredByLevel()
        {
            _logger.LogTrace(Exception, "Message");
        }

        // Baseline as this is the fastest way to do nothing
        [Benchmark(Baseline = true)]
        public void NoArguments_DefineMessage_FilteredByLevel()
        {
            NoArgumentTraceMessage(_logger, Exception);
        }

        [Benchmark]
        public void NoArguments()
        {
            _logger.LogError(Exception, "Message");
        }

        [Benchmark]
        public void NoArguments_DefineMessage()
        {
            NoArgumentErrorMessage(_logger, Exception);
        }

        [Benchmark]
        public void TwoArguments()
        {
            _logger.LogError(Exception, "Message {Argument1} {Argument2}", 1, "string");
        }

        [Benchmark]
        public void TwoArguments_FilteredByLevel()
        {
            _logger.LogTrace(Exception, "Message {Argument1} {Argument2}", 1, "string");
        }

        [Benchmark]
        public void TwoArguments_DefineMessage()
        {
            TwoArgumentErrorMessage(_logger, 1, "string", Exception);
        }

        [Benchmark]
        public void TwoArguments_DefineMessage_FilteredByLevel()
        {
            TwoArgumentTraceMessage(_logger, 1, "string", Exception);
        }
    }
}