RFC: Add Filtering to the Powertools Logging Feature

[amirkaws]

Is this related to an existing feature request or issue?

No response

Which Powertools for AWS Lambda (.NET) utility does this relate to?

Logging

Summary

When using Powertools Logger, include filters to include or exclude logs under certain conditions

Use case

Include or exclude log entries under a certain conditions such as

• Ignore when message contains a text, or
• Log only when message matches a regular expressions

Proposal

Suggestion

Logger.AddFiter(fiterExpression);
Logger.AddFiters(fiterExpression1, fiterExpression2);

Just a suggestion for filter class

public class LoggerFilterExpression
{
     public LogAction Action { get; set; } // Enum value of Exclude, IncludeOnly, ...
     public string Expression { get; set; } // ex: Contains('Hello'), NotOnly, JMESPath, etc.
}

Out of scope

Anything which is not mentioned in the Summary and Proposal sections.

Potential challenges

TBD

Dependencies and Integrations

No response

Alternative solutions

Extending powertools logger to include the required functionality

Acknowledgment

• This feature request meets Powertools for AWS Lambda (.NET) Tenets
• Should this be considered in other Powertools for AWS Lambda (.NET) languages? i.e. Python, Java, and TypeScript

[hjgraca]

Now that we support LoggerFactory from v2 we can apply all the filtering rules that it supports

As an example

var logger = LoggerFactory.Create(builder =>
{

    builder.AddFilter((provider, category, logLevel) =>
    {
        return provider.Contains("ConsoleLoggerProvider")
            && (category.Contains("Example") || category.Contains("Microsoft"))
            && logLevel >= LogLevel.Information;
    });

    builder.AddPowertoolsLogger(config =>
    {
        config.Service = "my-service1";
        config.SamplingRate = 0.001;
        config.MinimumLogLevel = LogLevel.Information;
        config.LoggerOutputCase = LoggerOutputCase.PascalCase;
        config.TimestampFormat = "yyyy-MM-dd";
    });
}).CreatePowertoolsLogger();