Docs: Custom log formatter example does not show source for MyCompanyLogFormatter.ts

[cromo]

What were you searching in the docs?

I was reading the docs from top to bottom and came across this since some might want to write string logs instead of using structured logging.

Is this related to an existing documentation section?

https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/logger/#custom-log-formatter-bring-your-own-formatter

How can we improve?

It looks like the source for `handler.ts` was mistakenly copied into the block below it for `utils/formatters/MyCompanyLogFormatter.ts` instead of showing an implementation of the `LogFormatterInterface`. That block should show how to implement this.

Got a suggestion in mind?

Change the utils/formatters/MyCompanyLogFormatter.ts code block to show an implementation of the LogFormatterInterface as expected; as written the documentation does little more than tell you that custom formatters can be used but not how to make them.

Acknowledgment

• I understand the final update might be different from my proposed suggestion, or refused.

[dreamorosi]

Hello, thanks for reporting this.

Someone reported this yesterday #1253 and a fix was merged with #1254.

The updated/fixed version is already available on the /dev version of the docs.

The updated docs will be published on /latest tomorrow.

I'll leave the issue open until then so that others can see it if needed.

[dreamorosi]

The updated docs are now live, you can see the code example here.

Note that if you don't see the change yet it's probably due to caching, you might need to refresh your browser's cache or try with a different browser/private session to see it immediately - but it's there!

[github-actions]

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues 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.