TargetWithContext - Easier to capture snapshot of MDLC and NDLC context

[snakefoot]

Attempt to resolve #2466 and #2465

Guess one could also extend it to enable capture of GDC and Callsite.

Maybe implement a helper method than returns all context properties (IncludeAllProperties, IncludeMdlc, IncludeMdc, IncludeGdc).

Suddenly also become a bugfix for correct precalculation of async data for custom NLog-Layouts. Before it would be impossible for custom NLog-Layouts to correctly capture the async-state. Resolves #254

And a bugfix that allows custom NLog-Layouts to work correctly, when they override Layout.Precalculate and are used with Target.OptimizeBufferReuse = true.

[codecov]

Codecov Report

❗ No coverage uploaded for pull request base (master@29704d6). Click here to learn what that means.
The diff coverage is 56%.

@@           Coverage Diff            @@
##             master   #2467   +/-   ##
========================================
  Coverage          ?     81%           
========================================
  Files             ?     325           
  Lines             ?   23908           
  Branches          ?    3020           
========================================
  Hits              ?   19380           
  Misses            ?    3713           
  Partials          ?     815

[snakefoot]

An alternative approach would be to implement a different async-target-wrapper using ThreadPool.QueueUserWorkItem (or Tasks). Then the async-state will automatically flow with the LogEventInfo (This will not help MDC + NDC but maybe they are also on their way out).

But such async-wrapper will not be able to perform batch-handling, so not that super interesting. And it would also require a new buffering-target-wrapper.

[snakefoot]

@304NotModified Implementing an easier approach for handling batching of log-events, became too messy.

But I like this direction for making it easier for custom targets to make use of MDLC and NDLC without forcing them to use JsonLayout.

[304NotModified]

But I like this direction for making it easier for custom targets to make use of MDLC and NDLC without forcing them to use JsonLayout.

Indeed, that would be a nice improvement!

Will try to review the PR this weekend.

[snakefoot]

Maybe consider to change the default value of the parameter IncludeMdlc = true.

[snakefoot]

@304NotModified Now removed the automatic forwarding of properties to the inner-layout, think it was more confusing than helping.

[304NotModified]

It code looks great!

I tried to implement my own target and tried to understand the properties/method. I proposed some small renames that make things easier (IMO).

[304NotModified]

proposal to rename (after renames below) -> ShouldIncludeProperties

I prefer removing the term "combined properties", if possible

[snakefoot]

Done

[304NotModified]

oops sorry for breaking the build

edit: can't see what's wrong. Works locally

[snakefoot]

edit: can't see what's wrong. Works locally

There is a conflict with my optimizations of the NetworkTarget and this PR. I have now merged with master, and resolved the conflict.

[304NotModified]

merged :)