Page History

...

This article describes individual configuration parameters and provides examples of their use with monitors such as op5 and Zabbix and using of the mail und JMS interfaces.

Download: notification.xml

Send notifications

Notify on error

...

will be sent:
- when at the time of the sos / notification / SystemNotifier run, an order is in a job chain state(step) that has ended with an error
will not be sent:
- when after the last run of the sos / notification / SystemNotifier, an error has occured in an job chain state(step) but at the time of the current sos / notification / SystemNotifier run this order is in an other/next job chain state(step)
  - this kind of error is ignored because the order has continued to run
- when an error has reoccurred in the same job chain state(step) where a notification has already been sent
  - this order state is considered as notified and no new notification will be sent
    - e.g. an job chain state(step) has been restarted manually or by a setback
  - this behaviour has been changed with
    Jira
    server SOS JIRA
    columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId 6dc67751-9d67-34cd-985b-194a8cdc9602
    key JITL-534
    - providing support for repeatedly failed executions.
- when the first step of the specific order has been removed from the notification tables by sos / notification / CleanupNotifications
  - this behaviour has been changed with
    Jira
    server SOS JIRA
    columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId 6dc67751-9d67-34cd-985b-194a8cdc9602
    key JITL-516
    - providing support for long running orders
- when a notification maximum has been reached
  - see SystemMonitorNotification / Notification / NotificationObjects / JobChain / @notifications
- when a job chain state(step) has been configured as excluded
  - see SystemMonitorNotification / Notification / NotificationObjects / JobChain / @excluded_steps
- when the @step_from or @step_to settings have been configured and the job chain state(step) is out of the configured range
  - see SystemMonitorNotification / Notification / NotificationObjects / JobChain / @step_from | @step_to
- when the @return_code_from or @return_code_to settings have been configured and the return code of the job chain state(step) is out of the configured range
  - see SystemMonitorNotification / Notification / NotificationObjects / JobChain / @return_code_from | @return_code_to

Recovery messages

will be automatically sent using the same service name and message as the relevant error message:
- when the error message of a job chain state(step) has already been sent and the order at the time of the current sos / notification / SystemNotifier run is in an other/next state(step)
  - e.g. the rerun of the error state(step) has been successfull and the order has been moved to the next job chain state(step)
  - Note: use ${SERVICE_STATUS} and ${SERVICE_MESSAGE_PREFIX} variables to differentiate between recovery and error message
    - See:
will not be sent:
- when a job chain state(step) has recovered after the last run of the sos / notification / SystemNotifier but at the time of the current sos / notification / SystemNotifier run a new error in the other/next step has occured

...

will be sent:
- when a job chain state(step) or standalone job (JobScheduler versions from 1.12) ends with an error
will not be sent:
- when a notification maximum has been reached
  - see SystemMonitorNotification / Notification / NotificationObjects / Job / @notifications
- when the @return_code_from or @return_code_to settings have been configured and the return code of the job is out of the configured range
  - see SystemMonitorNotification / Notification / NotificationObjects / Job / @return_code_from | @return_code_to

Notify on success

SystemMonitorNotification / Notification / NotificationMonitor / @service_name_on_success is configured.

...

will be sent:
- when an order is completed and the last job chain state(step) has no error
will not be sent:
- when a notification maximum has been reached
  - see SystemMonitorNotification / Notification / NotificationObjects / JobChain / @notifications
- when the @return_code_from or @return_code_to settings have been configured and the return code of the job chain state(step) is out of the configured range
  - see SystemMonitorNotification / Notification / NotificationObjects / JobChain / @return_code_from | @return_code_to

SystemMonitorNotification / Notification / NotificationObjects / Job

...

will be sent:
- when a job chain state(step) or standalone job (JobScheduler releases from 1.12) ends without error
will not be sent:
- when a notification maximum has been reached
  - see SystemMonitorNotification / Notification / NotificationObjects / Job / @notifications
- when the @return_code_from or @return_code_to settings have been configured and the return code of the job is out of the configured range
  - see SystemMonitorNotification / Notification / NotificationObjects / Job / @return_code_from | @return_code_to

