Feature request: Export `PowertoolsLogFormatter` from `/logger`

[Myroslav341]

Use case

When creating a custom log formatter, the only way to keep the default baseAttributes shape is to copy the formatting code from PowertoolsLogFormatter.

If PowertoolsLogFormatter is exported on the package level, custom log formatters can inherit from it if needed.

Solution/User Experience

import { LogFormatter, PowertoolsLogFormatter } from '@aws-lambda-powertools/logger'

Alternative solutions

Acknowledgment

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

Future readers

Please react with 👍 and your use case to help us understand customer demand.

[boring-cyborg]

Thanks for opening your first issue here! We'll come back to you as soon as we can.
In the meantime, check out the #typescript channel on our Powertools for AWS Lambda Discord: Invite link

[dreamorosi]

Hi @Myroslav341, thank you for opening the issue.

Before categorizing the request I'd like to better understand the use case.

In which case you'd want to extend the PowertoolsLogFormatter instead of the LogFormatter class?

The PowertoolsLogFormatter is purposefully note exported because we export the parent class (LogFormatter) for those who want to customize how logs are formatted.

If we exported PowertoolsLogFormatter and you were to extend it, you'd have to format the attributes twice because the formatAttribute method returns an instance of LogItem rather than a plain object.

[Myroslav341]

Hi @dreamorosi.

The main problem we are encountering is that we initially relied on the default PowertoolsLogFormatter, which modifies the shape of the attributes in a specific way. However, when we switched to a custom log formatter, it no longer modifies the attributes in the same manner. This inconsistency makes our logs differ significantly, which is undesirable.

I am looking for a way to keep the same shape of the attributes when using a custom log formatter. The only available option is to copy what PowertoolsLogFormatter does.

Maybe we can extract the formatting logic into a separate, exportable function to reuse when implementing our custom log formatter? This would ensure consistency in attribute shapes across logs while still allowing customization.

Happy to hear any other suggestions or alternative solutions.

[github-actions]

This issue has not received a response in 2 weeks. If you still think there is a problem, please leave a comment to avoid the issue from automatically closing.

[github-actions]

Greetings! We are closing this issue because it has been open a long time and hasn’t been updated in a while and may not be getting the attention it deserves. We encourage you to check if this is still an issue in the latest release and if you find that this is still a problem, please feel free to comment or reopen the issue.