Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Logging Rule with FinalMinLevel also supports dynamic filters #5489

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
snakefoot merged 1 commit into from
Mar 29, 2024
Merged

Logging Rule with FinalMinLevel also supports dynamic filters #5489

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
55 changes: 54 additions & 1 deletion 55 src/NLog/Internal/TargetWithFilterChain.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ static internal TargetWithFilterChain[] BuildLoggerConfiguration(string loggerNa

static private bool GetTargetsByLevelForLogger(string name, List<LoggingRule> loggingRules, LogLevel globalLogLevel, TargetWithFilterChain[] targetsByLevel, TargetWithFilterChain[] lastTargetsByLevel, bool[] suppressedLevels)
{
IList<KeyValuePair<FilterResult?, IList<Filter>>> finalMinLevelWithFilters = null;
bool targetsFound = false;
foreach (LoggingRule rule in loggingRules)
{
Expand All @@ -140,6 +141,11 @@ static private bool GetTargetsByLevelForLogger(string name, List<LoggingRule> lo
continue;
}

if (LoggingRuleHasFinalMinLevelFilters(rule))
{
CollectFinalMinLevelFiltersFromRule(rule, ref finalMinLevelWithFilters);
}

targetsFound = AddTargetsFromLoggingRule(rule, name, globalLogLevel, targetsByLevel, lastTargetsByLevel, suppressedLevels) || targetsFound;

// Recursively analyze the child rules.
Expand All @@ -152,12 +158,59 @@ static private bool GetTargetsByLevelForLogger(string name, List<LoggingRule> lo
for (int i = 0; i <= LogLevel.MaxLevel.Ordinal; ++i)
{
TargetWithFilterChain tfc = targetsByLevel[i];
tfc?.PrecalculateStackTraceUsage();
if (tfc is null)
continue;

if (finalMinLevelWithFilters?.Count > 0)
{
var finalMinLevelFilters = finalMinLevelWithFilters[i];
if (finalMinLevelFilters.Value?.Count > 0)
{
targetsByLevel[i] = tfc = AppendFinalMinLevelFilters(tfc, finalMinLevelFilters.Value, finalMinLevelFilters.Key.Value);
}
}

tfc.PrecalculateStackTraceUsage();
}

return targetsFound;
}

private static bool LoggingRuleHasFinalMinLevelFilters(LoggingRule rule)
{
return LogLevel.Off != rule.FinalMinLevel && rule.Filters.Count != 0 && rule.Targets.Count == 0;
}

private static void CollectFinalMinLevelFiltersFromRule(LoggingRule rule, ref IList<KeyValuePair<FilterResult?, IList<Filter>>> finalMinLevelWithFilters)
{
finalMinLevelWithFilters = finalMinLevelWithFilters ?? new KeyValuePair<FilterResult?, IList<Filter>>[LogLevel.MaxLevel.Ordinal + 1];
for (int i = 0; i <= LogLevel.MaxLevel.Ordinal; ++i)
{
if (i < rule.FinalMinLevel.Ordinal)

@BooTeK BooTeK Apr 30, 2024

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

In other places in the codebase FinalMinLevel is either guarded for null or there are prevention to set it to null but it's default appears to be null. When testing 5.3.1 in our codebase (to update) we encountered a rule with a FinalMinLevel unset (null) that causes a null reference to be thrown here.

@snakefoot snakefoot Apr 30, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thank you for reporting this. I have been able to reproduce the NullReferenceException by creating a LoggingRule with filters but without targets. Will try get a fix out ASAP.

@snakefoot snakefoot Apr 30, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@BooTeK NLog v5.3.2 has now been released - https://www.nuget.org/packages/NLog/5.3.2

continue;

if (finalMinLevelWithFilters[i].Key.HasValue && finalMinLevelWithFilters[i].Key.Value != rule.FilterDefaultAction)
continue;

var newFilterResult = finalMinLevelWithFilters[i].Key ?? rule.FilterDefaultAction;
var newFilterChain = finalMinLevelWithFilters[i].Value?.Count > 0 ? System.Linq.Enumerable.ToArray(System.Linq.Enumerable.Concat(finalMinLevelWithFilters[i].Value, rule.Filters)) : rule.Filters;
finalMinLevelWithFilters[i] = new KeyValuePair<FilterResult?, IList<Filter>>(newFilterResult, newFilterChain);
}
}

private static TargetWithFilterChain AppendFinalMinLevelFilters(TargetWithFilterChain targetsByLevel, IList<Filter> finalMinLevelFilters, FilterResult finalMinLevelDefaultResult)
{
if (targetsByLevel.FilterChain?.Count > 0 && targetsByLevel.FilterDefaultAction != finalMinLevelDefaultResult)
return targetsByLevel;

var newFilterChain = targetsByLevel.FilterChain?.Count > 0 ? System.Linq.Enumerable.ToArray(System.Linq.Enumerable.Concat(finalMinLevelFilters, targetsByLevel.FilterChain)) : finalMinLevelFilters;
var newTargetsByLevel = new TargetWithFilterChain(targetsByLevel.Target, newFilterChain, finalMinLevelDefaultResult);

var nextInChain = targetsByLevel.NextInChain is null ? null : AppendFinalMinLevelFilters(targetsByLevel.NextInChain, finalMinLevelFilters, finalMinLevelDefaultResult);
newTargetsByLevel.NextInChain = nextInChain ?? targetsByLevel.NextInChain;
return newTargetsByLevel;
}

private static bool AddTargetsFromLoggingRule(LoggingRule rule, string loggerName, LogLevel globalLogLevel, TargetWithFilterChain[] targetsByLevel, TargetWithFilterChain[] lastTargetsByLevel, bool[] suppressedLevels)
{
bool targetsFound = false;
Expand Down
38 changes: 38 additions & 0 deletions 38 tests/NLog.UnitTests/Config/RuleConfigurationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,44 @@ public void FinalMinLevelTest()
logFactory.AssertDebugLastMessage("requestTarget", "Request-Good Noise");
}

[Fact]
public void FinalMinLevelFilterTest()
{
var logFactory = new LogFactory().Setup().LoadConfigurationFromXml(@"
<nlog>
<targets>
<target name='defaultTarget' type='Debug' layout='${message}' />
<target name='requestTarget' type='Debug' layout='Request-${message}' />
</targets>

<rules>
<logger name='*' finalMinLevel='Info' />
<logger name='Microsoft*' finalMinLevel='Warn' />
<logger name='Microsoft.Hosting.Lifetime*' finalMinLevel='Info' />
<logger name='System*' finalMinLevel='Warn' />

<logger name='RequestLogger' finalMinLevel='Error'>
<filters defaultAction='Log'>
<when condition='exception == null' action='IgnoreFinal' />
</filters>
</logger>

<logger writeTo='defaultTarget, requestTarget' />
</rules>
</nlog>").LogFactory;

var requestLogger = logFactory.GetLogger("RequestLogger");
requestLogger.Error(new System.Exception("Oops"), "ERROR EXCEPTION");
logFactory.AssertDebugLastMessage("defaultTarget", "ERROR EXCEPTION");
logFactory.AssertDebugLastMessage("requestTarget", "Request-ERROR EXCEPTION");
requestLogger.Info(new System.Exception("Oops"), "INFO EXCEPTION");
logFactory.AssertDebugLastMessage("defaultTarget", "ERROR EXCEPTION");
logFactory.AssertDebugLastMessage("requestTarget", "Request-ERROR EXCEPTION");
requestLogger.Error("ERROR NO EXCEPTION");
logFactory.AssertDebugLastMessage("defaultTarget", "ERROR EXCEPTION");
logFactory.AssertDebugLastMessage("requestTarget", "Request-ERROR EXCEPTION");
}

[Fact]
public void NoLevelsTest()
{
Expand Down
Morty Proxy This is a proxified and sanitized view of the page, visit original site.