Skip to content
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
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions src/Serilog/Context/LogContext.cs
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,25 @@ public static IDisposable PushProperty(string name, object value, bool destructu
return Push(new PropertyEnricher(name, value, destructureObjects));
}

/// <summary>
/// Push a property onto the context using a delegate, returning an <see cref="IDisposable"/>
/// that must later be used to remove the property, along with any others that
/// may have been pushed on top of it and not yet popped. The property must
/// be popped from the same thread/logical call context.
/// </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>A token that must be disposed, in order, to pop properties back off the stack.</returns>
public static IDisposable PushProperty<T>(string name, Func<T> value, bool destructureObjects = false)
{
return Serilog.Context.LogContext.Push(new FunctionPropertyEnricher<T>(name, value, destructureObjects));
}


/// <summary>
/// Push an enricher onto the context, returning an <see cref="IDisposable"/>
/// that must later be used to remove the property, along with any others that
Expand Down
67 changes: 67 additions & 0 deletions src/Serilog/Core/Enrichers/FunctionPropertyEnricher.cs
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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// <returns>A handle to later remove the property from the context.</returns>

Copy link
Author

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.

/// <returns>A handle to later remove the property from the context.</returns>

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/// <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);
}
}
}