Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: CDK examples (metrics & tracer) have outdated references #435

Closed
mhboon opened this issue Jan 6, 2022 · 3 comments · Fixed by #439
Closed

Docs: CDK examples (metrics & tracer) have outdated references #435

mhboon opened this issue Jan 6, 2022 · 3 comments · Fixed by #439
Assignees
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation good-first-issue Something that is suitable for those who want to start contributing

Comments

@mhboon
Copy link

mhboon commented Jan 6, 2022

Bug description

In example-function.MyFunction and example-function.MyFunctionWithDecorator
line 9: const metrics = new Metrics({ namespace: namespace, service: serviceName });
service should be serviceName

In example-function.MyFunctionWithDecorator
typo in line 14 @tracer.captureLambdaHanlder() should be @tracer.captureLambdaHandler()

Expected Behavior

Try out the examples

Current Behavior

problems in IDE

Possible Solution

correct the lines; see summary

Steps to Reproduce

See summary

Environment

  • Powertools version used: 0.02
  • Packaging format (Layers, npm):
  • AWS Lambda function runtime: N/A
  • Debugging logs:

Related issues, RFCs

@mhboon mhboon added bug Something isn't working triage This item has not been triaged by a maintainer, please wait labels Jan 6, 2022
@saragerion saragerion added the good-first-issue Something that is suitable for those who want to start contributing label Jan 6, 2022
@saragerion
Copy link
Contributor

Thanks for opening the issue, well spotted.

@dreamorosi dreamorosi changed the title examples/cdk: Incorrect properties in example-function.MyFunction and example-function.MyFunctionWithDecorator bug: CDK examples (metrics & tracer) have outdated references Jan 6, 2022
@dreamorosi
Copy link
Contributor

@mhboon thanks a lot, we are planning on running tests on our CI for these examples to try to avoid this type of errors in the future, see also #425.

@github-actions
Copy link
Contributor

⚠️ 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.

@dreamorosi dreamorosi removed the triage This item has not been triaged by a maintainer, please wait label Oct 19, 2022
@dreamorosi dreamorosi added documentation Improvements or additions to documentation completed This item is complete and has been merged/shipped and removed bug Something isn't working labels Nov 14, 2022
@dreamorosi dreamorosi changed the title bug: CDK examples (metrics & tracer) have outdated references Docs: CDK examples (metrics & tracer) have outdated references Nov 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation good-first-issue Something that is suitable for those who want to start contributing
Projects
None yet
3 participants