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.

Sign up for GitHub

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

Update documentation about logLevels #2756

Closed
wants to merge 4 commits into from
Closed

Update documentation about logLevels #2756

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2a894c5
Update must-gather.md
1000TurquoisePogs Mar 20, 2023
e1794d6
Update mvd-configuration.md
1000TurquoisePogs Mar 20, 2023
d3cb3b6
Merge branch 'docs-staging' into feature/improve-logging-guidance
anaxceron Jan 12, 2024
34dc731
fixing formatting, style, punctuation, etc
anaxceron Jan 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 16 additions & 18 deletions docs/troubleshoot/servers/must-gather.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Gathering Information for Support or Troubleshooting
# Gathering information for support or troubleshooting

If you need to contact a support group for Zowe, they will likely need a variety of information from you to help you. This page details a list of items you should gather to the best of your ability to provide to your support group. You may also find this list useful for independent troubleshooting.

## Describe your environment
## Describing your environment

* Zowe version number:
* Zowe version number:
* Install method (pax, smpe, kubernetes, github clone):
* Operating system (z/OS, kubernetes, etc) and OS version:
* Node.js version number (Shown in logs, or via `node --version`):
Expand All @@ -15,7 +15,7 @@ If you need to contact a support group for Zowe, they will likely need a variety
* What is the output of log message ZWES1014I:
* Environment variables in use:

### Tips on gathering this information
### Gathering this information

A lot of this information can be gathered automatically using the `zwe` command `zwe support`.
Otherwise, you can gather some of the information in the ways below.
Expand All @@ -30,39 +30,37 @@ To find the z/OS release level, issue the following command in SDSF:

#### Zowe version

Locate the file manifest.json within the zowe installation directory.
Locate the file manifest.json within the Zowe installation directory.
At the top, you will find the version number.



## Describe your issue
## Describing your issue

Do you think your issue is a bug? If so, try to list the steps to reproduce it, and what you expect to happen instead.

## Provide the logs
## Providing the logs

When running Zowe servers on z/OS, the joblog has the most information.

Depending on what support group you are contacting, you may want to sanitize the logs as they can contain basic system information like hostnames, usernames, and network configuration.

Ensure that your logs were captured with long enough record length to be read by support. Zowe commonly writes lines as long as 500 characters, especially when tracing.

### Enabling debugging and tracing

There are several debug modes in the Zowe servers, and support groups may ask for you to turn some on.

Below are some tracing you can turn on when needed:

* When running a `zwe` command, you can run it with `--trace` to get the most output from it.
* `zwe` startup tracing can be set via the zowe configuration file property `zowe.launchScript.logLevel="trace"`. [You can see the property in the example file here](https://github.com/zowe/zowe-install-packaging/blob/677a607686e6ee7ecb349dc5925a6f58dd9e61da/example-zowe.yaml#L356)
* app-server tracing can be enabled by setting various loggers in the property `components.app-server.logLevels` in the zowe configuration file. [The full list is documented here](https://github.com/zowe/zlux-app-server/blob/v2.x/master/schemas/app-server-config.json#L378). [More information](../../user-guide/mvd-configuration#logging-configuration)
* zss-tracing tracing can be enabled by setting various loggers in the property `components.zss.logLevels` in the zowe configuration file. [The full list is documented here](https://github.com/zowe/zss/blob/v2.x/master/schemas/zss-config.json#L216). [More information](../../user-guide/mvd-configuration#logging-configuration)
* discovery, gateway, api-catalog and other servers can have tracing enabled by setting `debug: true` within their zowe configuration file section, such as `components.gateway.debug=true`
* `zwe` startup tracing can be set via the Zowe configuration file property `zowe.launchScript.logLevel="trace"`. [You can see the property in the example file here](https://github.com/zowe/zowe-install-packaging/blob/677a607686e6ee7ecb349dc5925a6f58dd9e61da/example-zowe.yaml#L356)
* app-server tracing can be enabled by setting various loggers in the property `components.app-server.logLevels` in the Zowe configuration file. [The full list is documented here](https://github.com/zowe/zlux-app-server/blob/v2.x/master/schemas/app-server-config.json#L378).
* [More information](../../user-guide/mvd-configuration.md#logging-configuration)
* zss-tracing tracing can be enabled by setting various loggers in the property `components.zss.logLevels` in the Zowe configuration file. [The full list is documented here](https://github.com/zowe/zss/blob/v2.x/master/schemas/zss-config.json#L216).
* [More information](../../user-guide/mvd-configuration.md#logging-configuration)
* discovery, gateway, api-catalog and other servers can have tracing enabled by setting `debug: true` within their Zowe configuration file section, such as `components.gateway.debug=true`

You may find more detail within the Mediation Layer and Application Framework troubleshooting categories.

## Screenshots
## Providing screenshots

If you have an issue in the browser, its often helpful to show the issue via screenshots.




Loading
Loading