Table of Contents

Introduction

System Monitors are tools that execute repeated checks for the availability of software componentsproducts.
- For example, Nagios® is an Open Source System Monitor that is available at http://www.nagios.org.
- An ecosystem of more or less compatible System Monitors has evolved, e.g. op5®, Checkmk checkmk® and many others.
Users can monitor JS7 by use of with both Open Source licensed products and by commercially licensed products that to check the availability of the JOC Cockpit, Controller and Agents..

Active

...

and Passive Checks

Active Checks are initiated from the System Monitor server and are performed on a regular basis, e.g. every 5 minutes.
- The only purpose of Active Checks is to verify the availability of the JobScheduler applicationJS7 products.
- This type of check does not provide information about the execution status of individual jobs.
- Active Checks make use of the JS7 - REST Web Service API. For efficiency the checks are implemented with Perl.
- The System Monitor Plugins explained described in this article are intended for Active Checks only.
Passive Checks are initiated from JobScheduler the JOC Cockpit and report individual execution results from 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 JS7 - Notifications can be used for
- The JobScheduler Monitoring Interface is a complete solution for the management of complex Passive Checks that are forwarded to a System Monitor.

Download and Installation of the Plugins

Download

Four The following Plugins are available for download:

JobScheduler MasterJS7 Controller: https://download.sos-berlin.com/SystemMonitor/check_js7_jobschedulercontroller.pl
JobScheduler Master via JOC Cockpit: https://download.sos-berlin.com/SystemMonitor/check_jobscheduler_with_joc.pl
JobScheduler Universal Agent:JS7 Agents:: https://download.sos-berlin.com/SystemMonitor/check_jobschedulerjs7_agent.pl
JobScheduler Universal Agent via JOC Cockpit: https://download.sos-berlin.com/SystemMonitor/check_jobscheduler_agent_with_joc.pl

Installation

Both Plugins check the availability of JOC Cockpit.

Installation

Copy Copy the files to the plugin directory of your System Monitor installation.

Configuration of the Plugins

The configuration for the JobScheduler Master JS7 Controller and Agent Plugins includes to definedefinitions of

a System Monitor Command that specifies the parameterization of the Plugin and
a System Monitor Service which that is the visible point of control in the System Monitor console.

...

JS7 Controller Plugin

Sample Configuration:

Code Block

language	bash
title	Sample JobScheduler Master Example for JS7 Controller Plugin Command configuration

# 'check_jobschedulerjs7_controller' command definition
define command {
    command_name                check_js7_jobschedulercontroller
    command_line                /opt/plugins/check_js7_jobschedulercontroller.pl -Hj $HOSTADRESS$$ARG1$ -pi $ARG1$$ARG2$ -ta $ARG2$$ARG3$ (-ut $ARG3$)$ARG4$
}

Code Block

language	bash
title	Sample JobScheduler Master Example for JS7 Controller Service configuration

 define service {
 use                             generic-service                 
 host_name                       localhost
 service_description             JobSchedulerJS7Controller
 is_volatile                     0
 check_period                    24x7
 max_check_attempts              1
 normal_check_interval           1
 retry_check_interval            1
 contact_groups                  admins
 notification_options            w,u,c,r
 notification_interval           960
 notification_period             24x7
 check_command     check_jobscheduler!homer.sos!4444!0!js7_controller!http://localhost:4446!jobscheduler!test:test!5!
 active_checks_enabled           1          
 passive_checks_enabled          0  
}

Parameterization:

ParameterH,hostname

Option	Option (long format)	Data Type	Required		Default	Description
-	j	--joc-	url	String	yes	—	Name or IP address of the host (`homer.sos`) on which JobScheduler is running
-p	--port	—	Port that JobScheduler listens to (`4444`)
-t	--timeout	30s	Timeout for establishing the connection to JobScheduler
-u	--user	—	User and password for HTTP authentication

Example:

Code Block

language	bash
title	Example Active Check for JobScheduler Master

#JobScheduler running on a server 'test' using port 4444 and HTTP authentication (user and password 'test')
 
<path_to_plugins>/check_jobscheduler.pl -H test -p 4444 -t 30 -u test:test

Notes

Perl > 5.8 is required and the Perl package NET::HTTP. You can download and install Perl packages from e.g. http://www.cpan.

JobScheduler Cluster/Master Plugin via JOC Cockpit with HTTP(S)

Sample Configuration

Code Block

