Purpose

• The Monitor Service is used to receive events about executions of workflows and jobs from any connected Controllers and to add them to the JS7 - History.
• As a result the execution history and logs of orders and tasks becomes available. Due to the asynchronous nature of JS7 components this task is performed by a background service.

Execution History

The execution history includes reporting information about workflows, orders and tasks such as start time, end time and execution result.

Execution Logs

Execution logs are provided for orders and tasks. Log output is added to the reporting database and is accessible from the JS7 - History.

Interaction with Controller

The History Service connects to the Controller by use of the Proxy Service, see JS7 - System Architecture.

For any subscribed History Service instance the Controller holds events occurring from JS7 - Order State Transitions and forwards them to the History Service. After any subscribed History Service instances received events and confirmed receipt by releasing events then the Controller will drop events from its journal.

Behavior of the Monitor Service in case of Outages

Should a Controller not be active or should the network connection to a Controller not be available then the History Service will repeatedly try to connect. This behavior continues for minutes, hours and days.

Should a fail-over or switch-over occur with a Controller then this does not affect the History Service that is automatically routed to the active Controller instance by use of the Proxy Service.

Behavior of the Controller in case of Outages

Should the History Service not be active and therefore not release events then such events will remain with the Controller and will fill-up its journal. Events include any log output that is created from jobs and workflow instructions. Users should make an assumption about the maximum duration of an outage of the History Service during periods of high job frequency. The Controller's journal will grow as large as allowed within the limits of the file system. Due to the fact that individual log output of jobs is included and that jobs are executed at individual frequencies we cannot give an estimate of the growth rate. However, reserving a few GB disk space for both the Primary and Secondary Controllers' journals is required.

• It is desired that during an outage of the History Service or of the connection between History Service and Controller no events will be lost. 
• Should users operate jobs with considerable log output at medium frequencies, e.g. > 10 000 jobs per hour, then sufficient disk space should be made available. There is no problem in having a Controller journal exceed e.g. 30 GB of disk space. The journal will shrink automatically after events have been processed and have been released by the History Service.

Configuration

Location

• The "Settings" menu is available from the JOC Cockpit GUI.

Configuration Items

• No configuration items are required.
• A number of configuration items can optionally be used.

TODO

Logging

• The Monitor Service logs general messages, warnings and errors to the joc.log file.
• More detailed information in addition is logged to the Main Log service-monitor.log file.
• In addition to the Main Log detailed debug information is logged to the Debug Log service-monitor-debug.log file.
• For details see JS7 - Log Files and Locations