Maintenance: improve type hints when using log reordering feature

[dreamorosi]

Summary

In #2736 we added a feature that allows customers to specify an order for how the keys will appear in each log. This feature represents a middle ground between wanting to customize the Logger without having to create and maintain your own custom log formatter.

While the feature is great, customers using this feature might not be familiar with all the keys that Logger can include in its log. We should improve our types around the feature so that customers get some type hints and useful autocomplete when specifying the log order.

Why is this needed?

So that customers can be aware of the available keys that they can specify when using the feature without having to open the browser and check the documentation.

Which area does this relate to?

Logger

Solution

No response

Acknowledgment

• This 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.

[github-actions]

⚠️ COMMENT VISIBILITY WARNING ⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

[github-actions]

This is now released under v2.8.0 version!