...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
... <NotificationCommand><![CDATA[ echo scheduler id=%MON{MON_N_SCHEDULER_ID%ID}, history id=%MON{MON_N_ORDER_HISTORY_ID%ID}, job_chain=%MON{MON_N_JOB_CHAIN_NAME%NAME}(%MON{MON_N_ORDER_ID%ID}), step =%MON{MON_N_ORDER_STEP_STATE%STATE}, error=%MON{MON_N_ERROR_TEXT%TEXT} > D://errors.txt ]]></NotificationCommand> ... |
...
Element | Element description | Description |
---|---|---|
JobChain | Optional, once or more inside of NotificationObjects element | Restricts notifications for job chains |
Job | Optional, once or more inside of NotificationObjects element | Restricts notifications for jobs |
TimerRef Timer | Optional, once or more inside of NotificationObjects element | Restricts notifications for performance checks (Timer) |
...
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 log into the same database. Regular expression can be used. |
name | Optional | Job chain name including possible folder names. Regular expression can be used. |
return_code_from | Optional | Restricts notifications for job chains for a particular return code range. |
return_code_from | Optional | Restricts notifications for job chains for a particular return code range. |
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 analyzing (separated by semicolon) |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
... <JobChain notifications="2" name="test/my_jobchain"/> ... <JobChain scheduler_id="scheduler_4444" /> ... <JobChain scheduler_id="scheduler_4444" name="^(test/my)" /> ... <JobChain name="test/my_jobchain" stepreturn_code_from="2005"/> ... <JobChain name="test/my_jobchain" stepreturn_code_to="50010"/> ... <JobChain name="test/my_jobchain" stepreturn_code_from="5" return_code_to="5"/> ... <JobChain name="test/my_jobchain" step_from="200"/> ... <JobChain name="test/my_jobchain" step_to="500"/> ... <JobChain name="test/my_jobchain" step_from="300" step_to="300"/> ... <JobChain name="test/my_jobchain" excluded_steps="200;300"/> ... |
SystemMonitorNotification / Notification / NotificationObjects /
...
Job
Timer Job
supports the following attributes:
Attribute | Usage | Description | |||
---|---|---|---|---|---|
notifications | Optional Integer | Specifies the number of notifications that are sent to a System Monitor. Default: | |||
name scheduler_id | Optional | Corresponds with Timer name setting defined in the SystemMonitorNotification / Timer element | Notifications are restricted to the JobScheduler instance with the given identification. By default notifications will be sent for all JobScheduler instances that log into the same database. Regular expression can be used. | ||
name | Optional | Job name including possible folder names. Regular expression can be used. | |||
return_code_from | Optional | Restricts notifications for jobs for a particular return code range. | |||
return_code_from | Optional | Restricts notifications for jobs for a particular return code range. | notify_on_error |
Optional Boolean | Send timer check notification when the configured job chain contains the error notifications. Default:false |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
...
<Job notifications="2" name="test/my_job"/>
...
<Job scheduler_id="scheduler_4444" />
...
<Job scheduler_id="scheduler_4444" name="^(test/my)" />
...
<Job name="test/my_job" return_code_from="5"/>
...
<Job name="test/my_job" return_code_to="10"/>
...
<Job name="test/my_job" return_code_from="5" return_code_to="5"/>
...
|
SystemMonitorNotification / Notification / NotificationObjects / TimerRef
TimerRef supports the following attributes:
Attribute | Usage | Description |
---|---|---|
notifications | Optional Integer | Specifies the number of notifications that are sent to a System Monitor. Default: |
ref | Optional | Corresponds with Timer name setting defined in the SystemMonitorNotification / Timer element |
notify_on_error |
Optional Boolean | Send timer check notification when the configured job chain contains the error notifications. Default: |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<SystemMonitorNotification system_id="op5"> <Notification> <NotificationMonitor service_name_on_error="JobScheduler Monitoring Error"> ... </NotificationMonitor> <NotificationObjects> <SystemMonitorNotification system_id="op5"> <Notification> <NotificationMonitor service_name_on_error="JobScheduler Monitoring Error"> ... </NotificationMonitor> <NotificationObjects> <!-- Send the job chain error, occurring in the "test/my_jobchain" job chain, to the "JobScheduler Monitoring Errors" service. --> <JobChain name="test/my_jobchain" /> </NotificationObjects> </Notification> <Notification> <NotificationMonitor service_name_on_error="JobScheduler Monitoring Performance"> ... </NotificationMonitor> <NotificationObjects> <!-- Sends the performance check error, occurring in the "test/my_jobchain" job chain, to the "JobScheduler Monitoring Performance" service. Sends the performance check error to the "JobScheduler Monitoring Performance" service will be ignored when the "test/my_jobchain" has the job chain error (default notify_on_error = false). --> <Timer<TimerRef nameref="my_timer" /> </NotificationObjects> </Notification> <Timer name="my_timer"> <JobChain<TimerJobChain name="test/my_jobchain" /> </Timer> </SystemMonitorNotification> |
...
Element | Element description | Description |
---|---|---|
JobChain TimerJobChain | Once or more inside of Timer element | Restricts notifications for job chains |
Minimum | Optional or once inside of Timer element | Minimum required execution time for job chains or selected job nodes. Allows script code to be executed that returns the minimum execution time in seconds. |
Maximum | Optional or once inside of Timer element | Maximum allowed execution time for job chains or selected job nodes. Allows script code to be executed that returns the maximum execution time in seconds. |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<SystemMonitorNotification system_id="op5"> ... <Timer name="my_timer_1"> <JobChain<TimerJobChain name="test/my_jobchain_1" /> <Maximum><Script language="javascript"><![CDATA[1000]]></Script></Maximum> </Timer> <Timer name="my_timer_2"> <JobChain<TimerJobChain name="test/my_jobchain_2" /> <JobChain<TimerJobChain name="test/my_jobchain_3" /> <Minimum><Script language="javascript"><![CDATA[500]]></Script></Minimum> <Maximum><Script language="javascript"><![CDATA[1000]]></Script></Maximum> </Timer> </SystemMonitorNotification> |
...
Attribute | Usage | Description |
---|---|---|
name | Required | Corresponds to Timer used in the The name must be unique across all timers definitions. |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
... <Timer name="my_timer"> ... |
SystemMonitorNotification / Timer /
...
TimerJobChain
JobChain
TimerJobChain
support the following attributes:
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
... <JobChain<TimerJobChain scheduler_id="scheduler_4444" /> ... <JobChain<TimerJobChain scheduler_id="scheduler_4444" name="^(test/my)" /> ... <JobChain<TimerJobChain name="test/my_jobchain" step_from="200"/> ... <JobChain<TimerJobChain name="test/my_jobchain" step_to="500"/> ... <JobChain<TimerJobChain name="test/my_jobchain" step_from="300" step_to="300"/> ... |
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Table of the history of steps of processed orders.
|
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
scheduler id = %MON{MON_N_SCHEDULER_ID%ID}, history id = %MON{MON_N_ORDER_HISTORY_ID%ID}, job_chain = %MON{MON_N_JOB_CHAIN_NAME%NAME}(%MON{MON_N_ORDER_ID%ID}), error = %MON{MON_N_ERROR_TEXT%TEXT} |
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||
Table of the history of notifications sent to a system monitor.
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
step from = %MON{MON_SN_STEP_FROM%FROM}, step to = %MON{MON_SN_STEP_TO%TO}, notification = %MON{MON_SN_NOTIFICATIONS%CURRENT_NOTIFICATION} (of %MON{MON_SN_MAX_NOTIFICATIONS%NOTIFICATIONS}) |
Expand | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
Table of the history of executed checks (Timer)
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
timer name = %MON{MON_C_NAME%NAME}, text = %MON{MON_C_CHECK_TEXT%TEXT} |
Service variables
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
service name = %SERVICE{SERVICE_NAME%NAME} |
OS environment variables
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
scheduler id=%MON{MON_N_SCHEDULER_ID%ID}, history id=%MON{MON_N_ORDER_HISTORY_ID%ID}, job_chain=%MON{MON_N_JOB_CHAIN_NAME%NAME}(%MON{MON_N_ORDER_ID%ID}), step=%MON{MON_N_ORDER_STEP_STATE%STATE}, error=%MON{MON_N_ERROR_TEXT% TEXT} |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
scheduler id=%MON{MON_N_SCHEDULER_ID%ID}, history id=%MON{MON_N_ORDER_HISTORY_ID%ID}, job_chain=%MON{MON_N_JOB_CHAIN_NAME%NAME}(%MON{MON_N_ORDER_ID%ID}), steps(%MON{MON_SN_STEP_FROM%FROM} to %MON{MON_SN_STEP_TO%TO}), order time elapsed = %MON{MON_N_ORDER_TIME_ELAPSED%s ELAPSED}s |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
name = %MON{MON_C_NAME%NAME}, scheduler id=%MON{MON_N_SCHEDULER_ID%ID}, history id=%MON{MON_N_ORDER_HISTORY_ID%ID}, job_chain=%MON{MON_N_JOB_CHAIN_NAME%NAME}(%MON{MON_N_ORDER_ID%ID}), steps(%MON{MON_C_STEP_FROM%FROM} to %MON{MON_C_STEP_TO%TO}), check = %MON{MON_C_CHECK_TEXT% TEXT} |
Notification environment variables
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
... <!-- monitor_host The hostname or ip address of System Monitor host monitor_port The TCP port that the System Monitor would listen to monitor_encryption Encryption algorithm service_host The host that executes the passive check. The name must match the corresponding setting in the System Monitor %MON{MON_N_SCHEDULER_ID%ID} See explanation "Table variables" ... --> <NotificationInterface monitor_host="monitor_host" monitor_port="5667" monitor_encryption="XOR" service_host="service_host"><![CDATA[ scheduler id=%MON{MON_N_SCHEDULER_ID%ID}, history id=%MON{MON_N_ORDER_HISTORY_ID%ID}, job_chain=%MON{MON_N_JOB_CHAIN_NAME%NAME}(%MON{MON_N_ORDER_ID%ID}), step =%MON{MON_N_ORDER_STEP_STATE%STATE}, error=%MON{MON_N_ERROR_TEXT%TEXT} ]]></NotificationInterface> ... |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
... <!-- service_host The host that executes the passive check. The name must match the corresponding setting in the System Monitor. monitor_host The hostname or ip address of System Monitor host. %SERVICE{SERVICE_NAME%NAME} See explanation "Service variables" %SERVICE{SERVICE_STATUS%STATUS} See explanation "Service variables" %SERVICE{SERVICE_MESSAGE_PREFIX%PREFIX} See explanation "Service variables" %MON{MON_N_SCHEDULER_ID%ID} See explanation "Table variables" ... NotificationCommand after substitution (error case): <![CDATA[echo service_host:JobScheduler Monitoring Errors:2:ERROR scheduler id=scheduler_4444, history id=123, job_chain=test/my_jobchain(order_id), step=100, error=error occurred | D:\nsca\send_nsca.exe -H monitor_host -c D:\nsca\send_nsca.cfg -d : ]]> NotificationCommand after substitution (recovery case): <![CDATA[echo service_host:JobScheduler Monitoring Errors:0:RECOVERED scheduler id=scheduler_4444, history id=123, job_chain=test/my_jobchain(order_id), step=100, error=error occurred | D:\nsca\send_nsca.exe -H monitor_host -c D:\nsca\send_nsca.cfg -d : ]]> NotificationCommand after substitution (success case): <![CDATA[echo service_host:JobScheduler Monitoring Success:0:scheduler id=scheduler_4444, history id=123, job_chain=test/my_jobchain(order_id), step=100, error= | D:\nsca\send_nsca.exe -H monitor_host -c D:\nsca\send_nsca.cfg -d : ]]> --> <NotificationMonitor service_name_on_error="JobScheduler Monitoring Errors" service_name_on_success="JobScheduler Monitoring Success"> <NotificationCommand><![CDATA[echo service_host:%SERVICE{SERVICE_NAME%:%SERVICE{SERVICE_STATUS%:%SERVICE{SERVICE_MESSAGE_PREFIX%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:\nsca\send_nsca.exe -H monitor_host -c D:\nsca\send_nsca.cfg -d : ]]> </NotificationCommand> </NotificationMonitor> ... |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
... <!-- zabbix_sender Zabbix sender installed on the JobScheduler host localhost Hostname of the zabbix server Zabbix_server JobScheduler Agent name(host name) that registred on Zabbix samples.job1 Item key of zabbix (replace "/" to "." of JOB_NAME %MON{MON_N_ERROR_TEXT%TEXT} See explanation "Table variables" --> <NotificationCommand> <![CDATA[zabbix_sender -z localhost -s zabbix_server -k samples.job1 -o %MON{MON_N_ERROR_TEXT%TEXT}]]> </NotificationCommand> ... |
...