...
Location: <scheduler_install>/config/notification
| File | Description |
|---|---|
SystemMonitorNotification_v1.0.xsd | XML Schema file that define which values are allowed in your XML files for the JobScheduler monitoring. That means, you just have to modify your |
SystemMonitorNotification_<MonitorSystem>.xml | Configuration file for each System Monitor.
|
|
| Configuration file for all System Monitors.
This file is optional and must contains only the definitions of the |
...
| Element | Element description | Description |
|---|---|---|
SystemMonitorNotification | Top Level Element | Configuration for Notifications to a System Monitor |
Notification | Once or more inside a SystemMonitorNotification element | Specifies a System Monitor notification that includes a command line invocation and the JobScheduler objects |
Timer | Optional, once or more inside a SystemMonitorNotification element | Performance measurement definition |
SystemMonitorNotification
SystemMonitorNotification support the following attributes:
...
| Attribute | Usage | Description |
|---|---|---|
system_id | required | System Monitor identifier. |
...
The following elements may be nested inside a Notification element:
| Element | Element description | Description |
|---|---|---|
NotificationMonitor | Once inside a Notification element | Specifies the System Monitor interface that is being used for messages: either by a Plugin Interface or by command line invocation |
NotificationObjects | Once inside a Notification element | Specifies the JobChains and the Timers definitions |
SystemMonitorNotification / Notification / NotificationMonitor
NotificationMonitor support the following attributes:
...
| Attribute | Usage | Description |
|---|---|---|
service_name_on_error | Optional | This setting specifies the service that is configured in the Service Monitor for messages of job runs with errors and for job recovery messages. The service name must match the corresponding setting in the System Monitor. |
service_name_on_success | Optional | This setting specifies the service that is configured in the Service Monitor for receiving informational messages on successful job runs. The service name must match the corresponding setting in the System Monitor |
service_status_on_error | Optional | This setting specifies the service status code for error messages. Default: |
service_status_on_success | Optional | This setting specifies the service status code for success messages Default: |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<!-- Example OP5 NSCA Status: 0 - OK 1 - WARNING 2 - CRITICAL 3 - UNKNOWN --> ... <!-- Sending occurred errors as CRITICAL (default) --> <NotificationMonitor service_name_on_error="JobScheduler Errors"> ... <!-- Sending occurred errors as WARNING --> <NotificationMonitor service_name_on_error="JobScheduler Errors" service_status_on_error="1"> ... |
One of the following elements must be nested inside a NotificationMonitor element:
| Element | Element description | Description |
|---|---|---|
NotificationInterface | Optional, once inside of NotificationMonitor element | Plugin Interface to be executed for System Monitor notification |
NotificationCommand | Optional, once inside of NotificationMonitor element | Command line to be executed for System Monitor notification |
...
SystemMonitorNotification / Notification / NotificationMonitor / NotificationInterface
NotificationInterface support the following attributes:
| Attribute | Usage | Description |
|---|---|---|
monitor_host | Required | This setting specifies the hostname or ip address of System Monitor host. |
monitor_port | Required | This setting specifies the TCP port that the System Monitor would listen to. |
monitor_password | Optional | |
monitor_connection_timeout | Optional | |
monitor_response_timeout | Optional | |
monitor_encryption | Optional | This setting specifies that the communication with the System Monitor is encrypted. By default no encryption is used.
|
service_host | Optional | 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: com.sos.scheduler.notification.plugins.notifier.SystemNotifierSendNscaPlugin |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
... <NotificationInterface monitor_host="monitor_host" monitor_port="5667" monitor_encryption="XOR" service_host="service_host"><![CDATA[ scheduler id=%MON_N_SCHEDULER_ID%, history id=%MON_N_ORDER_HISTORY_ID%, job_chain=%MON_N_JOB_CHAIN_NAME%(%MON_N_ORDER_ID%), step =%MON_N_ORDER_STEP_STATE%, error=%MON_N_ERROR_TEXT% ]]></NotificationInterface> ... |
SystemMonitorNotification / Notification / NotificationMonitor / NotificationCommand
NotificationCommand support the following attributes:
| Attribute | Usage | Description |
|---|---|---|
plugin | Optional | Default: com.sos.scheduler.notification.plugins.notifier.SystemNotifierProcessBuilderPlugin |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
... <NotificationCommand><![CDATA[ echo scheduler id=%MON_N_SCHEDULER_ID%, history id=%MON_N_ORDER_HISTORY_ID%, job_chain=%MON_N_JOB_CHAIN_NAME%(%MON_N_ORDER_ID%), step =%MON_N_ORDER_STEP_STATE%, error=%MON_N_ERROR_TEXT% > D://errors.txt ]]></NotificationCommand> ... |
...
One of the following elements must be nested inside a NotificationObjects element:
| Element | Element description | Description |
|---|---|---|
JobChain | Optional, once or more inside of NotificationObjects element | Restricts notifications for job chains |
Timer | Optional, once or more inside of NotificationObjects element | Restricts notifications for job checks (Timer) |
SystemMonitorNotification / Notification / NotificationObjects / JobChain
JobChain support JobChain support the following attributes:
| Attribute | Usage | Description |
|---|---|---|
notifications | Optional Integer | Specifies the number of notifications that are sent to a System Monitor. Default: |
scheduler_id | Optional | Notifications are restricted to the JobScheduler instance with the given identification. By default notifications will be sent for all JobScheduler instances that would log into the same database. Regular expression can be used. |
name | Optional | Job chain name including possible folder names. Regular expression can be used. |
step_from | Optional | Restricts notifications for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes. |
step_to | Optional | Restricts notifications for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes. |
excluded_steps | Optional | Specifies the steps which will be excluded from the analysing (separated by semicolon) |
...
| Attribute | Usage | Description |
|---|---|---|
notifications | Optional Integer | Specifies the number of notifications that are sent to a System Monitor. Default: |
name name | Optional | Correspondence to Timer defined in the SystemMonitorNotification / Timer element |
notify_on_error | Optional Boolean | Send timer check notification if the error ocurred in the configured timer job chain (steps) Default: |
SystemMonitorNotification / Timer
The following elements must be nested inside a NotificationObjects element:
| Element | Element description | Description |
|---|---|---|
JobChain | Once or more inside of Timer element | Restricts notifications for job chains |
Minimum | Optional or once inside of Timer element | Minimum required time consumption for job or job chain execution. Allows script code to be executed that returns the minimum execution time required in seconds. |
Maximum | Optional or once inside of Timer element | Maximum allowed time consumption for job or job chain execution. Allows script code to be executed that returns the maximum execution time required in seconds. |
Timer support the following attributes:
| Attribute | Usage | Description |
|---|---|---|
name name | Required | Correspondence to Timer used in the The name must be unique across all timers definitions. |
SystemMonitorNotification / Timer / JobChain
JobChain support JobChain support the following attributes:
| Attribute | Usage | Description |
|---|---|---|
scheduler scheduler_id | Optional | Notifications are restricted to the JobScheduler instance with the given identification. By default notifications will be sent for all JobScheduler instances that would log into the same database. |
name name | Optional | Job chain name including possible folder names |
step step_from | Optional | Restricts checks for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes. |
step step_to | Optional | Restricts checks for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes. |
SystemMonitorNotification / Timer / Minimum
The following elements must be nested inside a Minimum element:
| Element | Element description | Description |
|---|---|---|
Script | Once inside of Minimum element | Script code in one of the supported languages |
...
The following elements must be nested inside a Maximum element:
| Element | Element description | Description |
|---|---|---|
Script | Once inside of Maximum element | Script code in one of the supported languages |
SystemMonitorNotification / Timer / Minimum|Maximum / Script
Script support Script support the following attributes:
| Attribute | Usage | Description |
|---|---|---|
language language | Required | Script language name Supported languages:
|
Message
Usage
The Message sended to System Monitor can be configured as CDATA element on the following parent nodes:
...
Tables variables
| Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
scheduler id = %MON_N_SCHEDULER_ID%, history id = %MON_N_ORDER_HISTORY_ID%, job_chain = %MON_N_JOB_CHAIN_NAME%(%MON_N_ORDER_ID%), error = %MON_N_ERROR_TEXT% |
| Expand | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
step from = %MON_SN_STEP_FROM%, step to = %MON_SN_STEP_TO%, notification = %MON_SN_NOTIFICATIONS% (of %MON_SN_MAX_NOTIFICATIONS%) |
| Expand | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
timer name = %MON_C_NAME%, text = %MON_C_CHECK_TEXT% |
Service variables
| Expand | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
service name = %SERVICE_NAME% |
...
| Expand | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Tables variables
| Expand | ||
|---|---|---|
| ||
All tables variables (see tables variables explanation) have the prefix
e.g.:
|
...