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

Having the log implementation all internal causes friction when consuming imgpkg as a library #551

Open
joaopapereira opened this issue Jul 17, 2023 · 0 comments
Labels
carvel accepted This issue should be considered for future work and that the triage process has been completed enhancement This issue is a feature request

Comments

@joaopapereira
Copy link
Member

Describe the problem/challenge you have
imgpkg API requires, in some functions, users to have their own implementation of a logger. This can cause some friction in the adoption of the library, and we could eventually provide some implementations of our loggers

Describe the solution you'd like
Have some alternatives here:

  1. Make our internal logger public.
  2. Create two basic implementations with NoOp and a writer Logger

I am more biased towards having us make the internal loggers visible from the outside as long as we do not keep the hard requirement they currently have on the logging library we are using internally in imgpkg. The second option if it is only going to be used by whoever calls imgpkg as a library, could make us more vulnerable to bugs since we would not be using them in the tool.

Anything else you would like to add:
If memory servers, these Loggers were made internal so that we would not spill out some of the complexity associated with the logging library we were using, making it a bring-your-own implementation.


Vote on this request.

This invites the community to vote on issues to help us prioritize our backlog. Use the "smiley face" up to the right of this comment to vote.

👍 "I would like to see this addressed as soon as possible."
👎 "There are other more important things to focus on right now."

We are also happy to receive and review Pull Requests if you want to help work on this issue.

@joaopapereira joaopapereira added enhancement This issue is a feature request carvel triage This issue has not yet been reviewed for validity labels Jul 17, 2023
@joaopapereira joaopapereira added carvel accepted This issue should be considered for future work and that the triage process has been completed and removed carvel triage This issue has not yet been reviewed for validity labels Aug 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
carvel accepted This issue should be considered for future work and that the triage process has been completed enhancement This issue is a feature request
Projects
Status: No status
Development

No branches or pull requests

1 participant