Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

Introduction

  • The Monitor Service is used to receive events about executions check the results of the execution of workflows and jobs from any connected Controllers and to add them to the JS7 - HistoryMonitor.
  • As a result the execution history and logs of orders and tasks becomes available, errors and warnings that occur during workflow execution will become visible in the Monitor view of the GUI and can be forwarded by JS7 - Notification. Due to the asynchronous nature of JS7 components products this task is performed by a background service.

...

Monitoring

The Monitor Service inspects the execution history includes reporting information about workflows, orders and tasks of workflows and jobs including information such as start time, end time and execution result.

Execution Logs

.

The Monitor Service can be configured:

  • to report about successful and failed workflows and jobs,
  • to report about jobs running longer or shorter than expected.

Notifications

Notifications are created based on monitoring results - for example, to report failed workflow executions by e-mail.

More information is available in the JS7 - Notification articleExecution 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 Monitor Service uses the JS7 - History Service connects to the Controller by use of to receive events about workflow execution from a Controller via the Proxy Service , see as described in the JS7 - System Architecture article.

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

Behavior of the Monitor Service in case of Outages

Should If a Controller is not be active or should if the network connection to a Controller is not be available then the History Service will repeatedly try to connect. This behavior continues will continue for minutes, hours and days. The Monitor Service will receive events after successful reconnection of the History Service.

Should a fail-over or switch-over occur with a Controller then this does will not affect the History Service that which 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.

...

The Monitor Service receives events from the active Controller instance accordingly.

Configuration

There are no configuration items for the Monitor Service.

Status
colourYellow
titleTODO

Logging

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