Introduction

• 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, see JS7 - Order Logs and Task Logs.

Controller

Log file location: logs sub-directory of the Controller installation.

Agent

Log file location: logs sub-directory of the Agent installation.

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 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	30d
  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 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. 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

  • JS7 - Cleanup Service

    	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.

    
    
    

  • JS7 - Cluster Service

    	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.

    
    
    

  • JS7 - Daily Plan Service

    	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.

    
    
    

  • JS7 - History Service

    	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.

    
    
    

  • JS7 - Monitor Service

    	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 from the JS7 - Monitor view and can be forwarded by use of JS7 - Notification.

Log4j2 Configuration Files

Default Locations

The Log4j2 configuration file log4j2.xml is available from the following default locations for the respective JS7 components:

Note:

• Changes to the log4j2.xml file from the above locations will be lost if newer versions of JS7 components are installed.

Optional Locations

The Log4j2 configuration file log4j2.xml with preference is used from the following locations if the file is present:

Note:

• Preferably the above locations are used if changes to the log4j2.xml file are required. Installation of newer releases of JS7 components will not overwrite an existing log4j2.xml file if present with the above locations.
• JS7 ships with example files log4j2.xml-example that are available from above locations. Users can rename this file to log4j2.xml to apply changes to the Log4j2 configuration.
• Changes to the Log4j2 configuration are applied within 60s and do not require the JS7 components to be restarted.