Skip to content

Include original message template when capture without boxing #794

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.

Sign up for GitHub

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
Jun 8, 2025
Merged

Include original message template when capture without boxing #794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 21 additions & 21 deletions src/NLog.Extensions.Logging/Logging/NLogLogger.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,17 +87,17 @@ public void Log<TState>(Microsoft.Extensions.Logging.LogLevel logLevel, EventId
if ("0".Equals(arg1.Name))
return CreateLogEventWithoutParameters(nLogLogLevel, eventId, captureEventId, formattedMessage);

var originalMessage = ((IReadOnlyList<KeyValuePair<string, object?>>)state)[1].Value?.ToString() ?? formattedMessage;

if (captureEventId)
{
var eventIdParameterCount = GetEventIdMessageParameters(eventId, out var eventIdArg1, out var eventIdArg2);
if (eventIdParameterCount == 0)
return new LogEventInfo(nLogLogLevel, _logger.Name, formattedMessage);
else if (eventIdParameterCount == 1)
return new LogEventInfo(nLogLogLevel, _logger.Name, formattedMessage, formattedMessage, [arg1, eventIdArg1]);
else
return new LogEventInfo(nLogLogLevel, _logger.Name, formattedMessage, formattedMessage, [arg1, eventIdArg1, eventIdArg2]);
if (eventIdParameterCount == 1)
return new LogEventInfo(nLogLogLevel, _logger.Name, formattedMessage, originalMessage, [arg1, eventIdArg1]);
else if (eventIdParameterCount != 0)
return new LogEventInfo(nLogLogLevel, _logger.Name, formattedMessage, originalMessage, [arg1, eventIdArg1, eventIdArg2]);
}
return new LogEventInfo(nLogLogLevel, _logger.Name, formattedMessage, [arg1]);
return new LogEventInfo(nLogLogLevel, _logger.Name, formattedMessage, originalMessage, [arg1]);
}
}
break;
Expand All @@ -113,17 +113,17 @@ public void Log<TState>(Microsoft.Extensions.Logging.LogLevel logLevel, EventId
if ("0".Equals(arg1.Name) && "1".Equals(arg2.Name))
return CreateLogEventWithoutParameters(nLogLogLevel, eventId, captureEventId, formattedMessage);

var originalMessage = ((IReadOnlyList<KeyValuePair<string, object?>>)state)[2].Value?.ToString() ?? formattedMessage;

if (captureEventId)
{
var eventIdParameterCount = GetEventIdMessageParameters(eventId, out var eventIdArg1, out var eventIdArg2);
if (eventIdParameterCount == 0)
return new LogEventInfo(nLogLogLevel, _logger.Name, formattedMessage);
else if (eventIdParameterCount == 1)
return new LogEventInfo(nLogLogLevel, _logger.Name, formattedMessage, formattedMessage, [arg1, arg2, eventIdArg1]);
else
return new LogEventInfo(nLogLogLevel, _logger.Name, formattedMessage, formattedMessage, [arg1, arg2, eventIdArg1, eventIdArg2]);
if (eventIdParameterCount == 1)
return new LogEventInfo(nLogLogLevel, _logger.Name, formattedMessage, originalMessage, [arg1, arg2, eventIdArg1]);
else if (eventIdParameterCount != 0)
return new LogEventInfo(nLogLogLevel, _logger.Name, formattedMessage, originalMessage, [arg1, arg2, eventIdArg1, eventIdArg2]);
}
return new LogEventInfo(nLogLogLevel, _logger.Name, formattedMessage, [arg1, arg2]);
return new LogEventInfo(nLogLogLevel, _logger.Name, formattedMessage, originalMessage, [arg1, arg2]);
}
}
break;
Expand All @@ -141,17 +141,17 @@ public void Log<TState>(Microsoft.Extensions.Logging.LogLevel logLevel, EventId
if ("0".Equals(arg1.Name) && "1".Equals(arg2.Name) && "2".Equals(arg3.Name))
return CreateLogEventWithoutParameters(nLogLogLevel, eventId, captureEventId, formattedMessage);

var originalMessage = ((IReadOnlyList<KeyValuePair<string, object?>>)state)[3].Value?.ToString() ?? formattedMessage;

if (captureEventId)
{
var eventIdParameterCount = GetEventIdMessageParameters(eventId, out var eventIdArg1, out var eventIdArg2);
if (eventIdParameterCount == 0)
return new LogEventInfo(nLogLogLevel, _logger.Name, formattedMessage);
else if (eventIdParameterCount == 1)
return new LogEventInfo(nLogLogLevel, _logger.Name, formattedMessage, formattedMessage, [arg1, arg2, arg3, eventIdArg1]);
else
return new LogEventInfo(nLogLogLevel, _logger.Name, formattedMessage, formattedMessage, [arg1, arg2, arg3, eventIdArg1, eventIdArg2]);
if (eventIdParameterCount == 1)
return new LogEventInfo(nLogLogLevel, _logger.Name, formattedMessage, originalMessage, [arg1, arg2, arg3, eventIdArg1]);
else if (eventIdParameterCount != 0)
return new LogEventInfo(nLogLogLevel, _logger.Name, formattedMessage, originalMessage, [arg1, arg2, arg3, eventIdArg1, eventIdArg2]);
}
return new LogEventInfo(nLogLogLevel, _logger.Name, formattedMessage, [arg1, arg2, arg3]);
return new LogEventInfo(nLogLogLevel, _logger.Name, formattedMessage, originalMessage, [arg1, arg2, arg3]);
}
}
break;
Expand Down
21 changes: 15 additions & 6 deletions test/NLog.Extensions.Logging.Tests/LoggerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,20 +350,29 @@ public void TestPositionalCaptureMessageParameters()
Assert.Equal("S", messageParameters[1].Format);
}

[Fact]
public void TestParseMessageTemplates()
[Theory]
[InlineData(true)]
[InlineData(false)]
public void TestParseMessageTemplates(bool parseMessageTemplates)
{
LogEventInfo logEvent = null;
var debugTarget = new MethodCallTarget("output", (l, args) => logEvent = l);
var runner = GetRunner<Runner>(new NLogProviderOptions() { ParseMessageTemplates = true }, debugTarget);
var runner = GetRunner<Runner>(new NLogProviderOptions() { ParseMessageTemplates = parseMessageTemplates }, debugTarget);
var messageTemplate = "message with {ParameterCount} parameters";
runner.Logger.LogDebug(messageTemplate, "1");

Assert.NotNull(logEvent);
Assert.Equal(messageTemplate, logEvent.Message);
Assert.NotNull(logEvent.Parameters);
Assert.Single(logEvent.Parameters);
Assert.Equal("1", logEvent.Parameters[0]);
if (parseMessageTemplates)
{
Assert.NotNull(logEvent.Parameters);
Assert.Single(logEvent.Parameters);
Assert.Equal("1", logEvent.Parameters[0]);
}
else
{
Assert.Null(logEvent.Parameters);
}

var messageParameters = logEvent.MessageTemplateParameters;
Assert.False(messageParameters.IsPositional);
Expand Down