language	bash
title	Sample JobScheduler Master Command configuration

# 'check_jobscheduler_with_joc' command definition
define command {
    command_name                check_jobscheduler_with_joc
    command_line                /opt/plugins/check_jobscheduler_with_joc.pl -j $ARG1$ -i $ARG2$ -a $ARG3$ -t $ARG4$
}

URL of JOC Cockpit (HTTP and HTTPS are supported)
-i	--id	String	yes	—	ID of a JS7 Controller
-a	--account	String	yes	—	Account for HTTP authentication with JOC Cockpit (<user:password>)
-c	--cafile	String	no	—	Location of a certificate file or a CA bundle file to verify the SSL connection to JOC Cockpit
-C	--capath	String	no	—	Path to a directory that includes certificate files or CA bundle files to verify the SSL connection to JOC Cockpit
-s	--hostname-verification	Switch	no	false	This switch activates SSL hostname verification (recommended)
-t	--timeout	Number	no	30	Timeout in seconds for establishing the connection to JOC Cockpit
-d	--detailed	Switch	no	false	This switch causes status information for each Controller instance to be returned. A Cluster can include two Controller instances.

Example:

Code Block

language	bash
title	Example for Active Check of JS7 Controller

# The JS7 Controller is operated for the ID 'jobscheduler' and JOC Cockpit has the URL http://localhost:4446 with the account (user and password 'test') enabled
 
<path_to_plugins>/check_js7_controller.pl -j http://localhost:4446 -i jobscheduler -a test:test

Notes:

Perl > 5.8 is required and some Perl packages are required. You can download and install Perl packages from e.g. http://www.cpan.
- HTTP::Request
- LWP::UserAgent
- LWP::Protocol::https (if HTTPS is used to connect to JOC Cockpit)
- JSON
- MIME::Base64

JS7 Agent Plugin

A service Command has to be declared before configuring the System Monitor Service that makes use of this Command.

Sample Configuration:

Code Block

language	bash
title	Example of JS7 Agent Plugin Command configuration with JOC Cockpit

