Versions Compared

Key

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

...

  • Active Checks are initiated from the System Monitor server and are performed on a regular basis, e.g. every 5 minutes.
    • The purpose of Active Checks is to verify the availability of the JS7 components. 
    • This type of check does not provide information about the execution status of individual jobs.
    • The System Monitor Plugins explained in this article are intended for Active Checks only.
  • Passive Checks are initiated from the JOC Cockpit and report execution results of workflows and jobs to a System Monitor.
    • This mechanism is by far more accurate and efficient than polling the JS7 History for failed workflows and jobs.
    • The JobScheduler Monitoring Interface is a complete solution for the management of complex Passive Checks.
  • Both Active Checks and Passive Check make use of the JS7 - REST Web Service API. For efficiency the checks are implemented with Perl. 

Download and Installation of the Plugins

...

Option

Option (long format)

Data TypeRequired

Default

Description

-j--joc-urlStringyesURL of JOC Cockpit (HTTP and HTTPS are supported)
-i--idStringyesID of a JS7 Controller
-a--accountStringyesAccount for HTTP authentication to JOC Cockpit (<user:password>)

-A

--agent

Stringno

URL of an Agent, optional,  can be specified several times

-c

--cafile

Stringno

Location of a certificate file or a CA bundle file to verify the SSL connection to JOC Cockpit

-C

--capath

Stringno

Path to a directory that includes certificate files or CA bundle files to verify the SSL connection to JOC Cockpit

-s--hostname-verificationSwitchnofalseThis switch activates SSL hostname verification (recommended)

-t

--timeout

Numberno

30

Timeout in seconds for establishing the connection to JOC Cockpit

-d--detailedSwitchnofalse

This switch causes status information for each Agent instance to be returned individually

...

  • check_js7_agent.pl calls an optional script report_js7_agent.pl per Agent.
  • This script does not connect to JOC Cockpit or perform any checks but simply serves to create individual notifications per Agent to the System Monitor.
  • The script is executed if it is available from the same directory as the calling script and has to be executable.
  • The script is parameterized to transfer the message type and notification to the System Monitor. Positional arguments are used.
    • report_js7_agent.pl <joc-cockpit-url> <controller-id> <agent-url> <agent-status>
    • <joc-cockpit-url> is the URL that has been specified as a parameter to the script check_js7_agent.pl
    • <controller-id> is the Controller ID that has been specified as a parameter to the script check_js7_agent.pl
    • <agent-url> is the URL identifying the Agent
    • <agent-status> is one of "COUPLED" , "RESETTING", "RESET", "COUPLINGFAILED", "UNKNOWN"

      Code Block
      languageperl
      titleExample report_js7_agent.pl
      #!/usr/bin/env perl
      use strict;
      use warnings;
       
      my ($jocUrl, $controllerId, $agentUrl, $agentStateText) = @ARGV;
      # do something with $jocUrl, $controllerId, $agentUrl, $agentStateText

...