Configuration Editor

We recommend that the XML Editor is used generate monitoring configuration objects. This editor automatically uses an XSD Schema to generate configuration suggestions and validate configurations, and its use is intended to provide a significant reduction in the time required to develop and test a configuration.

...

JobScheduler releases before 1.11
- see JobScheduler - Job Chains
JobScheduler releases starting from 1.11
- Set param sos.use_notification true (config/scheduler.xml)
- see JobScheduler - Job Chains

Note:

JobScheduler releases before 1.13.1
- SystemMonitorNotification_<MonitorSystem>.xml file(s) (see below) must be configured before activtion.
JobScheduler releases starting from 1.13.1
- SystemMonitorNotification_<MonitorSystem>.xml file(s) (see below) must be configured before activtion or
- The NOTIFICATION configuration was forwarded by the Joc Cockpit to the respective JobScheduler Master.

...

Attribute JobScheduler release Usage Description

system_id

before 1.13.1

required

System Monitor identifier.

See JobScheduler - Job Chains customization

Note:

attribute system_id

in case of the SystemMonitorNotificationTimers.xml the value of this attribute is not important and can have any value.
- e.g.: timers

starting from 1.13.1

required

If a configuration is created by JOC Cockpit the value of the attribute system_id will be ignored.
- The SystemNotifier job chain will use MonitorSystem as identifier instead.

...

The JobScheduler Interface Monitor can be used to monitor the messages for the 3 use cases:

error case
- an error has occured occurred / been recovered during a job chain / job execution
  - the service_name_on_error setting is responsible for this monitoring case
success case
- a job chain / job ends succesfullysuccessfully
  - the service_name_on_success setting is responsible for this monitoring case
performance check (see Timer)
- usually the service_name_on_error setting is responsible for this monitoring case but the performance check will also work if only the service_name_on_success setting has been defined.

...

attributes service_name_on_error and service_name_on_success
- at least one of these attributes must be configured
- both attributes can be configured together
- the use of this settings must be unique within one SystemNotification

NotificationMonitor supports the following attributes:

...

Code Block

language	xml
title	Example
collapse	true

<!-- Example 
op5 NSCA Status: 
0 - OK 
1 - WARNING 
2 - CRITICAL 
3 - UNKNOWN --> 
... 
<!-- Sending occurred errors as CRITICAL (default) --> 
<NotificationMonitor service_name_on_error="JobScheduler Monitoring Errors"> 
... 
<!-- Sending occurred errors as WARNING --> 
<NotificationMonitor service_name_on_error="JobScheduler Monitoring Errors" service_status_on_error="1"> 
...

...

Attribute	Usage	Description
`monitor_host`	Required	This setting specifies the host name or ip IP address of the System Monitor host.
`monitor_port`	Required	This setting specifies the TCP port that the System Monitor would will listen to.
`monitor_password`	Optional	This setting specifies the password for NSCA - the password is configured in the ncsa.cfg file.
`monitor_connection_timeout`	Optional	This setting specifies the connection timeout in ms. Default: `5000`
`monitor_response_timeout`	Optional	This setting specifies the response timeout in ms.
`monitor_encryption`	Optional	This setting specifies that the communication with the System Monitor is encrypted. By default no encryption is used. `NONE` - no encryption `XOR` - XOR encryption `TRIPLE_DES` - use of triple des algorithm for encryption
`service_host`	Required	This setting specifies the name of the host that executes the passive check. The name must match the corresponding setting in the System Monitor.
`plugin`	Optional	Default: JobScheduler releases before 1.11 `com.sos.scheduler.notification.plugins.notifier.SystemNotifierSendNscaPlugin` JobScheduler releases starting from 1.11 `com.sos.jitl.notification.plugins.notifier.SystemNotifierSendNscaPlugin`

...

Note

title	System Monitor: Opsview

In case you are using Opsview OpsView as the monitoring tool, the plugin used in NotificationInterface will not work, since Opsview OpsView supports 20 types of encryption, which are not supported by this plugin. You could only can use it only in case you use that no encryption is used (type: NONE) and that will work .

