BeginScope: support for non-serializable objects + performance improvement (20-50% cpu, 35% times less allocations)

[snakefoot]

Improves the support of custom objects together with BeginScope, when using AppDomains (Using CallContext that requires serializable objects)

Ex. ActionLogScope. Attempt to resolve NLog/NLog#2812

Includes a small performance boost in handling of Microsofts internal ActionLogScope + HostingLogScope + FormattedLogValue by using IReadOnlyList in the fast-path of BeginScope. (Still supports Arrays and Lists), so it doesn't allocate yield-enumerator or uses keyvaluepair-property-extractor.

Includes a small performance boost by reusing a shared allocation of NLogBeginScopeParser (lives on the NLogLoggerProvider) for all NLogLogger-objects.

Includes a small performance boost in handling of log-message with no message-properties, by skipping allocation of message-property parser.

Includes a new IncludeScopes option (similar to the one for the Microsoft ConsoleLogger), that allows one to disable the overhead of the BeginScope handling (Skips parsing state and maintaining NDLC + MDLC)

Includes a small performance boost when using CaptureMessageProperties = true, but with CaptureMessageTemplates = false. Then it skips extra parsing of message properties to see if making use of message-template-syntax (or positional format args)

Improves the handling of BeginScope("Hello {world}", "Earth") so it only includes the actually property (and not the original beginscope-message-template).

Improves the behavior of BeginScope so the returned IDisposable has ToString() that returns input-state ToString().

[codecov]

Codecov Report

Merging #232 into master will increase coverage by 0.43%.
The diff coverage is 69.47%.

@@            Coverage Diff             @@
##           master     #232      +/-   ##
==========================================
+ Coverage   71.39%   71.82%   +0.43%     
==========================================
  Files           6        7       +1     
  Lines         374      433      +59     
  Branches       88      106      +18     
==========================================
+ Hits          267      311      +44     
- Misses         72       80       +8     
- Partials       35       42       +7

Impacted Files	Coverage Δ
...og.Extensions.Logging/Logging/NLogLoggerFactory.cs	0% <ø> (ø)	⬆️
...g.Extensions.Logging/Logging/NLogLoggerProvider.cs	82.5% <33.33%> (-11.79%)	⬇️
...tensions.Logging/Extensions/ConfigureExtensions.cs	18.18% <50%> (-8.49%)	⬇️
....Extensions.Logging/Logging/NLogProviderOptions.cs	93.33% <66.66%> (+1.02%)	⬆️
...Extensions.Logging/Logging/NLogBeginScopeParser.cs	67% <67%> (ø)
...nsions.Logging/Logging/NLogMessageParameterList.cs	73.49% <75%> (+0.89%)	⬆️
src/NLog.Extensions.Logging/Logging/NLogLogger.cs	77.45% <76.11%> (+4.76%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7c08a84...c2c50c9. Read the comment docs.

[snakefoot]

Simple test with the following code (Pure NetCore-console, no Asp.Net.Core)

static readonly _messageDefine = LoggerMessage.Define<int, int>(LogLevel.Information, default(EventId), "Log message {number} / {total}");
using (_logger.BeginScope("Hello {World}", "Earth"))
{
   _messageDefine(_logger, id, totalCount, null);
}

Logger Name	Messages	Size	Args	Threads	Loggers
Default Layout	5.000.000	12	2	2	1

Test Name	Msgs/sec	CPU (ms)	Alloc (MB)
This PR IncludeScopes=false + CaptureMessageTemplates=false	393944	21,6	4.616,1
This PR IncludeScopes=false	383808	24,1	4.780,9
This PR IncludeScopes=true	358684	26,5	8.575,6
Master	309062	31,5	11.556,1
Serilog 2.7.1	185459	50,7	20.889

[304NotModified]

@snakefoot could you please check the better code hub results? (don;t know if you could reed the results, here as image:)

Thanks!

[304NotModified]

(please check better code hub)

[snakefoot]

@304NotModified Think you need to post some more screenshots. Or commit some changes to this PR that fixes the "problems".

[304NotModified]

only "NLogLogger.CreateLogEventInfo" needs to be fixed, it has 11 branch points, and the it should be <10.

So we need a helper method for that

[snakefoot]

You are very welcome implement such a method. Think the code is very compact already. More nesting will hide what is going on

[304NotModified]

You are very welcome implement such a method.

I can't push on your master AFAIK. (it works on other branches)

[304NotModified]

! [remote rejected] snakefoot-master -> snakefoot-master (permission denied)
error: failed to push some refs to 'https://github.com/snakefoot/NLog.Extensions.Logging.git'

I think your master is protected. Any way, will make a PR then

[304NotModified]

-- > snakefoot#5

[snakefoot]

@304NotModified Have now tried to reduce the complexity even further. But still it complains. Where is the pain?

[304NotModified]

in at least TryParseMessageTemplate, see snakefoot#6

[304NotModified]

I think we have to move some code in the future, e.g. to c# extensions

I like refactoring, so I have no problem is doing that

[304NotModified]

but you can't check the report at all? That's strange.

[304NotModified]

🥇

[304NotModified]

merged, thanks also for refactoring!

[snakefoot]

Found some stuff to cleanup: #233