Skip to content

Added EventId to LoggerProviderCollectionSink #189

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

Merged
merged 1 commit into from
May 17, 2021
Merged
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
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
// limitations under the License.

using System;
using Microsoft.Extensions.Logging;
using Serilog.Core;
using Serilog.Events;

Expand All @@ -30,13 +31,26 @@ public LoggerProviderCollectionSink(LoggerProviderCollection providers)
public void Emit(LogEvent logEvent)
{
string categoryName = null;
EventId eventId = default;

if (logEvent.Properties.TryGetValue("SourceContext", out var sourceContextProperty) &&
sourceContextProperty is ScalarValue sourceContextValue &&
sourceContextValue.Value is string sourceContext)
{
categoryName = sourceContext;
}
if (logEvent.Properties.TryGetValue("EventId", out var eventIdPropertyValue) && eventIdPropertyValue is StructureValue structuredEventId)
{
string name = null;
var id = 0;
foreach (var item in structuredEventId.Properties)
{
if (item.Name == "Id" && item.Value is ScalarValue sv && sv.Value is int i) id = i;
if (item.Name == "Name" && item.Value is ScalarValue sv2 && sv2.Value is string s) name = s;
}

eventId = new EventId(id, name);
}

var level = LevelConvert.ToExtensionsLevel(logEvent.Level);
var slv = new SerilogLogValues(logEvent.MessageTemplate, logEvent.Properties);
Expand All @@ -47,7 +61,7 @@ sourceContextProperty is ScalarValue sourceContextValue &&

logger.Log(
level,
default,
eventId,
slv,
logEvent.Exception,
(s, e) => s.ToString());
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.

using System;
using Microsoft.Extensions.Logging;
using Serilog.Extensions.Logging.Tests.Support;
using Xunit;

namespace Serilog.Extensions.Logging.Tests
{
public class LoggerProviderCollectionSinkTests
{
const string Name = "test";
const string TestMessage = "This is a test";

static Tuple<SerilogLogger, ExtensionsProvider> SetUp(LogLevel logLevel)
{
var providers = new LoggerProviderCollection();
var provider = new ExtensionsProvider(logLevel);
providers.AddProvider(provider);
var serilogLogger = new LoggerConfiguration()
.WriteTo.Providers(providers)
.MinimumLevel.Is(LevelConvert.ToSerilogLevel(logLevel))
.CreateLogger();

var logger = (SerilogLogger)new SerilogLoggerProvider(serilogLogger).CreateLogger(Name);

return new Tuple<SerilogLogger, ExtensionsProvider>(logger, provider);
}

[Fact]
public void LogsCorrectLevel()
{
var (logger, sink) = SetUp(LogLevel.Trace);

logger.Log(LogLevel.Trace, 0, TestMessage, null, null);
logger.Log(LogLevel.Debug, 0, TestMessage, null, null);
logger.Log(LogLevel.Information, 0, TestMessage, null, null);
logger.Log(LogLevel.Warning, 0, TestMessage, null, null);
logger.Log(LogLevel.Error, 0, TestMessage, null, null);
logger.Log(LogLevel.Critical, 0, TestMessage, null, null);

Assert.Equal(6, sink.Writes.Count);
Assert.Equal(LogLevel.Trace, sink.Writes[0].logLevel);
Assert.Equal(LogLevel.Debug, sink.Writes[1].logLevel);
Assert.Equal(LogLevel.Information, sink.Writes[2].logLevel);
Assert.Equal(LogLevel.Warning, sink.Writes[3].logLevel);
Assert.Equal(LogLevel.Error, sink.Writes[4].logLevel);
Assert.Equal(LogLevel.Critical, sink.Writes[5].logLevel);
}

[Fact]
public void LogsCorrectEventId()
{
var (logger, sink) = SetUp(LogLevel.Trace);

logger.Log(LogLevel.Trace, new EventId(1, nameof(LogLevel.Trace)), TestMessage, null, null);
logger.Log(LogLevel.Debug, new EventId(2, nameof(LogLevel.Debug)), TestMessage, null, null);
logger.Log(LogLevel.Information, new EventId(3, nameof(LogLevel.Information)), TestMessage, null, null);
logger.Log(LogLevel.Warning, new EventId(4, nameof(LogLevel.Warning)), TestMessage, null, null);
logger.Log(LogLevel.Error, new EventId(5, nameof(LogLevel.Error)), TestMessage, null, null);
logger.Log(LogLevel.Critical, new EventId(6, nameof(LogLevel.Critical)), TestMessage, null, null);

Assert.Equal(6, sink.Writes.Count);

Assert.Equal(1, sink.Writes[0].eventId.Id);
Assert.Equal(nameof(LogLevel.Trace), sink.Writes[0].eventId.Name);

Assert.Equal(2, sink.Writes[1].eventId.Id);
Assert.Equal(nameof(LogLevel.Debug), sink.Writes[1].eventId.Name);

Assert.Equal(3, sink.Writes[2].eventId.Id);
Assert.Equal(nameof(LogLevel.Information), sink.Writes[2].eventId.Name);

Assert.Equal(4, sink.Writes[3].eventId.Id);
Assert.Equal(nameof(LogLevel.Warning), sink.Writes[3].eventId.Name);

Assert.Equal(5, sink.Writes[4].eventId.Id);
Assert.Equal(nameof(LogLevel.Error), sink.Writes[4].eventId.Name);

Assert.Equal(6, sink.Writes[5].eventId.Id);
Assert.Equal(nameof(LogLevel.Critical), sink.Writes[5].eventId.Name);
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.

using System;
using System.Collections.Generic;
using Microsoft.Extensions.Logging;
using Serilog.Events;

namespace Serilog.Extensions.Logging.Tests.Support
{
public class ExtensionsProvider : ILoggerProvider, Microsoft.Extensions.Logging.ILogger
{
private readonly LogLevel enabledLevel;
public List<(LogLevel logLevel, EventId eventId, object state, Exception exception, string message)> Writes { get; set; } = new List<(LogLevel logLevel, EventId eventId, object state, Exception exception, string message)>();

public ExtensionsProvider(LogLevel enabledLevel)
{
this.enabledLevel = enabledLevel;
}

public Microsoft.Extensions.Logging.ILogger CreateLogger(string categoryName)
{
return this;
}

public IDisposable BeginScope<TState>(TState state)
{
return this;
}

public bool IsEnabled(LogLevel logLevel)
{
return enabledLevel <= logLevel;
}

public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter)
{
Writes.Add((logLevel, eventId, state, exception, formatter(state, exception)));
}

public void Dispose()
{
}
}
}