# 'check_js7_agent' command definition
define command {
    command_name

Code Block

language	bash
title	Sample JobScheduler Master Service configuration

 define service {
 use                             generic-servicecheck_js7_agent
    command_line                /opt/plugins/check_js7_agent.pl -j $ARG1$ -i $ARG2$ -a $ARG3$ -t $ARG4$
}

Code Block

title	Example of JS7 Agent Service configuration

define service {
 use
 host_name                       localhost
 service_description             JobSchedulerCluster
 is_volatile generic-service                 
 host_name  0
 check_period                    24x7localhost
 maxservice_check_attemptsdescription              1JS7Agents
 normalis_check_intervalvolatile           1
 retry_check_interval         0
 check_period  1
 contact_groups                  admins24x7
 notification_optionsmax_check_attempts              w,u,c,r1
 notificationnormal_check_interval           9601
 notificationretry_check_periodinterval             24x71
 check_commandcontact_groups                  admins
 check_jobscheduler_with_joc!http://localhost:4446!myJobSchedulerId!test:test!5!
 active_checks_enablednotification_options            w,u,c,r
 notification_interval  1          960
 passive_checks_enablednotification_period           0  
}

Parameterization

...

Parameter

...

Default

...

Description

...

-H

...

--hostname

...

—

...

Name or IP address of a JobScheduler Master host. Only required to check a specific cluster member

...

-p

...

--port

...

—

...

HTTP port that JobScheduler listens to (40444). Only required to check a specific cluster member

...

-t

...

--timeout

...

30s

...

Timeout for establishing the connection to JOC Cockpit

...

If set and the Cluster has more than one Master and not all Masters are running then the message contains host:port of each Master

Example:

Code Block

language	bash
title	Example Active Check for JobScheduler Cluster with JOC Cockpit

#JobScheduler running with the id 'test' and JOC Cockpit has the url http://localhost:4446 where the account (user and password 'test') has access
 
<path_to_plugins>/check_jobscheduler_with_joc.pl -j http://localhost:4446 -i test -a test:test

Code Block

language	bash
title	Example Active Check for JobScheduler Master with JOC Cockpit

#JobScheduler running with the id 'test' and JOC Cockpit has the url http://localhost:4446 where the account (user and password 'test') has access
 
<path_to_plugins>/check_jobscheduler_with_joc.pl -j http://localhost:4446 -i test -a test:test -H galadriel -p 4444

Notes

JOC Cockpit installation since 1.11.4 is required.
Perl > 5.8 is required and some Perl packages are required. You can download and install Perl packages from e.g. http://www.cpan.
- HTTP::Request
- LWP::UserAgent
- LWP::Protocol::https (if https is used to connect to JOC Cockpit)
- JSON
- MIME::Base64

JobScheduler Agent Plugin

A service Command has to be declared before configuring the System Monitor Service that makes use of this Command.

Sample Configuration

Code Block

language	bash
title	Sample JobScheduler Agent command configuration

# 'check_jobscheduler_agent' command definition
define command {
    command_name                check_jobscheduler_agent
    command_line                /opt/plugins/check_jobscheduler_agent.pl -u $ARG1$ -a $ARG2$ -o $ARG3$ -t $ARG4$
}

When configuring the System Monitor Service then Command parameters have to be specified that are separated by exclamation marks, e.g.

Code Block

language	bash
title	Sample JobScheduler Agent Command parameterization

http://galadriel.sos:4445/jobscheduler/agent/api/overview!'{totalTaskCount},{currentTaskCount}'!'{startedAt},{totalTaskCount},{currentTaskCount},{isTerminating}'!20

Parameterization

...

Parameter

...

Default

...

Description

...

-u,

...

--url

...

—

...

URL for the HTTP connection that addresses the Agent via host (galadriel.sos) and port (4445) that the Agent is listening to followed by a fixed path (/jobscheduler/agent/api/overview).

...

-a

...

--attributes

...

—

...

List of attributes that are used to check the Agent availability. The specified attributes are recommended to check if the Agent answer if formally correct.

...

-o

...

--outputvars

...

—

...

List of attributes that are used for output of the script and that will be displayed in the System Monitor

startedAt: point in time when the Agent was started.
totalTaskCount: total number of jobs that have been executed during the lifetime of the Agent.
currentTaskCount: number of jobs that are currently executed by the Agent.
isTerminating: indicates whether the Agent is currently shutting down. Depending on the shutdown command that has been used an Agent will let run currently executed jobs before terminating

...

Notes

...

Perl > 5.8 is required and some Perl packages are required. You can download and install Perl packages from e.g. http://www.cpan

...

HTTP::Request::Common

...

LWP::UserAgent

...

Data::Dumper

JobScheduler Agent Plugin via JOC Cockpit with HTTP(S)

A service Command has to be declared before configuring the System Monitor Service that makes use of this Command.

Sample Configuration

Code Block

language	bash
title	Sample JobScheduler Agent command configuration with JOC Cockpit

# 'check_jobscheduler_agent_with_joc' command definition
define command {
    command_name                check_jobscheduler_agent_with_joc
    command_line                /opt/plugins/check_jobscheduler_agent_with_joc.pl -j $ARG1$ -i $ARG2$ -a $ARG3$ -t $ARG4$
}

Code Block

define service {
 use                             generic-service                 
 host_name                       localhost
 service_description             JobSchedulerAgents
 is_volatile                     0
 check_period                    24x7
 max_check_attempts              1
 normal_check_interval           1
 retry_check_interval            1
 contact_groups                  admins
 notification_options            w,u,c,r
 notification_interval           960
 notification_period             24x7
 check_command     check_jobscheduler_agent_with_joc!http://localhost:4446!myJobSchedulerId!test:test!5!
 active_checks_enabled           1          
 passive_checks_enabled          0  
}

Parameterization

...

Parameter

...

Default

...

Description

...

-A

...

--agent

...

—

...

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

...

-t

...

--timeout

...

30s

...

Timeout for establishing the connection to JOC Cockpit

...

If set and the Cluster has more than one Master and not all Masters are running then the message contains host:port of each Master

24x7
 check_command     check_js7_agent!http://localhost:4446!jobscheduler!test:test!5!
 active_checks_enabled           1          
 passive_checks_enabled          0  
}

Parameterization:

