PEC-REP/Current/GCXIPEGuide/Logging - Revision history

WikiSysop at 19:30, April 7, 2022

2022-04-07T19:30:35Z

Tony.gilchrist@genesys.com: Published

2021-10-26T19:17:43Z

Published

Tony.gilchrist@genesys.com: Published

2021-09-22T14:18:57Z

Published

Tony.gilchrist@genesys.com: Published

2021-09-01T18:29:59Z

Published

Tony.gilchrist@genesys.com: Published

2021-08-09T19:57:17Z

Published

Tony.gilchrist@genesys.com: Published

2021-08-09T19:56:14Z

Published

Tony.gilchrist@genesys.com: Published

2021-06-29T19:46:10Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Logging
|Context=Learn how to access logs for Genesys Customer Experience Insights (GCXI).
|ComingSoon=No
|Section={{Section
|alignment=Vertical
|structuredtext=GCXI writes logs in the following locations:

*'''pod stdout''' -- General GCXI logs, which you can use for troubleshooting.
*'''log''' folder, mounted at <code>/mnt/log</code> -- MicroStrategy logs, which are used only in special cases when requested by MicroStrategy support.
|Status=No
}}
|PEPageType=7a5823f3-05b5-412b-b580-e73e34079c41
}}

@@ Line 1: / Line 1: @@
 {{Article
 |Standalone=No
@@ Line 8: / Line 6: @@
 |Section={{Section
 |alignment=Vertical
-|structuredtext=
+|structuredtext===GCXI logging==
 GCXI writes logs in the following locations:
 *'''pod stdout''' -- General GCXI logs, which you can use for troubleshooting.
-*'''log''' folder, mounted at <code>/mnt/log</code> -- MicroStrategy logs, which are used only in special cases when requested by MicroStrategy support.
+*'''log''' folder, mounted at <code>/mnt/log</code> -- MicroStrategy logs, which MicroStrategy support sometimes requests.
 ===Log Level===
-Configure the following log-related container variables if required:
+Configure the following log-related container variables if necessary:
 *'''DEV_XTRACE_LEVEL''' &mdash; Enables / disables Bash xtrace level in container stdout. It accepts the following values:
 **'''OFF''' = bash xtrace off (default)
-**'''DEBUG''' = partial bash xtrace with concealed secrets (may be needed for troubleshooting)
+**'''DEBUG''' = partial bash xtrace with concealed secrets (sometimes needed for troubleshooting).
-**'''ALL''' = full bash xtrace.  Caution: everything, including passwords, is visible in console log. This can be necessary in some troublshooting scenarios.
+**'''ALL''' = full bash xtrace.  Caution: everything, including passwords, is visible in the console log. This log level can be necessary in some troubleshooting scenarios.
-*'''DEV_ERR_EXIT''' &mdash; Enables / disables container exit on error. This variable is no directly related to logging, but can be useful for troubleshooting. It accepts the following values:
+*'''DEV_ERR_EXIT''' &mdash; Enables / disables container exit on error. This variable is not directly related to logging, but is sometimes useful for troubleshooting. It accepts the following values:
 **'''true''' / '''false''' (default is true).
 ===Redirect to stdout===
-You can optionally enable log redirection to stdout (with Fluent Bit sidecar and No Shared Log Volumes). This is sometimes useful for logs that are not sent to console output by default. To enable this option, set the following parameters in '''values.yaml''':
+You can optionally redirect logs to stdout (with Fluent Bit sidecar and No Shared Log Volumes). Use this option to view logs that are not sent to console output by default. To enable this option, set the following parameters in '''values.yaml''':
 <source lang="bash">#deploy fluentbit sidecar to redirect file logs to stdout?
@@ Line 41: / Line 39: @@
 ===Log Retention===
-Many GCXI logs are written as files to a local volume (for example, by MicroStrategy, GCXI Utils, or Tomcat). GCXI does not perform any cleanup of these files; Genesys recommends that you configuration appropriate log retention policies.
+Many GCXI logs are written as files to a local volume (for example, by MicroStrategy, GCXI Utils, or Tomcat). GCXI does not clean up these files; Genesys recommends that you configure appropriate log retention policies.
 ==RAA logging==
@@ Line 47: / Line 45: @@
 ===Retrieving Logs===
 Optionally, you can:
 *Change the level of log by setting the '''raa.env.LEVEL_OF_LOG''' Helm value.
-*Write logs into a file inside the container by overriding the '''raa.env.LOG''' value.
+*Change the level of log by setting the '''raa.env.LEVEL_OF_LOG''' Helm value.
 For example:
 <source lang="bash">

@@ Line 25: / Line 25: @@
 ===Redirect to stdout===
-You can optionally enable log redirection to stdout (with Fluentbit sidecar and No Shared Log Volumes). This is sometimes useful for logs that are not sent to console output by default. To enable this option, set the following parameters in '''values.yaml''':
+You can optionally enable log redirection to stdout (with Fluent Bit sidecar and No Shared Log Volumes). This is sometimes useful for logs that are not sent to console output by default. To enable this option, set the following parameters in '''values.yaml''':
 <source lang="bash">#deploy fluentbit sidecar to redirect file logs to stdout?
@@ Line 31: / Line 31: @@
 # use emptyDir volume for logs?
 useEmptyDirLogPV: true</source>
 ===Log Retention===
@@ Line 36: / Line 44: @@
 ==RAA logging==
-RAA writes logs to console output by default, which provides integration with tools such as FluentBit, FluentD, LogStash, or New Relic collector.  The default Log level is .:INFO.
+RAA writes logs to console output by default, which provides integration with tools such as Fluent Bit, FluentD, LogStash, or New Relic collector.  The default Log level is .:INFO.
 ===Retrieving Logs===
 Optionally, you can:

@@ Line 23: / Line 23: @@
 *'''DEV_ERR_EXIT''' &mdash; Enables / disables container exit on error. This variable is no directly related to logging, but can be useful for troubleshooting. It accepts the following values:
 **'''true''' / '''false''' (default is true).
 ===Log Retention===

@@ Line 1: / Line 1: @@
 {{Article
 |Standalone=No
@@ Line 6: / Line 8: @@
 |Section={{Section
 |alignment=Vertical
-|structuredtext=GCXI writes logs in the following locations:
+|structuredtext=
 *'''pod stdout''' -- General GCXI logs, which you can use for troubleshooting.
 *'''log''' folder, mounted at <code>/mnt/log</code> -- MicroStrategy logs, which are used only in special cases when requested by MicroStrategy support.
-==Log Level==
+===Log Level===
 Configure the following log-related container variables if required:
 *'''DEV_XTRACE_LEVEL''' &mdash; Enables / disables Bash xtrace level in container stdout. It accepts the following values:
@@ Line 20: / Line 24: @@
 **'''true''' / '''false''' (default is true).
-==Log Retention==
+===Log Retention===
 Many GCXI logs are written as files to a local volume (for example, by MicroStrategy, GCXI Utils, or Tomcat). GCXI does not perform any cleanup of these files; Genesys recommends that you configuration appropriate log retention policies.
 |Status=No
 }}
 |PEPageType=7a5823f3-05b5-412b-b580-e73e34079c41
 }}

@@ Line 6: / Line 6: @@
 |Section={{Section
 |alignment=Vertical
-|structuredtext=
+|structuredtext=GCXI writes logs in the following locations:
 *'''pod stdout''' -- General GCXI logs, which you can use for troubleshooting.
 *'''log''' folder, mounted at <code>/mnt/log</code> -- MicroStrategy logs, which are used only in special cases when requested by MicroStrategy support.
-===Log Level===
+==Log Level==
 Configure the following log-related container variables if required:
 *'''DEV_XTRACE_LEVEL''' &mdash; Enables / disables Bash xtrace level in container stdout. It accepts the following values:
@@ Line 22: / Line 20: @@
 **'''true''' / '''false''' (default is true).
-===Log Retention===
+==Log Retention==
 Many GCXI logs are written as files to a local volume (for example, by MicroStrategy, GCXI Utils, or Tomcat). GCXI does not perform any cleanup of these files; Genesys recommends that you configuration appropriate log retention policies.
 |Status=No
 }}
 |PEPageType=7a5823f3-05b5-412b-b580-e73e34079c41
 }}