Skip to end of metadata
Go to start of metadata

Introduction

Controller

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


Main LogDebug LogWatchdog Log
Log Filecontroller.logcontroller-debug.logwatchdog.log
Log Rotationdailydailynone
Log Retention30d30dnone
PurposeThe Controller log file holds all log output from the Controller including cluster state information and coupling events. The watchdog log file is rewritten when the Controller is started. It contains any output produced before the Controller log file becomes active and indicates occurrence of restarts that are automatically performed in case of abnormal termination.

Agent

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


Main LogDebug LogWatchdog Log
Log Fileagent.logagent-debug.logwatchdog.log
Log Rotationdailydailynone
Log Retention30d30dnone
PurposeThe Agent log file holds all log output from the Agent including, for example, reconnection attempts and coupling events. The watchdog log file is rewritten when the Agent is restarted. It contains any output produced before the Agent log file becomes active and indicates occurrence of restarts that are automatically performed in case of abnormal termination.


In addition, the following log file can be activated for YADE file transfer jobs.

  • YADE Log


    Main Log
    Log Fileyade.log
    Log Rotationwith each (re)start
    Log Retention0d
    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 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 Filejetty.log
    Log Rotationwith each (re)start
    Log Retention30d
    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 caused by wrong configuration of the log4j2.xml file.



  • JOC Cockpit Log


    Main LogDebug Log
    Log Filejoc.logjoc-debug.log
    Log Rotationdailydaily
    Log Retention30d30d
    PurposeThe log file holds log output created by the JOC Cockpit application. This log file includes detailed information for problems occurring during operation of the JOC Cockpit such as problems with database connections.



  • Audit Log


    Main Log
    Log Fileaudit.log
    Log Rotationmonthly
    Log Retentionunlimited
    Purpose

    The JS7 - Audit Log stores information about any changes to the state of objects, such as deployment of workflows, cancelling and suspending of orders etc. Note that information from the audit log file can be subject to compliance requirements.



  • Authentication Log


    Debug Log
    Log Fileauthentication-debug.log
    Log Rotationdaily
    Log Retention30d
    Purpose

    This log is available for debug output only. It provides detailed information about logins to the JOC Cockpit including connections to LDAP Directory Services for authentication.



  • Connection Pool Log


    Debug Log
    Log Fileconnection-pool-debug.log
    Log Rotationdaily
    Log Retention30d
    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 LogDebug Log
      Log Fileservice-cleanup.logservice-cleanup-debug.log
      Log Rotationdailydaily
      Log Retention30d30d
      PurposeThe service cleans up entries from the order and task history, deployment history, daily plan history and audit log.



    • JS7 - Cluster Service


      Main LogDebug Log
      Log Fileservice-cluster.logservice-cluster-debug.log
      Log Rotationdailydaily
      Log Retention30d30d
      PurposeThe service operates the JOC Cockpit cluster and performs switch-over and fail-over operations when required.



    • JS7 - Daily Plan Service


      Main LogDebug Log
      Log Fileservice-dailyplan.logservice-dailyplan-debug.log
      Log Rotationdailydaily
      Log Retention30d30d
      PurposeThe service plans orders from schedules and submits orders to Controllers.



    • JS7 - History Service


      Main LogDebug Log
      Log Fileservice-history.logservice-history-debug.log
      Log Rotationdailydaily
      Log Retention30d30d
      PurposeThe 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 LogDebug Log
      Log Fileservice-monitor.logservice-monitor-debug.log
      Log Rotationdailydaily
      Log Retention30d30d
      PurposeThe service monitors workflow execution and reports errors and warnings. This information is available in the JS7 - Monitor view and can be forwarded using JS7 - Notification.

Log4j2 Configuration Files

Default Locations

The Log4j2 configuration file, log4j2.xml, is available in the following default locations for the JS7 components shown:


WindowsUnix
ControllerC:\Program Files\sos-berlin.com\js7\controller\lib\log4j2.xml/opt/sos-berlin.com/js7/controller/lib/log4j2.xml
AgentC:\Program Files\sos-berlin.com\js7\agent\lib\log4j2.xml/opt/sos-berlin.com/js7/agent/lib/log4j2.xml
JOC CockpitC:\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 components are installed.

Optional Locations

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


WindowsUnix
ControllerC:\ProgramData\sos-berlin.com\js7\controller\var\config\log4j2.xml/var/sos-berlin.com/js7/controller/var/config/log4j2.xml
AgentC:\ProgramData\sos-berlin.com\js7\agent\var_<port>\config\log4j2.xml/var/sos-berlin.com/js7/agent/var_<port>/config/log4j2.xml
JOC CockpitC:\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 components will not overwrite existing log4j2.xml files present in the above locations.
  • JS7 ships with log4j2.xml-example example files that are available at above locations. Users can rename these files 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.


Write a comment…