Page History

...

• MonitoredObject/JobChains (optional) can contain several JobChain definitions for monitoring of error or success conditions
  • JobChain (required) has the following attributes
    • scheduler_id (optional) - JobScheduler instance with the given identification. By default - JobChain will be checked in all JobScheduler instances that logged into the same database
    • name (optional) - Job chain name including possible folder names. By default - all JobChains for defined scheduler_id are checked
    • step_from (optional) - Start Job node name for checking
    • step_to (optional) - End Job node name for checking
      <!--
• MonitoredObject/Jobs (optional) can contain several Job definitions for monitoring of error or success conditions
  • Job (required) has the following attributes
    • scheduler_id (optional) - JobScheduler instance with the given identification. By default - Job will be checked in all JobScheduler instances that logged into the same database
    • name (optional) - Job name including possible folder names. By default - all Jobs for defined scheduler_id are checked
      -->
• MonitoredObject/Timers (optional) can contain several Timer definitions for performance measurement
  • Timer (required) has the following elements
    • JobChains (optional) - can contain several JobChain definitions for performance measurement
      • JobChain (required) has the following attributes
        • scheduler_id (optional) - JobScheduler instance with the given identification. By default - JobChain will be checked in all JobScheduler instances that logged into the same database
        • name (optional) - Job chain name including possible folder names. By default - all JobChains for defined scheduler_id are checked
        • step_from (optional) - Start Job node name for checking
        • step_to (optional) - End Job node name for checking
          <!--
    • Jobs (optional) can contain several Job definitions for performance measurement
      • Job (required) has the following attributes
        • scheduler_id (optional) - JobScheduler instance with the given identification. By default - Job will be checked in all JobScheduler instances that logged into the same database
        • name (optional) - Job name including possible folder names. By default - all Jobs for defined scheduler_id are checked
          -->
    • Minimum (optional) - expected minimum execution time for all configured job chains in the MonitoredObject/Timers/Timer/JobChains
      • Script (required) - definition of the expected minimum value and has the following attributes
        • language (optional) - script engine. currently javascript engine will be supported
    • Maximum (optional) - expected maximum execution time for all configured job chains in the MonitoredObject/Timers/Timer/JobChains
      • Script (required) - definition of the expected maximum value and has the following attributes
        • language (optional) - script engine. currently javascript engine will be supported

...

• SystemMonitorNotification can contain several Notification definitions for notification of error or success conditions
  • Notification (required) contain one NotificationMonitor
    • NotificationMonitor (required) contains the configuration for delivery notifications to System Monitor and has the following attributes
      • service_name_on_error (optional) - Service name to send of error/recovery messages. One of service_name_on_error or service_name_on_success must be set.
      • service_name_on_success (optional) - Service name to send of success messages if order is successfully completed. One of service_name_on_error or service_name_on_success must be set.
      • service_status_on_error (optional) - Service status (e.g. CRITICAL or WARNING) to send of error messages. If not set - CRITICAL will be sended
      • service_status_on_success (optional) - Service status (e.g. SUCCESS) to send of success messages. If not set - OK will be sended
    • NotificationMonitor can has one of the following elements
      • NotificationCommand (optional) command line for calling of the extern script for system notification
      • NotificationInterface (optional) calling API for system notification (currently for NSCA notifications). This Element has the following attributes
        • service_host (required) - hostname for the host the notification are sent from (the way it is named at the System Monitor)
        • monitor_port (required) - port of System Monitor to receive notifications
        • monitor_host (required) - hostname of System Monitor
        • monitor_encryption (required) - specifies that the communication with the System Monitor is encrypted. NONE, XOR, TRIPLE_DES encryptions are available.
      • NotificationObject (required) contains the configuration of objects, which will be sended to System Monitor
        • JobChains (optional) - can contain several JobChain definitions
          • JobChain (required) has the following attributes
            • notifications (optional) - Number of notifications for the same problem (if problem is recovered or acknowledged - no notification will be sended). By default - 1
            • scheduler_id (optional) - JobScheduler instance with the given identification. By default - JobChain will be checked in all JobScheduler instances that logged into the same database
            • name (optional) - Job chain name including possible folder names. By default - all JobChains for defined scheduler_id are checked
            • step_from (optional) - Start Job node name for checking
            • step_to (optional) - End Job node name for checking
              <!--
        • Jobs (optional) can contain several Job definitions
          • Job (required) has the following attributes
            • scheduler_id (optional) - JobScheduler instance with the given identification. By default - Job will be checked in all JobScheduler instances that logged into the same database
            • name (optional) - Job name including possible folder names. By default - all Jobs for defined scheduler_id are checked
              -->
        • Timers (optional) - can contain several Timer definitions
          • Timer (required) has the following elements
            • JobChains (optional) - can contain several JobChain definitions for performance notification
              • JobChain (required) has the following attributes
                • notifications (optional) - Number of notifications for the same check. By default - 1
                • scheduler_id (optional) - JobScheduler instance with the given identification. By default - JobChain will be checked in all JobScheduler instances that logged into the same database
                • name (optional) - Job chain name including possible folder names. By default - all JobChains for defined scheduler_id are checked
                • step_from (optional) - Start Job node name for checking
                • step_to (optional) - End Job node name for checking
                  <!--
            • Jobs (optional) can contain several Job definitions for performance notification
              • Job (required) has the following attributes
              • scheduler_id (optional) - JobScheduler instance with the given identification. By default - Job will be checked in all JobScheduler instances that logged into the same database
              • name (optional) - Job name including possible folder names. By default - all Jobs for defined scheduler_id are checked
                -->

Sample Notification configuration using NotificationInterface

  ....
  <!--
       notification message substitution in this case:
 
        All Environment variables   e.g. %TEMP% or %JAVA_HOME%        
   
        %ORDER_HISTORY_ID% ...      table field name of result row for building message (see table definition SCHEDULER_MON_NOTIFICATIONS)   
        -->
  <NotificationMonitor service_name_on_error="Error Service">
      <NotificationInterface service_host="my_nsca_service_host" monitor_port="5667" monitor_host="nsca_server_host" monitor_encryption="XOR">
      order history id=%ORDER_HISTORY_ID%, job chain=%JOB_CHAIN_NAME%, order id=%ORDER_ID%, step =%ORDER_STEP_STATE%, error=%ERROR_TEXT%, check = %CHECK_TEXT%
      </NotificationInterface>
	
  ...     

<!--
For this concrete example and following the description from above (about the schema):

1. Configure for Notifications to a specific System Monitor: op5 Monitor
2. Specify the type of notification: "service_name_on_error" or "service_name_on_success"
3. Specify then the EXACT name of the service (the way it is named at the System Monitor): "OMS Mass Processing Problem Tracking"
4. Specify the EXACT hostname for the host the notification are sent from (the way it is named at the System Monitor): "OMS Interfacing Server"
5. Specify the port the application to receive passive checks is running on: "5667"
6. Specify the hostname of the System Monitor, that is the hostname for the host the notification are sent from: "dipsy.sos"
7. Define the type of encryption is used to send the information to the System Monitor: "XOR"
8. Specify how many notifications have to be sent to the System Monitor for a specific Job Scheduler object:"20" notfications for "MY_JOB_CHAIN_NAME"
9. The same as above in case there is configured a Timer for this Job Scheduler object:"20" notfications for the Timer for "MY_JOB_CHAIN_NAME"
   -->

...