Option	Option (long format)	Data Type	Required	Default	Description
-j	--joc-url	String	yes	—	URL of JOC Cockpit (HTTP and HTTPS are supported)
-i	--id	String	yes	—	ID of a JS7 Controller
-a	--account	String	yes	—	Account for HTTP authentication to JOC Cockpit (<user:password>)
-A	--agent	String	no	—	URL of an Agent, optional, can be specified several times
-c	--cafile	String	no	—	Location of a certificate file or a CA bundle file to verify the SSL connection to JOC Cockpit
-C	--capath	String	no	—	Path to a directory that includes certificate files or CA bundle files to verify the SSL connection to JOC Cockpit
-s	--hostname-verification	Switch	no	false	This switch activates SSL hostname verification (recommended)
-t	--timeout	Number	no	30	Timeout in seconds for establishing the connection to JOC Cockpit
-d	--detailed	Switch	no	false	This switch causes status information for each Agent instance to be returned individually

Example:

Code Block

language	bash
title	Example for Active Check of all JS7 Agents with JOC Cockpit

# The JS7 Controller is operated for the ID 'jobscheduler' and JOC Cockpit has the URL http://localhost:4446 with the account (user and password 'test') enabled

<path_to_plugins>/check_js7_agent.pl -j http://localhost:4446 -i jobscheduler -a test:test

Notes:

Perl > 5.8 is required and some Perl packages are required. You can download and install Perl packages from e.g. http://www.cpan.
- HTTP::Request
- LWP::UserAgent
- LWP::Protocol::https (if HTTPS is used to connect to JOC Cockpit)
- JSON
- MIME::Base64
- Cwd

Report Script per Agent:

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 which 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", "SHUTDOWN", "UNKNOWN"

Code Block

language	perl
title	Example of 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

Example:

Code Block

language	bash
title	Example Active Check for all JobScheduler Agents with JOC Cockpit

#JobScheduler running with the id 'test' and JOC Cockpit has the url http://localhost:4446 where the account (user and password 'test') has access
 
<path_to_plugins>/check_jobscheduler_agent_with_joc.pl -j http://localhost:4446 -i test -a test:test

Code Block

language	bash
title	Example Active Check for some JobScheduler Agents with JOC Cockpit

#JobScheduler running with the id 'test' and JOC Cockpit has the url http://localhost:4446 where the account (user and password 'test') has access
 
<path_to_plugins>/check_jobscheduler_agent_with_joc.pl -j http://localhost:4446 -i test -a test:test -A http://galadriel:4445 -A http://galadriel:4455 -d

Notes

JOC Cockpit installation since 1.11.4 is required.
Perl > 5.8 is required and some Perl packages are required. You can download and install Perl packages from e.g. http://www.cpan.
- HTTP::Request
- LWP::UserAgent
- LWP::Protocol::https (if https is used to connect to JOC Cockpit)
- JSON
- MIME::Base64
- Cwd

Report Script per Agent

check_jobscheduler_agent_with_joc.pl calls an optional script report_jobscheduler_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.

report_jobscheduler_agent.pl <joc-cockpit-url> <scheduler-id> <agent-url> <agent-status>
<joc-cockpit-url> is the URL that has been specivied as a parameter to the script check_jobscheduler_agent_with_joc.pl
<scheduler-id> is the JobScheduler Master ID that has been specified as a parameter to the script check_jobscheduler_agent_with_joc.pl
<agent-url> is the URL identifying the Agent

<agent-status> is one of "RUNNING" , "UNREACHABLE", "TERMINATING", "UNKNOWN_AGENT"

Code Block

language	perl
title	Example report_jobscheduler_agent.pl

#!/usr/bin/env perl
use strict;
use warnings;
 
my ($jocUrl, $schedulerId, $agentUrl, $agentStateText) = @ARGV;
# do something with $jocUrl, $schedulerId, $agentUrl, $agentStateText

Change Management References Web Services

...

Space shortcuts

Page tree

Versions Compared

Old Version 1

New Version Current

Key

Introduction

Active

and Passive Checks

Download and Installation of the Plugins

Download

Installation

Installation

Configuration of the Plugins

JS7 Controller Plugin

JobScheduler Cluster/Master Plugin via JOC Cockpit with HTTP(S)

JS7 Agent Plugin

JobScheduler Agent Plugin

JobScheduler Agent Plugin via JOC Cockpit with HTTP(S)

See also

Change Management References Web Services

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 1

New Version Current

Key

Introduction

Active

and Passive Checks

Download and Installation of the Plugins

Download

Installation

Installation

Configuration of the Plugins

JS7 Controller Plugin

JobScheduler Cluster/Master Plugin via JOC Cockpit with HTTP(S)

JS7 Agent Plugin

JobScheduler Agent Plugin

JobScheduler Agent Plugin via JOC Cockpit with HTTP(S)

See also

Change Management References Web Services