-
Notifications
You must be signed in to change notification settings - Fork 93
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
Zowe Explorer Output Logger #2192
Conversation
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
…orHandling Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #2192 +/- ##
==========================================
+ Coverage 91.15% 91.46% +0.30%
==========================================
Files 89 89
Lines 8400 8856 +456
Branches 1807 1828 +21
==========================================
+ Hits 7657 8100 +443
- Misses 742 755 +13
Partials 1 1
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
You have successfully added a new SonarCloud configuration ``. As part of the setup process, we have scanned this repository and found no existing alerts. In the future, you will see all code scanning alerts on the repository Security tab. |
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
@JillieBeanSim Thanks for these changes Billie! I wanted to suggest if we wanted to add maybe little descriptions for what each log level does in the dropdown setting, you can set them by doing the following for example: "zowe.security.secureCredentialManager": {
"default": "keytar",
"type": "string",
"enum": [
"keytar",
"kubernetes",
"off"
],
"markdownEnumDescriptions": [
"Store Zowe credentials on the local machine with Keytar.",
"Store Zowe credentials on a kubernetes cluster as secrets.",
"Disable secure credentials and allow creation of an unsecure profile."
],
"description": "%zowe.security.secureCredentialManager%",
"scope": "window"
} Notice the |
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
This is great work and will make logging so much better for developers and end-users. I am not submitting a formal review as I have some general feedback that is more an opinion that we need to discuss as a team:
|
In the VS Code Debug Console I see these messages that look like they are related to the output view.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I really like this feature!
LGTM! 😋
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Signed-off-by: Billie Simmons <49491949+JillieBeanSim@users.noreply.github.com>
Kudos, SonarCloud Quality Gate passed! 0 Bugs No Coverage information |
Comments have been addressed. I created a new Epic for V3 Enhancements that includes a story about exposing the ZE VSC Output Channel logger in ZE API. We already have ZE APIs for writing to the log files and Timothy is working on a new setting for users to state where they would like there logs to be written in this PR that can be utilized by extenders to let users have a single location for them and ZE to write logs to the same files. I also created a story for the wiki update and review of logging |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! 😋
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this awesome new change @JillieBeanSim !
Proposed changes
Add Zowe Explorer Logger setting with INFO as default, this setting will be most useful for users.
Added Zowe Explorer Output Channel to also write logs to.
If Zowe CLI envar
ZOWE_APP_LOG_LEVEL
is set and different from ZE's default, the user is prompted once and asked if they would like ZE's logger to match the CLI's. After first presentation of message"zowe.cliLoggerSetting.presented": true
is added in settings and the user won't be asked again as long as it is in settings.Release Notes
Milestone: 2.8.0
Changelog:
ZE:
zowe.logger
, with a default setting ofINFO
.Zowe Explorer
, for logging within VS Code's Output view. The log level is set by the new Zowe Explorer setting,zowe.logger
.ZE API:
Gui.reportProgress
that can be used to notify users of action progress in conjunction with theGui.withProgress
call. #2167Types of changes
What types of changes does your code introduce to Zowe Explorer?
Put an
x
in the boxes that applyChecklist
Put an
x
in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This checklist will be used as reference for both the contributor and the revieweryarn workspace vscode-extension-for-zowe vscode:prepublish
has been executedFurther comments