Scope
- JS7 provides a number of log files for Controller, Agent and JOC Cockpit.
- Log files are subject to log rotation, see JS7 - Log Rotation
- To control log levels see JS7 - Log Levels and Debug Options
- Note that log output from orders and jobs in a workflow is not stored with log files but is immediately added to the JS7 - Database and JS7 - History respectively.
Controller
Log file location: logs
sub-directory of the Controller installation.
Main Log | Debug Log | Watchdog Log | |
---|---|---|---|
Log File | controller.log | controller-debug.log | watchdog.log |
Log Rotation | daily | daily | none |
Log Retention | 30d | 30d | none |
Purpose | The controller log file holds any log output of the Controller including cluster state information and coupling events. The watchdog log file is rewritten on start of the Controller, states any output before the Controller log files becomes active and indicates occurrences of restarts that are automatically performed in case of abnormal termination. |
Agent
Log file location: logs
sub-directory of the Agent installation.
Main Log | Debug Log | Watchdog Log | |
---|---|---|---|
Log File | agent.log | agent-debug.log | watchdog.log |
Log Rotation | daily | daily | none |
Log Retention | 30d | 30d | none |
Purpose | The agent log file holds any log output of the Agent including e.g. reconnection attempts and coupling events. The watchdog log file is rewritten on start of the Agent, states any output before the Agent log files become active and indicates occurrences of restarts that are automatically performed in case of abnormal termination. |
In addition, for YADE file transfer jobs the following log file can be activated
YADE Log
Main Log Log File yade.log
Log Rotation with each (re)start Log Retention 0d Purpose The log file holds log output of YADE that corresponds to the task .log created for the job. Therefore this log file by default is not active. The log file can be activated by adjusting the ./lib/log4j2.xml configuration file in the YADE installation directory to use a log level INFO or higher. By default YADE is installed with the Agent in the
yade
sub-directory of the Agent's home directory.
JOC Cockpit
- Log file location:
logs
sub-directory of the JOC Cockpit installation. Jetty Log
Main Log Log File jetty.log
Log Rotation with each (re)start Log Retention d Purpose The log file holds log output created on start-up of the servlet container. If the Jetty servlet container won't start then this is the log file to check for errors. Also, it may contain errors due to misconfiguration of the ./resources/joc/log4j2.xml
JOC Cockpit Log
Main Log Debug Log Log File joc.log
joc-debug.log
Log Rotation daily daily Log Retention 30d 30d Purpose The log file holds log output created by the JOC Cockpit application. This log file includes detailed information for problems occurring during operation of JOC Cockpit, e.g. with database connections, . Audit Log
Main Log Log File audit.log
Log Rotation monthly Log Retention unlimited Purpose The JS7 - Audit Log stores information about any changes to the state of objects, such as deploying workflows, cancelling and suspending orders etc. Note that information from the audit log file can be subject to compliance requirements.
Authentication Log
Debug Log Log File authentication-debug.log
Log Rotation daily Log Retention 30d Purpose This log is available for debug output only. It provides detailed information about login to JOC Cockpit including connections to LDAP Directory Services for authentication.
Connection Pool Log
Debug Log Log File connection-pool-debug.log
Log Rotation daily Log Retention 30d Purpose This log is available for debug output only. It provides detailed information about session management of the connection pool that handles database connections.
- Service Logs
Main Log Debug Log Log File service-cleanup.log
service-cleanup-debug.log
Log Rotation daily daily Log Retention 30d 30d Purpose The service cleans up entries from the order and task history, deployment history, daily plan history and audit log. Main Log Debug Log Log File service-cluster.log
service-cluster-debug.log
Log Rotation daily daily Log Retention 30d 30d Purpose The service operates the JOC Cockpit cluster and performs switch-over and fail-over operations when required. Main Log Debug Log Log File service-dailyplan.log
service-dailyplan-debug.log
Log Rotation daily daily Log Retention 30d 30d Purpose The service plans orders from schedules and submits orders to Controllers. Main Log Debug Log Log File service-history.log
service-history-debug.log
Log Rotation daily daily Log Retention 30d 30d Purpose The service receives events about order state transitions and log output of underlying jobs from Controllers and adds them to the history.