diff --git a/docs/extend/extend-desktop/mvd-core-loggers.md b/docs/extend/extend-desktop/mvd-core-loggers.md deleted file mode 100644 index 90b206ecd0..0000000000 --- a/docs/extend/extend-desktop/mvd-core-loggers.md +++ /dev/null @@ -1,37 +0,0 @@ -This is a list of core loggers (and descriptions of each) that you can enable and increase verbosity on within the logging framework. See [the logging utility](mvd-logutility.md) for more info. - -# Loggers for Zowe Application Server Core -The log prefix for the Zowe Application Server is `_zsf`, which is used by the server framework. (Applications and plug-ins that are attached to the server do not use the `_zsf` prefix.) -The following are the logger names that you can specify: -* **_zsf.bootstrap**: Logging that pertains to the startup of the server. -* **_zsf.auth**: Logging for network calls that must be checked for authentication and authorization purposes. -* **_zsf.static**: Logging of the serving of static files (such as images) from an application's /web folder. -* **_zsf.child**: Logging of child processes, if any. -* **_zsf.utils**: Logging for miscellaneous utilities that the server relies upon. -* **_zsf.proxy**: Logging for proxies that are set up in the server. -* **_zsf.install**: Logging for the installation of plug-ins. -* **_zsf.apiml**: Logging for communication with the api mediation layer. -* **_zsf.routing**: Logging for dispatching network requests to plug-in dataservices. -* **_zsf.network**: Logging for the HTTPS server status (connection, ports, IP, and so on). - -# Zowe App Server Log levels -* 0: SEVERE -* 1: WARNING -* 2 (Default): INFO -* 3: FINE -* 4: FINER -* 5: FINEST - - -# Loggers for ZSS Server Core -The log prefix for ZSS is `_zss`. The following are the logger names that you can specify: -* **_zss.traceLevel**: Controls general server logging verbosity. -* **_zss.fileTrace**: Logs file serving behavior (if file serving is enabled). -* **_zss.socketTrace**: Logs general TCP Socket behavior. -* **_zss.httpParseTrace**: Logs parsing of HTTP messages. -* **_zss.httpDispatchTrace**: Logs dispatching of HTTP messages to dataservices. -* **_zss.httpHeadersTrace**: Logs parsing and setting of HTTP headers. -* **_zss.httpSocketTrace**: Logs TCP socket behavior for HTTP. -* **_zss.httpCloseConversationTrace**: Logs HTTP behavior for when an HTTP conversation ends. -* **_zss.httpAuthTrace**: Logs behavior for session security. -* **_zss.jwtTrace**: Logs the JSON Web Tokens. diff --git a/docs/troubleshoot/app-framework/primary-loggers.md b/docs/troubleshoot/app-framework/primary-loggers.md new file mode 100644 index 0000000000..bfb0bed786 --- /dev/null +++ b/docs/troubleshoot/app-framework/primary-loggers.md @@ -0,0 +1,48 @@ +# Primary loggers + +This is a list of primary loggers and their descriptions. You can enable the loggers and increase the logging verbosity within the logging framework. For more information, see [Enabling tracing](./appfw-tracing.md). + +## Loggers for app-server component +The log prefix for the Zowe Application Server is `_zsf`, which is used by the server framework. (Applications and plug-ins that are attached to the server do not use the `_zsf` prefix.) +The following are the logger names that you can specify: +Logger name | Description +---|--- +**_zsf.bootstrap** | Logging that pertains to the startup of the server. +**_zsf.auth** | Logging for network calls that must be checked for authentication and authorization purposes. +**_zsf.static** | Logging of the serving of static files (such as images) from an application's folder or a web folder. +**_zsf.child** | Logging of child processes, if any. +**_zsf.utils** | Logging for miscellaneous utilities that the server relies upon. +**_zsf.proxy** | Logging for proxies that are set up in the server. +**_zsf.install** | Logging for the installation of plug-ins. +**_zsf.apiml** | Logging for the communication with the API Mediation Layer. +**_zsf.routing** | Logging for dispatching network requests to plug-in dataservices. +**_zsf.network** | Logging for the HTTPS server status (connection, ports, IP, etc). + + +## Loggers for zss component +The log prefix for ZSS is `_zss`. +The following are the logger names that you can specify: +Logger name | Description +---|--- +**_zss.traceLevel** | Controls the logging verbosity of the server. +**_zss.fileTrace** | Logs the behavior of file serving (if file serving is enabled). +**_zss.socketTrace** | Logs the behavior of a general TCP Socket. +**_zss.httpParseTrace** | Logs the parsing of HTTP messages. +**_zss.httpDispatchTrace** | Logs the dispatching of HTTP messages to dataservices. +**_zss.httpHeadersTrace** | Logs the parsing and setting up of HTTP headers. +**_zss.httpSocketTrace** | Logs the behavior of a TCP socket for HTTP. +**_zss.httpCloseConversationTrace** | Logs the behavior of HTTP when an HTTP conversation ends. +**_zss.httpAuthTrace** | Logs the behavior of the security of a session. +**_zss.jwtTrace** | Logs the JSON Web Tokens. + +## Log levels +Most loggers have levels ranging from 0 to 5, where 0 is the least verbose and 5 is the most verbose. +| Verbosity | Log type | Log information | +|---|---|---| +| 0 (least verbose) | SEVERE | Denotes critical errors, application failure. | +| 1 | WARNING | Denotes potential issues that need attention soon. | +| 2 (Default) | INFO | Denotes general operational updates, normal functioning. | +| 3 | FINE | Denotes detailed tracing information. | +| 4 | FINER | Denotes more detailed tracing information. | +| 5 (most verbose) | FINEST | Denotes extremely detailed tracing information which can be used for debugging. | + diff --git a/docs/user-guide/configure-auxiliary-address-space.md b/docs/user-guide/configure-auxiliary-address-space.md deleted file mode 100644 index dbbd78e5a1..0000000000 --- a/docs/user-guide/configure-auxiliary-address-space.md +++ /dev/null @@ -1,13 +0,0 @@ -# Zowe Auxiliary Address space - -The cross memory server runs as a started task `ZWESISTC` that uses the load module `ZWESIS01`. - -In some use cases, the Zowe cross memory server has to spawn child address spaces, which are known as auxiliary (AUX) address spaces. The auxiliary address spaces run as the started task `ZWESASTC` using the load module `ZWESAUX` and are started, controlled, and stopped by the cross memory server. - -An example of when an auxiliary address space is used is for a system service that requires supervisor state but cannot run in cross-memory mode. The service can be run in an AUX address space which is invoked by the Cross Memory Server acting as a proxy for unauthorized users of the service. - -Do not install the Zowe auxiliary address space unless a Zowe extension product's installation guide explicitly asks for it to be done. This will occur if the extension product requires services of Zowe that cannot be performed by the cross memory server and an auxiliary address space needs to be started. - -A default installation of Zowe does not require auxiliary address spaces to be configured. - -You do not start or stop the ZWESASTC manually. \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index 429a50dee9..97025a3534 100644 --- a/sidebars.js +++ b/sidebars.js @@ -851,6 +851,7 @@ module.exports = { "troubleshoot/app-framework/app-mustgather", "troubleshoot/app-framework/app-issue", "troubleshoot/app-framework/appfw-tracing", + "troubleshoot/app-framework/primary-loggers", "troubleshoot/app-framework/app-return-codes", "troubleshoot/app-framework/appserver-error-codes", "troubleshoot/app-framework/zss-error-codes", diff --git a/versioned_docs/version-v2.18.x/extend/extend-desktop/mvd-core-loggers.md b/versioned_docs/version-v2.18.x/extend/extend-desktop/mvd-core-loggers.md deleted file mode 100644 index 90b206ecd0..0000000000 --- a/versioned_docs/version-v2.18.x/extend/extend-desktop/mvd-core-loggers.md +++ /dev/null @@ -1,37 +0,0 @@ -This is a list of core loggers (and descriptions of each) that you can enable and increase verbosity on within the logging framework. See [the logging utility](mvd-logutility.md) for more info. - -# Loggers for Zowe Application Server Core -The log prefix for the Zowe Application Server is `_zsf`, which is used by the server framework. (Applications and plug-ins that are attached to the server do not use the `_zsf` prefix.) -The following are the logger names that you can specify: -* **_zsf.bootstrap**: Logging that pertains to the startup of the server. -* **_zsf.auth**: Logging for network calls that must be checked for authentication and authorization purposes. -* **_zsf.static**: Logging of the serving of static files (such as images) from an application's /web folder. -* **_zsf.child**: Logging of child processes, if any. -* **_zsf.utils**: Logging for miscellaneous utilities that the server relies upon. -* **_zsf.proxy**: Logging for proxies that are set up in the server. -* **_zsf.install**: Logging for the installation of plug-ins. -* **_zsf.apiml**: Logging for communication with the api mediation layer. -* **_zsf.routing**: Logging for dispatching network requests to plug-in dataservices. -* **_zsf.network**: Logging for the HTTPS server status (connection, ports, IP, and so on). - -# Zowe App Server Log levels -* 0: SEVERE -* 1: WARNING -* 2 (Default): INFO -* 3: FINE -* 4: FINER -* 5: FINEST - - -# Loggers for ZSS Server Core -The log prefix for ZSS is `_zss`. The following are the logger names that you can specify: -* **_zss.traceLevel**: Controls general server logging verbosity. -* **_zss.fileTrace**: Logs file serving behavior (if file serving is enabled). -* **_zss.socketTrace**: Logs general TCP Socket behavior. -* **_zss.httpParseTrace**: Logs parsing of HTTP messages. -* **_zss.httpDispatchTrace**: Logs dispatching of HTTP messages to dataservices. -* **_zss.httpHeadersTrace**: Logs parsing and setting of HTTP headers. -* **_zss.httpSocketTrace**: Logs TCP socket behavior for HTTP. -* **_zss.httpCloseConversationTrace**: Logs HTTP behavior for when an HTTP conversation ends. -* **_zss.httpAuthTrace**: Logs behavior for session security. -* **_zss.jwtTrace**: Logs the JSON Web Tokens. diff --git a/versioned_docs/version-v2.18.x/troubleshoot/app-framework/primary-loggers.md b/versioned_docs/version-v2.18.x/troubleshoot/app-framework/primary-loggers.md new file mode 100644 index 0000000000..0f16657276 --- /dev/null +++ b/versioned_docs/version-v2.18.x/troubleshoot/app-framework/primary-loggers.md @@ -0,0 +1,48 @@ +# Primary loggers + +This is a list of primary loggers and their descriptions. You can enable the loggers and increase the logging verbosity within the logging framework. For more information, see [Enabling tracing](./appfw-tracing.md). + +## Loggers for app-server component +The log prefix for the Zowe Application Server is `_zsf`, which is used by the server framework. (Applications and plug-ins that are attached to the server do not use the `_zsf` prefix.) +The following are the logger names that you can specify: +Logger name | Description +---|--- +**_zsf.bootstrap** | Logging that pertains to the startup of the server. +**_zsf.auth** | Logging for network calls that must be checked for authentication and authorization purposes. +**_zsf.static** | Logging of the serving of static files (such as images) from an application's folder or a web folder. +**_zsf.child** | Logging of child processes, if any. +**_zsf.utils** | Logging for miscellaneous utilities that the server relies upon. +**_zsf.proxy** | Logging for proxies that are set up in the server. +**_zsf.install** | Logging for the installation of plug-ins. +**_zsf.apiml** | Logging for the communication with the API Mediation Layer. +**_zsf.routing** | Logging for dispatching network requests to plug-in dataservices. +**_zsf.network** | Logging for the HTTPS server status (connection, ports, IP, etc). + + +## Loggers for zss component +The log prefix for ZSS is `_zss`. The following are the logger names that you can specify: +Logger name | Description +---|--- +**_zss.traceLevel** | Controls the logging verbosity of the server. +**_zss.fileTrace** | Logs the behavior of file serving (if file serving is enabled). +**_zss.socketTrace** | Logs the behavior of a general TCP Socket. +**_zss.httpParseTrace** | Logs the parsing of HTTP messages. +**_zss.httpDispatchTrace** | Logs the dispatching of HTTP messages to dataservices. +**_zss.httpHeadersTrace** | Logs the parsing and setting up of HTTP headers. +**_zss.httpSocketTrace** | Logs the behavior of a TCP socket for HTTP. +**_zss.httpCloseConversationTrace** | Logs the behavior of HTTP when an HTTP conversation ends. +**_zss.httpAuthTrace** | Logs the behavior of the security of a session. +**_zss.jwtTrace** | Logs the JSON Web Tokens. + + +## Log levels +Most loggers have levels ranging from 0 to 5 where 0 is the least verbose and 5 is the most verbose. +| Verbosity | Log type | Log information | +|---|---|---| +| 0 (least verbose) | SEVERE | Denotes critical errors, application failure. | +| 1 | WARNING | Denotes potential issues that need attention soon. | +| 2 (Default) | INFO | Denotes general operational updates, normal functioning. | +| 3 | FINE | Denotes detailed tracing information. | +| 4 | FINER | Denotes more detailed tracing information. | +| 5 (most verbose) | FINEST | Denotes extremely detailed tracing information which can be used for debugging. | + diff --git a/versioned_docs/version-v2.18.x/user-guide/configure-auxiliary-address-space.md b/versioned_docs/version-v2.18.x/user-guide/configure-auxiliary-address-space.md deleted file mode 100644 index dbbd78e5a1..0000000000 --- a/versioned_docs/version-v2.18.x/user-guide/configure-auxiliary-address-space.md +++ /dev/null @@ -1,13 +0,0 @@ -# Zowe Auxiliary Address space - -The cross memory server runs as a started task `ZWESISTC` that uses the load module `ZWESIS01`. - -In some use cases, the Zowe cross memory server has to spawn child address spaces, which are known as auxiliary (AUX) address spaces. The auxiliary address spaces run as the started task `ZWESASTC` using the load module `ZWESAUX` and are started, controlled, and stopped by the cross memory server. - -An example of when an auxiliary address space is used is for a system service that requires supervisor state but cannot run in cross-memory mode. The service can be run in an AUX address space which is invoked by the Cross Memory Server acting as a proxy for unauthorized users of the service. - -Do not install the Zowe auxiliary address space unless a Zowe extension product's installation guide explicitly asks for it to be done. This will occur if the extension product requires services of Zowe that cannot be performed by the cross memory server and an auxiliary address space needs to be started. - -A default installation of Zowe does not require auxiliary address spaces to be configured. - -You do not start or stop the ZWESASTC manually. \ No newline at end of file diff --git a/versioned_sidebars/version-v2.18.x-sidebars.json b/versioned_sidebars/version-v2.18.x-sidebars.json index fb07b1be9a..b1afe1691b 100644 --- a/versioned_sidebars/version-v2.18.x-sidebars.json +++ b/versioned_sidebars/version-v2.18.x-sidebars.json @@ -1025,6 +1025,7 @@ "troubleshoot/app-framework/app-mustgather", "troubleshoot/app-framework/app-issue", "troubleshoot/app-framework/appfw-tracing", + "troubleshoot/app-framework/primary-loggers", "troubleshoot/app-framework/app-return-codes", "troubleshoot/app-framework/appserver-error-codes", "troubleshoot/app-framework/zss-error-codes", @@ -1278,4 +1279,4 @@ "href": "https://github.com/zowe/docs-site/tree/master/tpsr/tpsr-v2.18.5.md" } ] -} \ No newline at end of file +}