Versions Compared

Key

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

...

The JITL MonitoringJob template can be used to perform health checks of JS7 JOC Cockpit, Controller and Agents. Health check results can be forwarded, for example by mail.

  • Users can forward use health check results for integration with their monitoring system.
  • SOS offers a 24/7 Monitoring Service to receive health check results of customers using a commercial license who subscribe to this service, see JS7 - License.

...

  • A ticking cycle is used in order to perform health status checks precisely at the given hour and minute.
  • The cycle runs in hourly intervals for any day days of week.
  • The cycle period starts at midnight and lasts 24 hours.
  • This example results in 24/7 coverage with the health status check being performed every hour.

...

The Retry Instruction is configured like this:


Explanation:

  • If any of the jobs included in the Retry Instruction fails then execution is resumed starting from the first job.
  • Execution is repeated up to 3 times unless successful. The same interval of 1 minute is applied for each retry.


The MonitoringJob makes use of arguments that are explained with chapter Using the Job Wizard for the MonitoringJob.

The MailJob is explained from the JS7 - JITL MailJob article.

Anchor
using_wizard_monitoringjob
using_wizard_monitoringjob
Using the Job Wizard for the MonitoringJob

You can use the job wizard like this:

Image Added


Explanation:

  • Add an empty job from the instruction panel.
  • Specify a name and a label for the job.
  • Select an Agent.

In a next step invoke the job wizard that you find in the upper right corner of the job property editor. The wizard brings up the following popup window:

Image RemovedImage Added


Explanation:

  • From the list of available job templates select the MonitoringJob.

...

Find instructions from the JS7 - JITL MailJob article.

Variables

Job Resources

Return Variables

The MonitoringJob creates a number of return variables that can be used to check the 

...

Use of JS7 - Job Resources to specify mail parameterization is encouraged.

Documentation

The Job Documentation including the full list of arguments can be found under: https://www.sos-berlin.com/doc/JS7-JITL/MonitoringJob.xml

The MonitoringJob class accepts the following arguments:

Arguments

NameRequiredDefault ValuePurposeExample
controller_idno

Optionally specifies the identification of the Controller to be checked. By default the current Controller is used.

controller_prod

monitor_report_dir

yes

Specifies the directory to which the job will store health status report files (.json). The directory has to exist prior to running the job and has to be in reach of the Agent that runs the job. 

    • An absolute or relative path can be specified.
    • An expression can be used., for example  env('JS7_AGENT_DATA') ++ '/monitor' 

env('JS7_AGENT_DATA') ++ '/monitor'

/var/sos-berlin.com/js7/agent/monitor

C:\ProgramData\sos-berlin.com\js7\agent\monitor

monitor_report_max_filesyes
The number of report files created will be limited to this value. Older report files will be removed when this value is exceeded25
fromyes

Specifies the e-mail address that is used to send mail for notices and alerts. The argument is used by the job to create the subject and body return variables.

js7@example.com

Return Variables

NameData TypePurposeExample
monitor_report_dateString

The date and time for which the health status check has been performed. The date format is yyyy-MM-dd.HH-mm-ss.K, for example 2022-07-31.23-12-59.Z indicating UTC time

controller_prod
monitor_report_fileStringThe path to the report file created for the health status check.
subjectString

The subject of an e-mail for use with a later MailJob.


bodyString

The body of an e-mail for use with a later MailJob, by default the value is the same as for the subject.


resultNumberThe number of problems identified during the health status check. A value 0 indicates absence of problems, other values indicate existence of problems.

Further Resources