This version of the manual refers to an earlier version of the software.

Logging

Application Log

Log Levels

The log.application.level configuration key specifies the severity threshold beneath which log messages will be discarded. Available values, in order of importance, are: trace, debug, info, warn, and error.

Additionally, all can be used to log absolutely everything.

To completely disable the application log, use off.

Appenders

Appenders direct log messages to various destinations, like files and/or the console. (The default configuration file logs only to the console.) There are several available appenders, which can be enabled or disabled in any combination.

ConsoleAppender

ConsoleAppender logs to the console. Set the log.application.ConsoleAppender.enabled configuration key to true or false to enable or disable.

FileAppender

FileAppender logs to a single file. Use the log.application.FileAppender.enabled key to enable or disable, and the log.application.FileAppender.pathname key to set the absolute pathname of the log file.

RollingFileAppender

RollingFileAppender logs to a file that rolls over periodically (to avoid creating a single huge file). Use the log.application.RollingFileAppender.enabled key to enable or disable, and the log.application.RollingFileAppender.pathname key to set the absolute pathname of the primary log file.

Currently, the only available rolling policy (log.application.RollingFileAppender.policy) is TimeBasedRollingPolicy, which rolls over the log file based on the value of log.application.RollingFileAppender.TimeBasedRollingPolicy.filename_pattern. log.application.RollingFileAppender.TimeBasedRollingPolicy.max_history defines how many rolled-over log files will be kept.

SyslogAppender

SyslogAppender appends log messages to the syslog, managed by syslogd, on a local or remote host.

Access Log

Access logs are written in the W3C Extended Log File Format. To enable the access log, set the value of log.access.ConsoleAppender.enabled to true—or, if you are running Cantaloupe behind a reverse proxy server or in a Servlet container that manages its own access logs, false.

Access log appenders work the same as application log appenders.