Set runtime debug mode #2360
Merged
Set runtime debug mode #2360
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When we load our runtime configuration inside the bundle, we won't have a --debug flag, or a config file to load the configuraiton value. We ne ed to instead handle applying configuration ourselves with the PORTER_DEBUG environment variable which is set by all porter bundles. Signed-off-by: Carolyn Van Slyck <[email protected]>
In the main function for exex, I have copied some of the standard main "boilerplate" functionality around initializing a logger, and registering it with the go context. This enables other mixin functions to be able to grab a logger from the context when they call tracing.StartSpan or tracing.LoggerFromContext. We do not have telemetry properly configured from inside a bundle yet, but this fixes debug logging from runtime libraries called by the mixins. Later on we can complete setting up the mixins so that they can particpate in telemetry/tracing too. Signed-off-by: Carolyn Van Slyck <[email protected]>
When we run a bundle, we need to pass select porter configuration into the bundle using environment variables. This allows us to have the --verbosity flag, or --debug flag, to be used from inside the bundle. Verbosity affects the log level of what is printed to the console. DebugMode is used by the mixins to change their behavior when debugging a bundle (such as running slightly different commands). Signed-off-by: Carolyn Van Slyck <[email protected]>
VinozzZ
reviewed
Sep 15, 2022
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this change
This fixes the bundle output when a bundle is run in debug mode with --debug. It initializes RuntimeConfig.DebugMode (used by the mixins) with the value of the PORTER_DEBUG environment variable. It also configures a logger and puts it on the go context, so that when mixins use tracing.StartSpan or tracing.LoggerFromContext it gets a configured logger that understands the verbosity that was set on the Porter client side.
We are now setting PORTER_VERBOSITY on the bundle's invocation image when run so that --verbosity set on the client is also used in the bundle. When the bundle is run in debug mode (i.e. porter install --debug), we also pass PORTER_VERBOSITY=debug so that a dev can see everything that is happening.
What issue does it fix
Closes #2358
Notes for the reviewer
I am copy/pasting a lot of boilerplate code from porter's main into the exec mixin. In order for the other mixins to get debug mode and verbosity working, they too will need to do this. Long term I would like to use the pkg/cli package to share a common main implementation but @VinozzZ and I agreed this was the more conservative fix since we are in a release candidate.
Checklist
Reviewer Checklist