9.4

Edit

Reference for log level modifications

The Reference explains advanced installer configuration to finely control a log level of specific components.

Log level type mappings

There is a mapping between log level type (prod/warn) and log level (DEBUG, INFO, WARN, ERROR) and it is specified in the group_vars/all/vars.yml file.

log_config:
  <component>:
    file: <filename>
    loggers:
      <loggername1>:
        prod: <loglevel>
        dev: <loglevel>
      <loggername2>:
        prod: <loglevel>
        dev: <loglevel>
    appender:
      <appendername1>:
        prod: <loglevel>
        dev: <loglevel>

Log Levels

The values possible to use in prod and dev dictionary are:

OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL

Components

This is a complete list of currently supported components:

  • ocr-worker (OCR Worker service on OCR)

  • ocr-rest (OCR Rest service on OCR)

  • ocr-task (OCR Task process on OCR)

  • sqc (SQC service on APP)

  • wfbi (WFBI service on APP)

  • wfagent (Platform Monitor service on APP, DB, OCR, ML, APM)

  • workspace (WorkSpace on APP)

  • workfusion (Control Tower on APP)

  • vds (VDS services on ML)

WorkFusion component.

  workfusion:
    file: 'log4j.xml'
    loggers:
      root:
        prod: 'warn'
        dev:  'debug'
      com.workfusion.utils.logger.ConfigLogger:
        prod: 'warn'
        dev:  'debug'
      ...
      ...
      com.freedomoss.requester.service.task.impl.HitService:
        prod: 'warn'
        dev:  'debug'
    appender:
      root:
        prod: 'warn'
        dev:  'debug'
      ...
      ...
      crowdcontrol:
        prod: 'warn'
        dev:  'debug'

Any new class that was added to loggers will be added to the log4j.xml file with prod or dev log level types. If the class already exists in the original log4j.xml configuration file, it will be correctly modified by the script.

Appender also can be configured but new can't be created via this dictionary. Value from the root section will be applied threshold for all available appenders in the log4j.xml file. If some appender does not contain threshold parameter by design, it is possible to add this class to appender dictionary and threshold param will be automatically added to appropriate appender in log4j.xml.

WorkSpace component

  workspace:
    production:
      file: 'log4j.properties'
      loggers:
        root:
          prod: 'error, S, virtualizer'
          dev:  'error, S, virtualizer'
        log4j.logger.com.freedomoss.virtualizer:
          prod: 'warn'
          dev:  'info'
        ...
        ...
        log4j.logger.org.apache.cxf:
          prod: 'warn'
          dev:  'info'
      appender:
        root:
          prod: 'warn'
          dev:  'info'
    sandbox:
    ...
    ...
← PreviousNext →