Jump to: navigation, search

iWD History Node Configuration Options

[server] Section

  • single-host-bind
    • Data Type—boolean
    • Description—Determines which address History Node listens on.
    • Valid values:
      • true—History Node will be listening only on the address specified in Server Info.
      • false—History Node will be listening on all available addresses on the machine (that is, 0.0.0.0)
    • Default value—false

[iWD] Section

  • processor-threads
    • Data Type—Integer
    • Description—Number of threads used for events processing.
    • Valid values—Integer greater than 0
    • Default value—10
  • receive-timeout
    • Data Type—Integer
    • Description—Number of milliseconds since last event receive from JMS queue after which cached events will be flushed to the history database.
    • Valid values—Integer greater than 0
    • Default value—10
  • batch-size
    • Data Type—Integer
    • Description—Maximum number of events which will be saved at once in the history database. Note: one event translates to 1 or 2 rows written to the database (depending on configuration).
    • Valid values—Integer greater than 0
    • Default value—1000
  • stop-processing
    • Data Type—String
    • Description—Determines how History Node should handle stopped interactions' GTL events.
    • Valid values—
      • keep—GTL events will be kept in History Node database.
      • remove—GTL events will be removed from History Node database.
    • Default value—keep
  • stop-processing-interval
    • Data Type—Integer
    • Description—Number of seconds defining frequency of the checking for stopped interactions.
    • Valid values—Integer greater than 0
    • Default value—60
  • stop-processing-delay
    • Data Type—Integer
    • Description—Number of minutes after which interactions 'stop processing' event will be handled.
    • Valid values—Integer greater than 0
    • Default value—60
  • process-gtl
    • Data Type—Boolean
    • Description—Determines whether GTL history events should be processed and saved in the history database.
    • Valid values—true, false
    • Default value—true
  • process-dm
    • Data Type—Boolean
    • Description—Determines whether Data Mart events should be processed and saved in the history database.
    • Valid values—true, false
    • Default value—true
  • migrate-schema
    • Data Type—Boolean
    • Description—Determines whether database schema should be migrated (i.e. updated) during application start.
    • Valid values—true, false
    • Default value—false

[log] section

level

  • Mandatory—no
  • Default valueINFO
  • Type—String
  • Valid valuesOFF, ERROR, WARN, INFO, DEBUG, TRACE and ALL
  • Description—Log level

time-zone

  • Mandatory—no
  • Default valueUTC
  • Type—String
  • Valid values—The ID for a time zone, either an abbreviation such as PST, a full name such as America/Los_Angeles, or a custom ID such as GMT-8:00
  • Description—The time zone to which event timestamps will be converted.

log-to-console

  • Mandatory—no
  • Default valuefalse
  • Type—Boolean
  • Valid valuestrue, false
  • Description—Determines whether to log events to the console.

console-log-level

  • Mandatory—no
  • Default valuefalse
  • Type—String
  • Valid valuesOFF, ERROR, WARN, INFO, DEBUG, TRACE and ALL
  • Description—Console appender log level. If not set, logger level is used. Appender level can narrow down logger level but not extend it. For example, if logger level is INFO, it makes sense to set WARN or ERROR appender level, whereas if you set appender level to TRACE or DEBUG it has no effect.

centralized-logging

  • Mandatory—no
  • Default valuefalse
  • Type—Boolean
  • Valid valuestrue, false
  • Description—Determines whether to log events to Message Server.

centralized-log-level

  • Mandatory—no
  • Default valueSTANDARD
  • Type—String
  • Valid valuesSTANDARD, ALARM
  • Description—Centralized appender log level. Centralized appender supports only levels higher than or equal to INFO. STANDARD level corresponds to INFO, so INFO, WARN and ERROR logs will be sent to Message Server, ALARM level corresponds to ERROR log level.

log-to-file

  • Mandatory—no
  • Default valuetrue
  • Type—Boolean
  • Valid valuestrue, false
  • Description—Determines whether to log to a file.

file-log-level

  • Mandatory—no
  • Default value
  • Type—String
  • Valid valuesOFF, ERROR, WARN, INFO, DEBUG, TRACE and ALL
  • Description—File appender log level. If not set, logger level is used. Appender level can narrow down logger level but not extend it. For example, if logger level is INFO, it makes sense to set WARN or ERROR appender level, whereas if you set appender level to TRACE or DEBUG it has no effect.

log-filename

  • Mandatory—no
  • Default value/GCTI/iWD/iwd_manager.log
  • Type—String
  • Valid values
  • Description—The path to the file where current events are logged.

archive

  • Mandatory—no
  • Default valuefalse
  • Type—Boolean
  • Valid valuestrue, false
  • Description—Determines whether to archive old events in separate files. Archived filenames are set to <log-filename without extension>-%d-%i<log-filename extension> if option file-max-size has a value, otherwise they are set to <log-filename without extension>-%d<log-filename extension>.

max-file-size

  • Mandatory—no
  • Default value
  • Type—String
  • Valid values
  • Description—The maximum size of the currently active file before a rollover is triggered. Note: Used if the value of archive is true. The value can be expressed in bytes, kilobytes, megabytes or gigabytes by suffixing a numeric value with KB, MB and respectively GB. For example, 5000000, 5000KB, 5MB and 2GB are all valid values, with the first three being equivalent.

max-history

  • Mandatory—no
  • Default value0 (zero)
  • Type—Integer
  • Valid values—Integer greater than or equal to 0 (zero means to keep infinite number of files)
  • Description—Controls the maximum number of days for archive files to keep, asynchronously deleting older files.

[access-log] Section

time-zone

  • Mandatory—no
  • Default valueUTC
  • Type—String
  • Valid values—The ID for a time zone, either an abbreviation such as PST, a full name such as America/Los_Angeles, or a custom ID such as GMT-8:00
  • Description—The time zone to which event timestamps will be converted.

log-to-console

  • Mandatory—no
  • Default valuefalse
  • Type—Boolean
  • Valid valuestrue, false
  • Description—Determines whether to log events to the console.

log-to-file

  • Mandatory—no
  • Default valuetrue
  • Type—Boolean
  • Valid valuestrue, false
  • Description—Determines whether to log to a file.

log-filename

  • Mandatory—no
  • Default value/GCTI/iWD/iwd_manager.log
  • Type—String
  • Valid values
  • Description—The path to the file where current events are logged.

archive

  • Mandatory—no
  • Default valuefalse
  • Type—Boolean
  • Valid valuestrue, false
  • Description—Determines whether to archive old events in separate files. Archived filenames are set to <log-filename without extension>-%d-%i<log-filename extension> if option file-max-size has a value, otherwise they are set to <log-filename without extension>-%d<log-filename extension>.

max-file-size

  • Mandatory—no
  • Default value
  • Type—String
  • Valid values
  • Description—The maximum size of the currently active file before a rollover is triggered. Note: Used if the value of archive is true. The value can be expressed in bytes, kilobytes, megabytes or gigabytes by suffixing a numeric value with KB, MB and respectively GB. For example, 5000000, 5000KB, 5MB and 2GB are all valid values, with the first three being equivalent.

max-history

  • Mandatory—no
  • Default value0 (zero)
  • Type—Integer
  • Valid values—Integer greater than or equal to 0 (zero means to keep infinite number of files)
  • Description—Controls the maximum number of days for archive files to keep, asynchronously deleting older files.
This page was last modified on March 19, 2019, at 12:51.

Feedback

Comment on this article:

blog comments powered by Disqus