Logging

From Genesys Documentation
Revision as of 18:29, September 1, 2021 by Tony.gilchrist@genesys.com (talk | contribs) (Published)
Jump to: navigation, search
This topic is part of the manual Genesys Customer Experience Insights Private Edition Guide for version Current of Reporting.

Learn how to access logs for Genesys Customer Experience Insights (GCXI).

GCXI logging

GCXI writes logs in the following locations:

  • pod stdout -- General GCXI logs, which you can use for troubleshooting.
  • log folder, mounted at /mnt/log -- MicroStrategy logs, which are used only in special cases when requested by MicroStrategy support.

Log Level

Configure the following log-related container variables if required:

  • DEV_XTRACE_LEVEL — 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)
    • ALL = full bash xtrace. Caution: everything, including passwords, is visible in console log. This can be necessary in some troublshooting scenarios.
  • DEV_ERR_EXIT — 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

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.

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.

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.

For example:

raa:
  ...
  env:
    ...
    LOG: "/genesys/raa_health/aggregator.log"
    LEVEL_OF_LOG: ".:FINEST"
  ...

For more information, see the option level-of-log, and the Logging overview and approaches documentation.

Comments or questions about this documentation? Contact us for support!