Enable LogContext for .Net Core. #648
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,9 +12,16 @@ | |
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
|
|
||
| #if LOGCONTEXT | ||
|
There was a problem hiding this comment. Sorry if this is a duplicate, I may have already asked - but are there any platforms on which There was a problem hiding this comment. I'm not entirely clear on what 5.1 is. I thought from standard platform that it was 4.5, but if I try to compile with either There was a problem hiding this comment. Ah, that's a shame. What do you think (+ @merbla @khellang) about using There are two benefits:
Worth a shot? There was a problem hiding this comment. This a site @khellang pointed me to. Not always 100% however a great start.
These would indicate There was a problem hiding this comment. @merbla thanks for the refs. The idea is not to use either of those, but something like: [ThreadStatic]
static ImmutableStack<ILogEventEnricher> Data;This should work on all platforms and does the job except for carrying state across async calls. |
||
| using System; | ||
| #if REMOTING | ||
| using System.Runtime.Remoting.Messaging; | ||
| #endif | ||
| #if ASYNCLOCAL | ||
| using System.Collections.Generic; | ||
| using System.Threading; | ||
| #endif | ||
| using Serilog.Core; | ||
| using Serilog.Core.Enrichers; | ||
| using Serilog.Events; | ||
|
|
@@ -42,19 +49,24 @@ namespace Serilog.Context | |
| /// </code> | ||
| /// </example> | ||
| /// <remarks>The scope of the context is the current logical thread, using | ||
| #if ASYNCLOCAL | ||
| /// <seealso cref="AsyncLocal{T}"/> | ||
| #else | ||
| /// <seealso cref="CallContext.LogicalGetData"/> | ||
| #endif | ||
| /// (and so is preserved across async/await calls).</remarks> | ||
| public static class LogContext | ||
| { | ||
| #if ASYNCLOCAL | ||
| static readonly AsyncLocal<ImmutableStack<ILogEventEnricher>> Data = new AsyncLocal<ImmutableStack<ILogEventEnricher>>(); | ||
| #else | ||
| #if DOTNET5_1 | ||
| [ThreadStatic] | ||
| static ImmutableStack<ILogEventEnricher> Data; | ||
| #else | ||
| static readonly string DataSlotName = typeof(LogContext).FullName; | ||
| #endif | ||
| #endif | ||
|
|
||
| /// <summary> | ||
| /// Push a property onto the context, returning an <see cref="IDisposable"/> | ||
|
|
@@ -132,33 +144,87 @@ static ImmutableStack<ILogEventEnricher> GetOrCreateEnricherStack() | |
| return enrichers; | ||
| } | ||
|
|
||
| #if ASYNCLOCAL | ||
| static ImmutableStack<ILogEventEnricher> Enrichers | ||
| { | ||
| get | ||
| { | ||
| return Data.Value; | ||
| } | ||
| set | ||
| { | ||
| Data.Value = GetContext(value); | ||
| } | ||
| } | ||
| #else | ||
|
|
||
| #if DOTNET5_1 | ||
| static ImmutableStack<ILogEventEnricher> Enrichers | ||
| { | ||
| get | ||
| { | ||
| return Data; | ||
| } | ||
| set | ||
| { | ||
| Data = GetContext(value); | ||
| } | ||
| } | ||
|
|
||
| #else | ||
| static ImmutableStack<ILogEventEnricher> Enrichers | ||
| { | ||
| get | ||
| { | ||
| var data = CallContext.LogicalGetData(DataSlotName); | ||
|
|
||
| ImmutableStack<ILogEventEnricher> context; | ||
| #if REMOTING | ||
| if (PermitCrossAppDomainCalls) | ||
|
There was a problem hiding this comment.
There was a problem hiding this comment. You mean the property itself, right? There was a problem hiding this comment. Yes, sorry about the vague comment 👍 There was a problem hiding this comment. Moved |
||
| { | ||
| context = ((Wrapper)data)?.Value; | ||
| } | ||
| else | ||
| { | ||
| context = (ImmutableStack<ILogEventEnricher>)data; | ||
| } | ||
| #else | ||
| context = data; | ||
| #endif | ||
| return context; | ||
| } | ||
| set | ||
| { | ||
| var context = GetContext(value); | ||
| CallContext.LogicalSetData(DataSlotName, context); | ||
| } | ||
| } | ||
| #endif | ||
| #endif | ||
|
|
||
| #if REMOTING | ||
| /// <summary> | ||
| /// When calling into appdomains without Serilog loaded, e.g. via remoting or during unit testing, | ||
| /// it may be necesary to set this value to true so that serialization exceptions are avoided. When possible, | ||
| /// using the <see cref="Suspend"/> method in a using block around the call has a lower overhead and | ||
| /// should be preferred. | ||
| /// </summary> | ||
| public static bool PermitCrossAppDomainCalls { get; set; } | ||
|
|
||
| static object GetContext(ImmutableStack<ILogEventEnricher> value) | ||
| { | ||
| var context = !PermitCrossAppDomainCalls ? (object) value : new Wrapper | ||
| { | ||
| Value = value | ||
| }; | ||
| return context; | ||
| } | ||
| #else | ||
| static ImmutableStack<ILogEventEnricher> GetContext(ImmutableStack<ILogEventEnricher> value) | ||
| { | ||
| return value; | ||
| } | ||
| #endif | ||
|
|
||
| internal static void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory) | ||
| { | ||
|
|
@@ -187,10 +253,13 @@ public void Dispose() | |
| } | ||
| } | ||
|
|
||
| #if REMOTING | ||
| sealed class Wrapper : MarshalByRefObject | ||
| { | ||
| public ImmutableStack<ILogEventEnricher> Value { get; set; } | ||
| } | ||
| #endif | ||
| } | ||
| } | ||
|
|
||
| #endif | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we now have dotnet5.1 TFM support, there's no need for
#if LOGCONTEXTanymore - that's all the target platforms covered (I hope :-)) - they should all supportLogContextnow in one form or another.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ha ha. You're right. I'll see how far I can get on my Mac tonight, otherwise it will be tomorrow morning. I've been meaning to see how the cross-platform bits are working.