Docs: code examples for logger and metrics have compile errors.

[michaelbrewer]

Bug description

Provided code examples have compile errors. And the to the Tracer from the readme is broken

Expected Behavior

Code examples should compile

Current Behavior

Code examples don't all compile

Possible Solution

Fix code examples

Steps to Reproduce

1. Click on Tracer link goes to 404
2. metrics / logger examples have compile errors in webstorm and vscode

cd packages/metrics
npx tsc examples/*.ts

Environment

• Powertools version used: main
• Packaging format (Layers, npm):
• AWS Lambda function runtime:
• Debugging logs:

Related issues, RFCs

[flochaz]

Indeed, thx for reporting this, we were planning to potentially remove them since they are duplication of unit tests and global examples.

[michaelbrewer]

Ok. then there is also uploading the Readme, of whether or not to point out these examples or not.

Example projects are really handy if they work :)

[michaelbrewer]

The Tracer example also goes to a 404:

[flochaz]

Example projects are really handy if they work :)

The issue with current per package examples as they are today is that they can't really be copied and paste since their imports point to local implementation (for instance: import { Logger } from '../src';) so we were tempted to go more for what is in root examples folder to have only "compilable"/"deployable" examples and remove the packages' level one.

[flochaz]

The Tracer example also goes to a 404:

Indeed that's bad ...

[michaelbrewer]

Either way the immediate fix is in my PR.

[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.