Page History
Table of Contents |
---|
...
Introduction
- JS7 provides a number of log files for the Controller, Agent and the JOC Cockpit.
- Log files are subject to log rotation, see seethe JS7 - Log Rotation article.
- To control log levels see see the JS7 - Log Levels and Debug Options article.
- Consider Note that log output of from orders and jobs in a workflow are is not stored with log files but are is immediately added to the JS7 - Database and JS7 - History respectively. , see the JS7 - Order Logs and Task Logs article for more information.
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 Controller log file holds any all log output of from the Controller including cluster state information and coupling events. The watchdog log file is rewritten on start of when the Controller , states is started. It contains any output produced before the Controller log files file becomes active and indicates occurrences occurrence of restarts that are automatically performed in case of abnormal termination. |
...
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 Agent log file holds any all log output of from the Agent including e.g. , for example, reconnection attempts and coupling events. The watchdog log file is rewritten on start of when the Agent , states is restarted. It contains any output produced before the Agent log files become file becomes active and indicates occurrences occurrence 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 for YADE file transfer jobs.
YADE Log
Main LogLog File Log File yade.log
Log RotationLog Rotation with each (re)start Log RetentionLog 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 is 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 theyade
sub-directory of the Agent's home directory.
...
- 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 dn/a Purpose The log file holds log output created on start-up of the servlet container. If the Jetty servlet container wouldnwon't start then this is the log file to check for errors. Also, it may contain errors due to misconfiguration caused by wrong configuration of the ./resources/joc/
log4j2.xml
file.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. For This log file includes detailed information for problems occurring during operation of the JOC Cockpit , e.g. such as problems with database connections, this log file includes detailed information. 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 deployment of workflows, cancelling and suspending of orders etc. Consider 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 logins to the 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. Main Log Debug Log Log File service-monitor.log
service-monitor-debug.log
Log Rotation daily daily Log Retention 30d 30d Purpose The service monitors workflow execution and reports errors and warnings. This information is available in the JS7 - Monitor view and can be forwarded using JS7 - Notifications. JS7 - Report Service
Main Log Debug Log Log File service-reports.log
service-reports-debug.log
Log Rotation daily daily Log Retention 30d 30d Purpose The service runs reports and indicates errors and warnings during report execution.
Log4j2 Configuration Files
Default Locations
The Log4j2 configuration file, log4j2.xml
, is available in the following default locations for the JS7 products shown:
Windows | Unix | |
---|---|---|
Controller | C:\Program Files\sos-berlin.com\js7\controller\lib\log4j2.xml | /opt/sos-berlin.com/js7/controller/lib/log4j2.xml |
Agent | C:\Program Files\sos-berlin.com\js7\agent\lib\log4j2.xml | /opt/sos-berlin.com/js7/agent/lib/log4j2.xml |
JOC Cockpit | C:\ProgramFiles\sos-berlin.com\js7\joc\lib\log4j2.xml | /opt/sos-berlin.com/js7/joc/lib/log4j2.xml |
Note:
- Changes to the
log4j2.xml
file from the above locations will be lost if newer versions of JS7 products are installed.
Optional Locations
The Log4j2 configuration file, log4j2.xml
, is used with preference from the following locations if it is available:
Windows | Unix | |
---|---|---|
Controller | C:\ProgramData\sos-berlin.com\js7\controller\var\config\log4j2.xml | /var/sos-berlin.com/js7/controller/var/config/log4j2.xml |
Agent | C:\ProgramData\sos-berlin.com\js7\agent\var_<port>\config\log4j2.xml | /var/sos-berlin.com/js7/agent/var_<port>/config/log4j2.xml |
JOC Cockpit | C:\ProgramData\sos-berlin.com\js7\joc\jetty_base\resources\joc\log4j2.xml | /var/sos-berlin.com/js7/joc/jetty_base/resources/joc/log4j2.xml |
Note:
- Use of the above locations is preferred if changes to the
log4j2.xml
file are required. Installation of newer releases of JS7 products will not overwrite existinglog4j2.xml
files present in the above locations. - JS7 ships with l
og4j2.xml-example
example files that are available at above locations. Users can rename these files tolog4j2.xml
to apply changes to the Log4j2 configuration. - Changes to the Log4j2 configuration are applied within 60s and do not require the JS7 products to be restarted.