Introduction
The JobScheduler Web Services provide extensive logging for the JOC Cockpit, including the compliance-conform Audit Log. Logging can be configured for each operating area independently, allowing logging performance to be optimized in line with administration requirements.The Apache Log4j logging utility is used in the Web Services.
Log File Location
All JOC Cockpit log files are saved in a common logs
folder.
If the Jetty Web Server provided with the JOC Cockpit installation is installed in its default location then the JOC Cockpit log files will be found in the jetty_base directory. The default paths to this directory are:
/home/[user]/sos-berlin.com/joc
on Linux systems andC:\ProgramData\sos-berlin.com\joc
on Windows.
For more information see the Jetty Installation & Configuration section of the JOC Cockpit - Installation article.
Logging Configuration
Logging for the JOC Cockpit is configured in a log4j.properties
file, which can be found in the jetty_base/resources/joc
directory.
Note that there is also a log4j.properties
file in the jetty/resources
directory. This is a Jetty configuration file and should not be used to configure logging for the JOC Cockpit..
Note that the log4j.properties
file is overwritten during installation so system administrators wishing to change, for example, the location or name of the Audit Log file, will need to take suitable precautions whilst updating the JOC Cockpit.
Default Logging Configuration
By default the JOC Cockpit contains logging configuration information for the following operating areas.
The following code block shows the default log4j configuration:
log4j.reset=true #root logger with console appender. All other loggers inherit from this logger. log4j.rootLogger=info, stdout log4j.appender.stdout = org.apache.log4j.ConsoleAppender log4j.appender.stdout.layout = org.apache.log4j.EnhancedPatternLayout log4j.appender.stdout.layout.ConversionPattern = %d{ISO8601}{Europe/Berlin} %-5p %-16.16t %-44.70c{1.} - %m%n #Set the following loggers to 'debug' to debug the JOC Cockpit log4j.logger.com.sos = info log4j.logger.org.hibernate.SQL = info #Apache and Apache Shiro Logs log4j.logger.org.apache.http = error log4j.logger.org.apache.commons = error log4j.logger.org.apache.shiro = info log4j.logger.org.apache.shiro.session.mgt = error #Logger for hibernate log4j.logger.org.hibernate.hql = error log4j.logger.org.hibernate.event = error log4j.logger.org.hibernate.cfg = error log4j.logger.org.hibernate.type = error log4j.logger.org.hibernate.id = error log4j.logger.org.hibernate.orm.deprecation = error log4j.logger.org.hibernate.engine.transaction.internal.TransactionImpl = info #Logger for audit log log4j.logger.JOCAuditLog=info, audit log4j.additivity.JOCAuditLog = false log4j.appender.audit = org.apache.log4j.FileAppender log4j.appender.audit.layout = org.apache.log4j.EnhancedPatternLayout log4j.appender.audit.layout.ConversionPattern = %d{ISO8601}{Europe/Berlin} %-5p %m%n%throwable{short} #filename of audit log log4j.appender.audit.File = ${jetty.base}/logs/JOCAuditLog.log
Note:
- A number of logger settings are set by default to the error level.This has been done to reduce the amount of information logged.
The Logging Functions
General Log Files
- YYYY_MM_DD.stderrout.log
- This log rotates per restart of the JOC Cockpit and per day. It shows startup messages and error messages. This file should not grow in a considerable way as it used mainly for error messages.
- sos_joc-stderr.YYYY-MM-DD.log and sos_joc-stdout.YYYY-MM-DD.log
- This log is used on Windows systems and contains messages about the Windows Service start/stop.
- start.log
- This log is used on Linux systems.
Audit Log
- JOCAuditLog.log
- This file includes the same information that is visible in the JOC Cockpit from the Audit Log View. All interventions that modify the status of jobs, job chains and orders are written to this file.
- This file is important for compliance purposes and is not rotated.
- Growth should not be harmful as one line of log output is created per user action.
- This file includes the same information that is visible in the JOC Cockpit from the Audit Log View. All interventions that modify the status of jobs, job chains and orders are written to this file.
Installation
- Install*.log
- The log output that is created by the installer.
Security: Distributed Sessions (Cluster Operation)
- asdf
- This
The
TitlesessionDAO = com.sos.auth.shiro.SOSDistributedSessionDAO securityManager.sessionManager.sessionDAO = $sessionDAO
A typical configuration would be:
Title#logger for security log4j.logger.com.sos.auth=debug, shiro log4j.additivity.com.sos.auth= false log4j.appender.shiro = org.apache.log4j.FileAppender log4j.appender.shiro.layout = org.apache.log4j.EnhancedPatternLayout log4j.appender.shiro.layout.ConversionPattern = %d{ISO8601}{Europe/Berlin} %-5p %m%n%throwable{short} #filename of shiro log log4j.appender.shiro.File = ${jetty.base}/logs/JOCShiroLog.log