Logging v6.0.2¶

The section refers to the way Quantum Origin will log its output.

Where file-based configuration is used, logging is configurable through logging section of the file.

There are three parameters for logging:

Logging level, defining the verbosity of logging messages: level
Logging mode, defining where to log: mode.
Path, defining where certain logging modes should log: path. Required only for certain logging modes.

Tip

Setting the logging mode to warn or error is generally appropriate for most Production use-cases.

The following are the examples of logging configs used within file-based configurations.

logging:
    level: error
    mode: stderr

logging:
    level: info
    mode: file
    path: /tmp/qo/file.txt

Logging Level¶

Quantum Origin supports different logging levels. The Logging Level defines the verbosity of log messages. The Logging level is configurable by changing the field level under logging section in config file. The following logging levels are supported, listed from most to least verbose.

Logging Levels¶
Level Name	Description
`trace`	Most verbose. Not recommended for production use.
`debug`	Only recommended for troubleshooting.
`info`	Recommended for initial setup and suitable for on-going production use.
`warn`	Recommended for production use.
`error`	Recommended for production use.
`critical`	Not recommended for production use, may not expose error conditions.
`off`	Least verbose. Not recommended.

Logging Mode¶

Quantum Origin supports different logging modes. The logging mode is configurable by changing the field mode under logging section in config file. The following logging modes are supported.

Logging Modes¶
Mode	Description	Requires `path`	Supported Adaptors
`file`	Logs to a specified file	Yes	All
`daily_file`	Logs to a new file on a daily basis (according to local system time).	Yes	All
`stdout`	Logs to standard out on the terminal	No	All
`stderr`	Logs to standard error on the terminal	No	All
`syslog`	Logs to system-defined syslog, usually /var/log/syslog. Only available on OSes that support syslog.	No	All on Unix based OS Only
`event_log`	Log to Windows event log. Only available on Windows OSes	No	All on Windows only.
`inherit`	Log to where exiting spdlog logger is setup to write	No	SDK Only

Note

For any mode where path isn’t required it will be ignored.