How to remove properties from log entries in ASP.Net Core

Question

I'm using Serilog with ASP.Net Core 2.0, writing to RollingFile using JsonFormatter.
Followed the instructions here to configure: https://github.com/serilog/serilog-aspnetcore.
Everything works great, but in every log entry I get the following properties that I did not log:

SourceContext
RequestId
RequestPath

I presume they are being added by the ASP.Net Core logging framework. How can I get rid of them?

Nicholas Blumhardt · Accepted Answer · 2017-11-08 23:30:30Z

30

This can be achieved by plugging an enricher into the logging pipeline:

.Enrich.With(new RemovePropertiesEnricher())

Where:

class RemovePropertiesEnricher : ILogEventEnricher
{
    public void Enrich(LogEvent le, ILogEventPropertyFactory lepf)
    {
        le.RemovePropertyIfPresent("SourceContext");
        le.RemovePropertyIfPresent("RequestId");
        le.RemovePropertyIfPresent("RequestPath");
    }
}

answered Nov 8, 2017 at 23:30

Nicholas Blumhardt

32.3k5 gold badges101 silver badges105 bronze badges

Sign up to request clarification or add additional context in comments.

6 Comments

Justin Over a year ago

@NicholasBlumhardt Not to hijack the post, but what and why are these injected automatically?

Saint Domino Over a year ago

I had this very same question. Somewhere early in the request pipeline, a HostingLogScope is created. As you can see from the source, this log scope is responsible for adding (most) of the offending properties. I'm missing a link for where it exactly happens, but Serilog then takes this context object and turns it into the properties of a log entry. Since the context is a IReadOnlyList<KeyValuePair<string,object>>, it maps naturally

Junaid Over a year ago

This doesn't work with the "Exception" field.

Junaid Over a year ago

Great answer. Is there a way to remove the sub-property (a property of property) as well?

RouR Over a year ago

Does it work for nested fields? I think, no

|

VivekDev · Accepted Answer · 2019-02-13 08:00:35Z

5

When you are logging an object, Serilog has the concept of destructuring.

And if you want to remove(ignore) some properties in those objects for logging, there are two options.

You can use attributes. Take a look at this post.
Then there is by-ignoring. You need this Destructurama.ByIgnoring nuget.

Note you should not use both. Using both did not work for me.

answered Feb 13, 2019 at 8:00

VivekDev

26.1k33 gold badges168 silver badges233 bronze badges

Comments

Leonid · Accepted Answer · 2017-11-08 10:27:59Z

2

Yes, you can get rid of them. Try to use log template:

_loggerConfiguration.WriteTo.Console(LogLevel.Debug, "{Timestamp:yyyy-MM-dd HH:mm:ss.fff} [{Level}] {Message}{NewLine}{Exception}");

In this scenario, you won't see mentioned properties in your output.

answered Nov 8, 2017 at 10:27

Leonid

1,1112 gold badges17 silver badges27 bronze badges

2 Comments

Andrew Over a year ago

Thanks Leonid, my logging to console works fine. Because like in your example I have a message template there that does not contain these parameters. How to I get rid of them when logging to file: .WriteTo.RollingFile(new JsonFormatter(), logFilePath, LogEventLevel.Information)? I do not want to provide a template here, just want to log raw json.

Leonid Over a year ago

Currently, this feature is not supported (I checked the source code). I see a workaround, you can use kind of template that forms JSON file. Or you can implement this feature and create a pull request to their repository.

Collectives™ on Stack Overflow

How to remove properties from log entries in ASP.Net Core

3 Answers 3

6 Comments

Comments

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

6 Comments

Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related