Configuration: Logging

This section of the configuration file configures DataSource's log files. The log files keep a record of all data and to what destinations the data was sent.

---

log-level

Type: String
Default: INFO

Specify the level at which logs are reported. This can take the following values (in order of decreasing severity/increasing verbosity):

log-level name	Description
CRIT	Reports critical errors that prevent the application from running.
ERROR	Reports serious errors regarding network connections and all errors included in the CRIT log level.
NOTIFY	Reports errors regarding data corruptions and all errors included in the ERROR and CRIT log levels.
WARN	Reports minor errors and all errors included in the NOTIFY, ERROR and CRIT log levels.
INFO	Reports events and information regarding normal operation, and all errors included in the WARN, NOTIFY, ERROR and CRIT log levels.
DEBUG	Reports tracing information and all logs at a higher level.
FINER	Reports more deatiled tracing information and all logs at a higher level.
FINEST	Reports more deatiled tracing information and all logs at a higher level.

---

log-monitor-level

Type: String
Default: CRIT

Default logging level to send log events to monitoring

---

log-syslog-level

Type: String
Default: ERROR

log-syslog-level specifies the level of the logs that are reported to the system log when this DataSource application is running.

You can override this setting by specifying the syslog-level option of the add-log configuration item.

system log

On Linux system logs are written to the Linux system log. On Windows the logs are written to the Windows event log.

Note

The log-level item, and level option of add-log (if specified) take precedence over log-syslog-level. For example, if log-syslog-level is set to DEBUG but log-level is set to INFO, only log messages with severity INFO or higher go the system log.

---

log-dir

Type: String
Default: %r/var

Default directory in which to store log files. %r is replaced by application-root, %a will be replaced by application-name.

---

log-maxsize

Type: Integer
Default: 0

Maximum log file size in bytes. The log files will be cycled if they exceed the size specified here; therefore a value of 0 means log files will cycle every time they are checked.

---

log-maxfiles

Type: Integer
Default: 0

Log file, max number of files

---

log-cycle-time

Type: Integer
Default: 240

Time at which logs will cycle, in minutes from midnight.

---

log-cycle-period

Type: Integer
Default: 1440

Interval between cycling logs, in minutes.

---

log-cycle-suffix

Type: String
Default: .%u

Suffix for cycled logs. This is passed through strftime (refer to your UNIX manual for further information on strftime). The default of %u results in a file beiang created for each day of the week.

---

log-cycle-offset

Type: Integer
Default: -1

Specifies how many minutes to take off the current time when creating the suffix. For example, if cycling at 0400 hours, the time passed into strftime to create the suffix will be 0400 hours the previous day.

---

log-max-history

Type: Integer
Default: 10

Max number of log lines to retain for monitoring

---

log-buffer

Type: Integer
Default: -1

Specify buffering behaviour globally for all logs. This can be overridden on a per log basis using buffer

-1: [Default] Disable buffering for logs, write directly to disk
 0: Enable line buffering.
>0: Enable block buffering of configured number of bytes. Buffer is flushed to disk once it is full.

Note

When the binary crashes, it is possible that not all the log lines have been flushed to disk. These log lines can be retrieved from a core file if one is created, contact Caplin Support for assistance.

Block buffering (>0) is not available on Windows.

---

log-buffer-flush-level

Type: String
Default: None

Specify the minimum level at which application log buffers are to be flushed. If e.g. ERROR is set as the threshold, then ERROR and CRIT logs will cause the buffer to be flushed. This feature is turned off by default meaning buffers are only flushed when they're full or the application terminates normally, for log levels and accepted values see log-level.

Note

In cases where large log buffers are configured, e.g. ERROR logs may not appear in the log file for a significant time logs may not appear in the log file for a significant time logs may not appear in the log file for a significant time logs may appear in the log file with a significant delay, this configuration avoids this issue for certain severity levels such that log analysis tools can react to certain levels immediately.

---

log-category-filter

Type: String
Default: ALL

Category filter string

---

foreground-logs

Type: Boolean
Default: FALSE

Output event logs to the terminal

---

add-log

Configuration group add-log

As well as the global configuration options for log files, individual log files may be configured individually. This option overrides the global default for a particular logfile.

Format:

add-log
    name                [value]
    maxsize             [value]
    time                [value]
    period              [value]
    suffix              [value]
    offset              [value]
    level               [value]
    monitor-level       [value]
    buffer              [value]
    buffer-flush-level  [value]
end-log

name

Type: String
Default: None

Name of log

---

maxsize

Type: Integer
Default: -559038737

Log file max size

---

maxfiles

Type: Integer
Default: -559038737

Log file, max number of files

---

time

Type: Integer
Default: -559038737

Log Cycle Time

---

period

Type: Integer
Default: -1

Log Cycle Period

---

suffix

Type: String
Default: None

Log Cycle Suffix

---

offset

Type: Integer
Default: -559038737

Log Cycle Offset

---

level

Type: String
Default: None

Log level

---

monitor-level

Type: String
Default: None

Log level to to push log events to monitoring

---

syslog-level

Type: String
Default: None

Logging level to send log events to syslog

---

buffer

Type: Integer
Default: -559038737

Specify buffering for specific logs

-2: [Default] Inherit global settings
-1: Disable buffering for logs, write directly to disk
 0: Enable line buffering.
>0: Enable block buffering of configured number of bytes

Note

This option overrides the global option log-buffer. Please refer to it for more details on using buffered logs.

---

buffer-flush-level

Type: String
Default: INHERIT

Override the global log-buffer-flush-level setting for specific logs.

The default value of this option is "INHERIT" indicating that the global setting shall be inherited.

---

category-filter

Type: String
Default: None

Category filter string

---

---