Added WithProperty and SetProperty on Logger

[snakefoot]

Logger - WithProperty for adding Logger specific properties that are included for all LogEvents

Different attempt of implementing #2496

Still trying to resolve #528

---

This change is 

[codecov-io]

Codecov Report

Merging #3298 into dev will increase coverage by <1%.
The diff coverage is 85%.

@@          Coverage Diff           @@
##             dev   #3298    +/-   ##
======================================
+ Coverage     80%     80%   +<1%     
======================================
  Files        356     356            
  Lines      28077   28123    +46     
  Branches    3739    3753    +14     
======================================
+ Hits       22485   22551    +66     
+ Misses      4488    4481     -7     
+ Partials    1104    1091    -13

[304NotModified]

Thanks for the PR,

but i'm afraid it won't change the NLog API viewpoint, mentioned in #2496 (comment)?

[snakefoot]

The Logger currently has name that matches the context it represents. For every context you create a new logger. This PR allows you to inject more detail into the context that the Logger represents (besides its name). I don't like global context properties that affects all users of the same logger. Kind of ruins the idea of context.

[304NotModified]

If we also add SetProperty, next to WithProperty, do you think that is OK? (from viewpoint API design)

[snakefoot]

@304NotModified Added a SetProperty method for updating the current Logger object-instance.

[304NotModified]

Cool!

[304NotModified]

Need to check it in depth, but I think I will merge it soon :)

[304NotModified]

Thanks!

Is this safe for 4.6.3?

[304NotModified]

is this a performance tweak?

[snakefoot]

Think it is safe for NLog 4.6.3 Not sure what you are referring to regarding "performance tweak"

[304NotModified]

Docs added here: https://github.com/NLog/NLog/wiki/EventProperties-Layout-Renderer

[snakefoot]

Updated the docs a little so the difference between WithProperty and SetProperty is clearer. Making the trap-door hidden in SetProperty a little more visible.

[304NotModified]

It's not a trap but a feature :)

[304NotModified]

Updated it with a 2nd log. The set is really useful is some cases (e.g when you get more context along the way)

[snakefoot]

The set is really useful is some cases (e.g when you get more context along the way)

Not when having the global NLog Logger-cache where multiple locations are referencing the same Logger-object, and then one location suddenly decides to call SetProperty (can become a surprise for everyone else)

[304NotModified]

It's not suddenly? It's by (logger) name.

[304NotModified]

Buy anyway, I'm curious when we will implement WithProperties and ClearProperty :p

(Maybe nice with default interfaces - c# 8)

[snakefoot]

It's not suddenly? It's by (logger) name.

Not sure I understand. There is no guarantee that two isolated locations doesn't call GetLogger() with the same name. When one of the isolated locations calls SetProperty then it will affect the other.

Could also be two threads allocating their isolated controller of the same class, then the two controller-classes will be sharing the same Logger-object (Independent of using static Logger-variable, but just because it calls GetCurrentClassLogger). When one thread starts to call SetProperty then it will affect the Logger on the other controller-instance.

That is why I prefer WithProperty because it doesn't give you surprises.