Instead, you should use the XML element NotificationCommand and indicate there the exact command to send passive checks to your Opsview an OpsView server from a remote machine (see example for op5 or example for zabbix).

...

Code Block

language	xml
title	Example
collapse	true

...
<Body><![CDATA[<style type<!DOCTYPE html>
<html lang="en">
<head>
    <meta http-equiv="Content-Type" content="text/css">
html; charset=utf-8"/>
    <style>.tg  {border-collapse:collapse;border-spacing:0;border-color:#bbb#aaa;}
.tg td{font-family:Arial, sans-serif;font-size:14px;padding:10px 5px;border-style:solid;border-width:1px;overflow:hidden;word-break:normal;border-color:#bbb#aaa;color:#594F4F#333;background-color:#E0FFEB#fff;}
.tg th{font-family:Arial, sans-serif;font-size:14px;font-weight:normalbold;padding:10px 5px;border-style:solid;border-width:1px;overflow:hidden;word-break:normal;border-color:#bbb#aaa;color:#493F3F#fff;background-color:#9DE0AD#f38630;}</style>
    <title>JobScheduler Notification</title>
</style>head>
<body>
<table class="tg">
    <tr>
        <th colspan="4">Error</th>
    </tr>
    <tr>
        <td>Code:</td><td>${MON_N_ERROR_CODE}</td>
        <td>Messsage</td><td>${MON_N_ERROR_TEXT}</td>
    </tr>
    <tr>
        <th colspan="4">JobScheduler</th>
    </tr>
    <tr>
        <td>JobScheduler ID</td><td>${MON_N_SCHEDULER_ID}</td>
        <td>Agent URL</td><td>${MON_N_AGENT_URL}</td>
    </tr>
    <tr>
        <th colspan="4">Order</th>
    </tr>
    <tr>
        <td>Order ID</td><td><a href="${JOC_HREF_ORDER}">${MON_N_ORDER_ID}</a></td>
        <td>Order Title</td><td>${MON_N_ORDER_TITLE}</td>
    </tr>
    <tr>
        <td>Job Chain Name</td><td><a href="${JOC_HREF_JOB_CHAIN}">${MON_N_JOB_CHAIN_NAME}</a></td>
        <td>Job Chain Title</td><td>${MON_N_JOB_CHAIN_TITLE}</td>
    </tr>
    <tr>
        <td>Job Name</td><td><a href="${JOC_HREF_JOB}">${MON_N_JOB_NAME}${MON_N_JOB_NAME}</a></td>
        <td>Job Title</td><td>${MON_N_JOB_TITLE}</td>
    </tr>
    <tr>
        <th colspan="4">Task History</th>
    </tr>
    <tr>
        <td>Task ID</td><td>${MON_N_TASK_ID}</td>
        <td>Time elapsed</td><td>${MON_N_TASK_TIME_ELAPSED}</td>
    </tr>
    <tr>
        <td>Start Time</td><td>${MON_N_TASK_START_TIME}</td>
        <td>End Time</td><td>${MON_N_TASK_END_TIME}</td>
    </tr>
</table>]]></Body>
...
</body>
</html>

SystemMonitorNotification / Notification / NotificationMonitor / NotificationJMS

...

Expand

title	Variables: table SCHEDULER_MON_NOTIFICATIONS

Table of the history of steps of processed orders / jobs.

Name Description Note

${MON_N_ID}

Unique notification id

${MON_N_SCHEDULER_ID} Id of the JobScheduler

${MON_N_TASK_ID} Id of the JobScheduler task

${MON_N_STEP} Consecutive number of the order step

${MON_N_ORDER_HISTORY_ID} Id of the JobScheduler order

${MON_N_JOB_CHAIN_NAME} Name of the job chain of the order

${MON_N_JOB_CHAIN_TITLE} Title of the job chain of the order

${MON_N_ORDER_ID} Unique (within the job chain) id of the order

${MON_N_ORDER_TITLE} Title of the order

${MON_N_ORDER_START_TIME} Timestamp of the start of the order

${MON_N_ORDER_END_TIME} Timestamp of the end of the order

${MON_N_ORDER_TIME_ELAPSED} The time or difference in seconds between a beginning time and an ending time of the order

${MON_N_ORDER_STEP_STATE} State of the order inside the job chain

${MON_N_ORDER_STEP_START_TIME} Timestamp of the start of the order step

${MON_N_ORDER_STEP_END_TIME} Timestamp of the end of the order step

${MON_N_ORDER_STEP_TIME_ELAPSED} The time or difference in seconds between a beginning time and an ending time of the order step

${MON_N_JOB_NAME} Name of the job

${MON_N_JOB_TITLE} Title of the job

${MON_N_JOB_CRITICALITY}

User defined job criticality

Available with release 1.13.3

Jira

server	SOS JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	6dc67751-9d67-34cd-985b-194a8cdc9602
key	JOC-850

${MON_N_TASK_START_TIME} Timestamp of the job task start

${MON_N_TASK_END_TIME} Timestamp of the job task end

${MON_N_TASK_TIME_ELAPSED} The time or difference in seconds between a beginning time and an ending time of the job task

${MON_N_RECOVERED}

0 = dependent of the ${MON_N_ERROR} - ok or error was not recovered,

1 = error was recovered

${MON_N_RETURN_CODE} Return code number

${MON_N_AGENT_URL}

JobScheduler Agent uri

Available with release 1.11.2

Jira

server	SOS JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	6dc67751-9d67-34cd-985b-194a8cdc9602
key	JITL-351

${MON_N_CLUSTER_MEMBER_ID}

ID of the Scheduler cluster member (only used in cluster mode)

Available with release 1.11.2

Jira

server	SOS JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	6dc67751-9d67-34cd-985b-194a8cdc9602
key	JITL-352

${MON_N_ERROR}

0 = ok

1 = error

${MON_N_ERROR_CODE} Exception-code of the job error

${MON_N_ERROR_TEXT} Exception message of the job (that processed the order)

${MON_N_CREATED} Timestamp of the notification initial record

${MON_N_MODIFIED} Timestamp of the latest changes to this notification record

...

These variables can be used when the NotificationCommand calls the notification client - not directly but via a shell script that makes the logical implementation for sending the notification messages.

Table variables

...

All table variables (see `Table variables` explanation) are set as environment variables with the prefix:
`SCHEDULER_MON_TABLE_`
e.g.:
`SCHEDULER_MON_TABLE_MON_N_ID`
`SCHEDULER_MON_TABLE_MON_N_SCHEDULER_ID`
`...`

Service variables

...

Name	Description
`SCHEDULER_MON_SERVICE_NAME`	Current service name. One of both element attributes: SystemMonitorNotification / Notification / NotificationMonitor / @service_name_on_error SystemMonitorNotification / Notification / NotificationMonitor / @service_name_on_success
`SCHEDULER_MON_SERVICE_STATUS`	Current service status. One of both element attributes or default: SystemMonitorNotification / Notification / NotificationMonitor / @service_status_on_error SystemMonitorNotification / Notification / NotificationMonitor / @service_status_on_success `default` CRITICAL error default OK success
`SCHEDULER_MON_SERVICE_MESSAGE_PREFIX`	`ERROR` error `RECOVERED` error recovery `TIMER` performance check
`SCHEDULER_MON_SERVICE_COMMAND`	Content of the `SystemMonitorNotification / Notification / NotificationCommand` after substitution

Code Block

language	bash
title	Sample NotificationCommand Unix. Script file (/tmp/command.sh).
collapse	true

1) configured command in the SystemMonitorNotification_<MonitorSystem>.xml file
<NotificationCommand><![CDATA[/tmp/command.sh]</NotificationCommand>
 
2) content of the /tmp/command.sh file
#! /bin/sh 
# Note: "> /tmp/command_output.txt" is used to simulate the starting of the notification client
#
echo "$SCHEDULER_MON_SERVICE_NAME:$SCHEDULER_MON_SERVICE_STATUS:$SCHEDULER_MON_SERVICE_MESSAGE_PREFIX history id = $SCHEDULER_MON_TABLE_MON_N_ORDER_HISTORY_ID" > /tmp/command_output.txt

...

The Monitoring Interface provide functionality to store the job/order parameters of the specific jobs into database (table SCHEDULER_MON_RESULTS).

See explanation : Calculation

JobScheduler - Job Chains

...

SystemMonitorNotification_<MonitorSystem>.xml
- Configure SystemMonitorNotification / Timer
- Configure SystemMonitorNotification / Notification / NotificationObjects / TimerRef
- Configure service_name_on_error (SystemMonitorNotification / Notification / NotificationMonitor)
System Monitor
- Services in the System Monitor have to be configured and named the same way as in the service_name_on_error (SystemMonitorNotification / Notification / NotificationMonitor) above.

SFTP connection refused

...

SystemMonitorNotification_<MonitorSystem>.xml
- Configure SystemMonitorNotification / Notification / NotificationObjects / JobChain for relevant Job chain.
- Configure service_name_on_error (SystemMonitorNotification / Notification / NotificationMonitor)
System Monitor
- Services in the System Monitor have to be configured and named the same way as in the service_name_on_error (SystemMonitorNotification / Notification / NotificationMonitor) above.

Thresholds

Initial Situation

...

SystemMonitorNotification_<MonitorSystem>.xml
- Configure SystemMonitorNotification / Notification / NotificationObjects / JobChain for relevant Job chain
- Configure service_name_on_success (SystemMonitorNotification / Notification / NotificationMonitor)
System Monitor
- Services in the System Monitor have to be configured and named the same way as in the service_name_on_success (SystemMonitorNotification / Notification / NotificationMonitor) above.

Acknowledgment

Initial Situation

...

SystemMonitorNotification_<MonitorSystem>.xml
- Configure SystemMonitorNotification / Notification / NotificationObjects / JobChain for relevant Job chain.
- Configure service_name_on_error (SystemMonitorNotification / Notification / NotificationMonitor)
System Monitor
- Services in the System Monitor have to be configured and named the same way as in the service_name_on_error (SystemMonitorNotification / Notification / NotificationMonitor) above.

Change Management References

...

Space shortcuts

Page tree

Versions Compared

Old Version 200

New Version Current

Key

Send notifications

Notify on error

Recovery messages

Notify on success

SystemMonitorNotification / Notification / NotificationObjects / Job

Configuration Editor

SystemMonitorNotification / Notification / NotificationMonitor / NotificationJMS

Table variables

All table variables (see `Table variables` explanation) are set as environment variables with the prefix:
`SCHEDULER_MON_TABLE_`
e.g.:
`SCHEDULER_MON_TABLE_MON_N_ID`
`SCHEDULER_MON_TABLE_MON_N_SCHEDULER_ID`
`...`

Service variables

JobScheduler - Job Chains

SFTP connection refused

Thresholds

Initial Situation

Acknowledgment

Initial Situation

Change Management References

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 200

New Version Current

Key

Send notifications

Notify on error

Recovery messages

Notify on success

SystemMonitorNotification / Notification / NotificationObjects / Job

Configuration Editor

SystemMonitorNotification / Notification / NotificationMonitor / NotificationJMS

Table variables

All table variables (see Table variables explanation) are set as environment variables with the prefix:SCHEDULER_MON_TABLE_e.g.:SCHEDULER_MON_TABLE_MON_N_IDSCHEDULER_MON_TABLE_MON_N_SCHEDULER_ID...

Service variables

JobScheduler - Job Chains

SFTP connection refused

Thresholds

Initial Situation

Acknowledgment

Initial Situation

Change Management References

All table variables (see `Table variables` explanation) are set as environment variables with the prefix:
`SCHEDULER_MON_TABLE_`
e.g.:
`SCHEDULER_MON_TABLE_MON_N_ID`
`SCHEDULER_MON_TABLE_MON_N_SCHEDULER_ID`
`...`