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

Maintenance: remove createTracer & createLogger helpers #1721

Closed
1 of 2 tasks
dreamorosi opened this issue Sep 27, 2023 · 2 comments · Fixed by #1722
Closed
1 of 2 tasks

Maintenance: remove createTracer & createLogger helpers #1721

dreamorosi opened this issue Sep 27, 2023 · 2 comments · Fixed by #1722
Assignees
Labels
completed This item is complete and has been merged/shipped internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) logger This item relates to the Logger Utility tracer This item relates to the Tracer Utility
Milestone

Comments

@dreamorosi
Copy link
Contributor

Summary

As part of this issue we will remove the two helper functions found in Tracer and Logger. These two helpers allow to create a new instance of their respective Powertools utilities, i.e. createTracer() returns an instance of Tracer.

The existence of these functions was undocumented and never mentioned anywhere outside the tests, however if there are customers who are using these helpers can simply switch to instantiating the utilities directly:

-- const logger = createLogger();
++ const logger = new Logger();

Why is this needed?

We have decided to remove these helpers because over the past two years we haven't seen any usage. Likewise, while the helpers are available only for Logger and Tracer, we haven't seen demand for adding them to other utilities.

Removing these helpers will also decrease the code shipped.

Which area does this relate to?

Tracer, Logger

Solution

No response

Acknowledgment

Future readers

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

@dreamorosi dreamorosi added logger This item relates to the Logger Utility tracer This item relates to the Tracer Utility internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) labels Sep 27, 2023
@dreamorosi dreamorosi added this to the Version 2.0 milestone Sep 27, 2023
@dreamorosi dreamorosi self-assigned this Sep 27, 2023
@dreamorosi dreamorosi moved this from Working on it to Pending review in Powertools for AWS Lambda (TypeScript) Sep 27, 2023
@dreamorosi dreamorosi linked a pull request Sep 28, 2023 that will close this issue
9 tasks
@dreamorosi dreamorosi moved this from Pending review to Shipped in Powertools for AWS Lambda (TypeScript) Oct 11, 2023
@github-project-automation github-project-automation bot moved this from Shipped to Coming soon in Powertools for AWS Lambda (TypeScript) Oct 11, 2023
@dreamorosi dreamorosi added the completed This item is complete and has been merged/shipped label Oct 11, 2023
@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 added pending-release This item has been merged and will be released soon and removed completed This item is complete and has been merged/shipped labels Oct 11, 2023
@github-actions github-actions bot added completed This item is complete and has been merged/shipped and removed pending-release This item has been merged and will be released soon labels Nov 1, 2023
@aws-powertools aws-powertools deleted a comment from github-actions bot Nov 1, 2023
@dreamorosi dreamorosi added pending-release This item has been merged and will be released soon completed This item is complete and has been merged/shipped and removed completed This item is complete and has been merged/shipped pending-release This item has been merged and will be released soon labels Nov 2, 2023
@dreamorosi dreamorosi moved this from Coming soon to Shipped in Powertools for AWS Lambda (TypeScript) Nov 2, 2023
@dreamorosi
Copy link
Contributor Author

dreamorosi commented Nov 2, 2023

This is available in preview starting from the 2.0.0-alpha.0 release. You can install this version using the next tag, i.e. npm i @aws-lambda-powertools/logger@next.

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 internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) logger This item relates to the Logger Utility tracer This item relates to the Tracer Utility
Projects
1 participant