-
Notifications
You must be signed in to change notification settings - Fork 796
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add an overload to LogContext.PushProperty to accept a Func<T> delegate. #1698
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 |
---|---|---|
@@ -0,0 +1,67 @@ | ||
// Copyright 2013-2015 Serilog Contributors | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
#nullable enable | ||
using System; | ||
using Serilog.Events; | ||
|
||
namespace Serilog.Core.Enrichers | ||
{ | ||
/// <summary> | ||
/// Adds a new property enricher to the log event. | ||
/// </summary> | ||
public class FunctionPropertyEnricher<T> : ILogEventEnricher | ||
{ | ||
readonly string _name; | ||
readonly Func<T> _value; | ||
readonly bool _destructureObjects; | ||
|
||
/// <summary> | ||
/// Create a new property enricher. | ||
/// </summary> | ||
/// <param name="name">The name of the property.</param> | ||
/// <param name="value">The delegate to the property.</param> | ||
/// <returns>A handle to later remove the property from the context.</returns> | ||
/// <param name="destructureObjects">If true, and the value is a non-primitive, non-array type, | ||
/// then the value will be converted to a structure; otherwise, unknown types will | ||
/// be converted to scalars, which are generally stored as strings.</param> | ||
/// <returns></returns> | ||
/// <exception cref="ArgumentNullException">When <paramref name="name"/> is <code>null</code></exception> | ||
/// <exception cref="ArgumentException">When <paramref name="name"/> is empty or only contains whitespace</exception> | ||
public FunctionPropertyEnricher(string name, Func<T> value, bool destructureObjects = false) | ||
{ | ||
LogEventProperty.EnsureValidName(name); | ||
|
||
_name = name; | ||
_value = value; | ||
_destructureObjects = destructureObjects; | ||
} | ||
|
||
/// <summary> | ||
/// Enrich the log event. | ||
/// </summary> | ||
/// <param name="logEvent">The log event to enrich.</param> | ||
/// <param name="propertyFactory">Factory for creating new properties to add to the event.</param> | ||
/// <exception cref="ArgumentNullException">When <paramref name="logEvent"/> is <code>null</code></exception> | ||
/// <exception cref="ArgumentNullException">When <paramref name="propertyFactory"/> is <code>null</code></exception> | ||
public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory) | ||
{ | ||
if (logEvent == null) throw new ArgumentNullException(nameof(logEvent)); | ||
if (propertyFactory == null) throw new ArgumentNullException(nameof(propertyFactory)); | ||
|
||
var property = propertyFactory.CreateProperty(_name, _value(), _destructureObjects); | ||
logEvent.AddPropertyIfAbsent(property); | ||
} | ||
} | ||
} |
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.
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.
Interesting you flagged this to remove as I took the PropertyEnricher.cs as the template to do this and that line is also in there. However this isn't getting merged anyway but you might want to double check this line to make sure it's right.
serilog/src/Serilog/Core/Enrichers/PropertyEnricher.cs
Line 35 in 81e9dee
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.
#1699