Skip to content

fix(logging): POWERTOOLS_LOG_LEVEL=Trace/Debug no longer ignored #1213

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

Open
hjgraca wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

fix(logging): POWERTOOLS_LOG_LEVEL=Trace/Debug no longer ignored #1213

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
7 changes: 7 additions & 0 deletions libraries/src/AWS.Lambda.Powertools.Logging/Internal/Helpers/LoggerFactoryHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,13 @@ internal static ILoggerFactory CreateAndConfigureFactory(PowertoolsLoggerConfigu
builder.AddFilter(null, configuration.MinimumLogLevel);
builder.SetMinimumLevel(configuration.MinimumLogLevel);
}
else
{
// No explicit level configured — let everything through the factory
// so the provider can filter based on POWERTOOLS_LOG_LEVEL env var
builder.AddFilter(null, LogLevel.Trace);
builder.SetMinimumLevel(LogLevel.Trace);
}
});

LoggerFactoryHolder.SetFactory(factory);
Expand Down
5 changes: 4 additions & 1 deletion libraries/src/AWS.Lambda.Powertools.Logging/PowertoolsLoggingBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,10 @@ public static ILoggingBuilder AddPowertoolsLogger(
builder.Services.TryAddSingleton<ILogger>(provider =>
provider.GetRequiredService<ILoggerFactory>().CreatePowertoolsLogger());

// Default the factory minimum to Trace so the framework doesn't filter
// before our provider. The provider handles env-var-derived level filtering.
builder.SetMinimumLevel(LogLevel.Trace);

builder.Services.TryAddEnumerable(
ServiceDescriptor.Singleton<ILoggerProvider, PowertoolsLoggerProvider>(provider =>
{
Expand Down Expand Up @@ -174,7 +178,6 @@ public static ILoggingBuilder AddPowertoolsLogger(
var options = new PowertoolsLoggerConfiguration();
configure(options);

// IMPORTANT: Set the minimum level directly on the builder
if (options.MinimumLogLevel != LogLevel.None)
{
builder.SetMinimumLevel(options.MinimumLogLevel);
Expand Down
38 changes: 38 additions & 0 deletions libraries/tests/AWS.Lambda.Powertools.Logging.Tests/Attributes/LoggingAttributeTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -727,6 +727,44 @@ public void LoggingAspect_ShouldImmediatelyApplyFilterLevelChanges()
s.Contains("\"message\":\"This should NOT be logged\"")));
}

[Theory]
// Reproduces issue #1205 test matrix
[InlineData(null, "information,warning,error,critical", "trace,debug")]
[InlineData("Trace", "trace,debug,information,warning,error,critical", "")]
[InlineData("Debug", "debug,information,warning,error,critical", "trace")]
[InlineData("Information", "information,warning,error,critical", "trace,debug")]
[InlineData("Warning", "warning,error,critical", "trace,debug,information")]
[InlineData("Error", "error,critical", "trace,debug,information,warning")]
[InlineData("Critical", "critical", "trace,debug,information,warning,error")]
public void LoggingAttribute_ShouldRespectEnvVarLogLevel(string envLogLevel, string expectedCsv, string missingCsv)
{
// Reproduces issue #1205: POWERTOOLS_LOG_LEVEL=Trace/Debug ignored when using [Logging] attribute
Environment.SetEnvironmentVariable("POWERTOOLS_LOG_LEVEL", envLogLevel);

var consoleOut = new TestLoggerOutput();
Logger.Configure(options =>
{
options.LogOutput = consoleOut;
});

_testHandlers.TestMethodAllLevels();

var logOutput = consoleOut.ToString();

foreach (var level in expectedCsv.Split(','))
{
Assert.Contains($"LEVELTEST {level}", logOutput);
}

if (!string.IsNullOrEmpty(missingCsv))
{
foreach (var level in missingCsv.Split(','))
{
Assert.DoesNotContain($"LEVELTEST {level}", logOutput);
}
}
}

public void Dispose()
{
ResetAllState();
Expand Down
92 changes: 92 additions & 0 deletions libraries/tests/AWS.Lambda.Powertools.Logging.Tests/Handlers/HandlerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -517,6 +517,98 @@ public void EnvironmentVariableSampling_HandlerWithFullSampling_ShouldAlwaysElev
}
}

[Theory]
[InlineData("Trace", "LEVELTEST trace", true)]
[InlineData("Trace", "LEVELTEST debug", true)]
[InlineData("Trace", "LEVELTEST information", true)]
[InlineData("Debug", "LEVELTEST debug", true)]
[InlineData("Debug", "LEVELTEST information", true)]
[InlineData("Debug", "LEVELTEST trace", false)]
[InlineData("Information", "LEVELTEST trace", false)]
[InlineData("Information", "LEVELTEST debug", false)]
[InlineData("Information", "LEVELTEST information", true)]
public void PowertoolsLogLevel_EnvVar_ShouldFilterCorrectly(string envLogLevel, string expectedMessage, bool shouldAppear)
{
var originalLogLevel = Environment.GetEnvironmentVariable("POWERTOOLS_LOG_LEVEL");

try
{
Environment.SetEnvironmentVariable("POWERTOOLS_LOG_LEVEL", envLogLevel);

var output = new TestLoggerOutput();
Logger.Reset();
Logger.Configure(options =>
{
options.LogOutput = output;
options.Service = "LevelTestService";
});

Logger.LogTrace("LEVELTEST trace");
Logger.LogDebug("LEVELTEST debug");
Logger.LogInformation("LEVELTEST information");

var logOutput = output.ToString();
_output.WriteLine(logOutput);

if (shouldAppear)
{
Assert.Contains(expectedMessage, logOutput);
}
else
{
Assert.DoesNotContain(expectedMessage, logOutput);
}
}
finally
{
Environment.SetEnvironmentVariable("POWERTOOLS_LOG_LEVEL", originalLogLevel);
Logger.Reset();
}
}

[Fact]
public void PowertoolsLogLevel_Trace_ViaLoggerFactory_ShouldEmitAllLevels()
{
var originalLogLevel = Environment.GetEnvironmentVariable("POWERTOOLS_LOG_LEVEL");

try
{
Environment.SetEnvironmentVariable("POWERTOOLS_LOG_LEVEL", "Trace");

var output = new TestLoggerOutput();
var logger = LoggerFactory.Create(builder =>
{
builder.AddPowertoolsLogger(config =>
{
config.Service = "LevelTestService";
config.LogOutput = output;
});
}).CreatePowertoolsLogger();

logger.LogTrace("LEVELTEST trace");
logger.LogDebug("LEVELTEST debug");
logger.LogInformation("LEVELTEST information");
logger.LogWarning("LEVELTEST warning");
logger.LogError("LEVELTEST error");
logger.LogCritical("LEVELTEST critical");

var logOutput = output.ToString();
_output.WriteLine(logOutput);

Assert.Contains("LEVELTEST trace", logOutput);
Assert.Contains("LEVELTEST debug", logOutput);
Assert.Contains("LEVELTEST information", logOutput);
Assert.Contains("LEVELTEST warning", logOutput);
Assert.Contains("LEVELTEST error", logOutput);
Assert.Contains("LEVELTEST critical", logOutput);
}
finally
{
Environment.SetEnvironmentVariable("POWERTOOLS_LOG_LEVEL", originalLogLevel);
Logger.Reset();
}
}

/// <summary>
/// Test with 0% sampling rate to ensure info logs are not elevated
/// </summary>
Expand Down
11 changes: 11 additions & 0 deletions libraries/tests/AWS.Lambda.Powertools.Logging.Tests/Handlers/TestHandlers.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,17 @@ public void TestMethodDebug()
{
}

[Logging(ClearState = true)]
public void TestMethodAllLevels()
{
Logger.LogTrace("LEVELTEST trace");
Logger.LogDebug("LEVELTEST debug");
Logger.LogInformation("LEVELTEST information");
Logger.LogWarning("LEVELTEST warning");
Logger.LogError("LEVELTEST error");
Logger.LogCritical("LEVELTEST critical");
}

[Logging(LogEvent = true)]
public void LogEventNoArgs()
{
Expand Down
Loading