Issue number: #6141

Summary

This PR improves the log sampling rate calculation mechanism in our Logger utility. It aims to provide a more consistent and expected behavior for customers using log sampling, especially when reusing Lambda environments.

Changes

1. Introduced a new method refresh_sample_rate_calculation() in the Logger class.
2. Updated the @logger.inject_lambda_context decorator to call refresh_sample_rate_calculation() at the end of each invocation.
3. Modified the internal sampling logic to use the refreshed calculation.

Expected Behavior

1. Customers will continue to set sampling_rate at the constructor level.
2. When using @logger.inject_lambda_context, the sampling rate will be recalculated on every request, providing the expected sampling behavior.
3. Customers not using the decorator can manually call refresh_sample_rate_calculation() to achieve the same effect.
4. If neither the decorator nor manual refresh is used, sampling behavior may be unexpected.

Backwards Compatibility

This change is backwards compatible. Existing code will continue to work, but may benefit from adopting the new best practices.

Missing

• Update the documentation

User experience

Using decorator

from aws_lambda_powertools import Logger
from aws_lambda_powertools.utilities.typing import LambdaContext

logger = Logger(level="INFO", sampling_rate=0.5)

@logger.inject_lambda_context
def lambda_handler(event, context: LambdaContext):
    logger.debug("test") # expected to be flushed in 50% of the requests
    pass

Using manual method

from aws_lambda_powertools import Logger
from aws_lambda_powertools.utilities.typing import LambdaContext

logger = Logger(level="INFO", sampling_rate=0.5)

def lambda_handler(event, context: LambdaContext):
    logger.debug("test") # expected to be flushed in 50% of the requests
    logger.refresh_sample_rate_calculation()
    pass

Checklist

If your change doesn't seem to apply, please leave them unchecked.

• Meet tenets criteria
• I have performed a self-review of this change
• Changes have been tested
• Changes are documented
• PR title follows conventional commit semantics

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.