Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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. 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
                  Code Block
                  languagehtml/xml
                    ....
                    <!--
                         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):

...