Skip to end of metadata
Go to start of metadata

Diagram

Elements

NotificationMonitor
References Notes

Specifies the System Monitor that is being used for notification: either by a Plugin Interface or by command line invocation.

service_name_on_error

This setting is used for Nagios or derivative software and specifies the service status code for error messages.

service_name_on_success

This setting is used for Nagios or derivative software and 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

This setting is used for Nagios or derivative software and 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_status_on_success

This setting is used for Nagios or derivative software and specifies the service status code for success messages.

Element Type Required Description
Attribute: service_name_on_error string
Optional

This setting is used for Nagios or derivative software and specifies the service status code for error messages.

Attribute: service_name_on_success string
Optional

This setting is used for Nagios or derivative software and 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.

Attribute: service_status_on_error string
Optional

This setting is used for Nagios or derivative software and 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.

Attribute: service_status_on_success string
Optional

This setting is used for Nagios or derivative software and specifies the service status code for success messages.

NotificationInterface
  • Occurrence: 1
Required
References Notes

NSCA Plugin Interface to be executed for System Monitor notification.

All variables (except OS environment variables) must be defined by using of the ${<variable name>} syntax.

  • Syntax for the JobScheduler version 1.10.6 and higher. Syntax for the JobScheduler version 1.10.4, 1.10.5 (see below) is still supported.
  • Syntax for the JobScheduler version 1.10.4, 1.10.5:
    • {<variable name>}
  • Syntax for the JobScheduler previous versions:
    • %<variable name>%


Examples

  • Message on error 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}
  • Message on success scheduler id=${MON_N_SCHEDULER_ID}, history id=${MON_N_ORDER_HISTORY_ID}, job_chain=${MON_N_JOB_CHAIN_NAME}(${MON_N_ORDER_ID}), steps(${MON_SN_STEP_FROM} to ${MON_SN_STEP_TO}), order time elapsed = ${MON_N_ORDER_TIME_ELAPSED}s
  • Message on timer name = ${MON_C_NAME}, scheduler id=${MON_N_SCHEDULER_ID}, history id=${MON_N_ORDER_HISTORY_ID}, job_chain=${MON_N_JOB_CHAIN_NAME}(${MON_N_ORDER_ID}), steps(${MON_C_STEP_FROM} to ${MON_C_STEP_TO}), check = ${MON_C_CHECK_TEXT}

service_host
This setting is used for Nagios or derivative software and specifies the name of the host that executes the passive check. The name must match the corresponding setting in the System Monitor.
monitor_host
This setting is used for Nagios or derivative software and specifies the hostname or ip address of System Monitor host.
monitor_port
This setting is used for Nagios or derivative software and specifies the TCP port that the System Monitor would listen to.
monitor_password
This setting is used for Nagios or derivative software and specifies the password of System Monitor host.
monitor_connection_timeout
This setting is used for Nagios or derivative software and specifies the connection timeout in ms. By default 5000ms will be used.
monitor_response_timeout
This setting is used for Nagios or derivative software and specifies the response timeout in ms.
monitor_encryption
This setting is used for Nagios or derivative software and specifies that the communication with the System Monitor is encrypted. By default no encryption is used: * NONE: no encryption * XOR: * TRIPLE_DES: use of triple des algorhythm for encryption
plugin
This setting specifies the package and class name of the java plugin that executes the passive check. By default SystemNotifierSendNscaPlugin will be used.
NotificationCommand
  • Occurrence: 1
Required
References Notes

Command line to be executed for System Monitor notification.

Command examples:

plugin
This setting specifies the package and class name of the java plugin that executes the command. By default SystemNotifierProcessBuilderPlugin will be used.
NotificationMail
  • Occurrence: 1
Required
References Notes

Mail Interface to be executed for System Monitor notification.

content_type
Content type of the e-mail. Possible values are "text/plain" and "text/html".
charset
Charset of the e-mail.
encoding
Encoding of the e-mail. Possible values are 7bit, Quoted-Printable, Base64.
priority
Priority of the e-mail.
NotificationJMS
  • Occurrence: 1
Required
References Notes

JMS Interface to be executed for System Monitor notification.

client_id
The client identifier for this connection.
destination
  • Queue - creates a Queue object which encapsulates a specified provider-specific queue name.
  • Topic - creates a Topic object which encapsulates a specified provider-specific topic name.
acknowledge_mode

  • Session.AUTO_ACKNOWLEDGE - with this acknowledgment mode, the session automatically acknowledges a client's receipt of a message either when the session has successfully returned from a call to receive or when the message listener the session has called to process the message successfully returns.
  • Session.CLIENT_ACKNOWLEDGE - with this acknowledgment mode, the client acknowledges a consumed message by calling the message's acknowledge method.
  • Session.AUTO_ACKNOWLEDGE - this acknowledgment mode instructs the session to lazily acknowledge the delivery of messages.

delivery_mode

The delivery modes supported by the JMS API are PERSISTENT and NON_PERSISTENT.

  • DeliveryMode.NON_PERSISTENT - this is the lowest-overhead delivery mode because it does not require that the message be logged to stable storage.
  • DeliveryMode.PERSISTENT - this delivery mode instructs the JMS provider to log the message to stable storage as part of the client's send operation.

priority

The JMS API defines ten levels of priority value, with 0 as the lowest priority and 9 as the highest.

Clients should consider priorities 0-4 as gradations of normal priority and priorities 5-9 as gradations of expedited priority.

time_to_live

Sets the default length of time in milliseconds from its dispatch time that a produced message should be retained by the message system.

Time to live is set to zero by default.

Possible values:

  • <n> - duration in milliseconds, e.g.: 60000
  • <n>s - duration in seconds, e.g.: 30s
  • <n>m - duration in minutes, e.g.: 30m
  • <n>h - duration in hours, e.g.: 24h
  • <n>d - duration in days, e.g.: 30d
  • <n>w - duration in weeks, e.g.: 4w

Combined values (with blank as separator):

  • e.g.: 1w 1d 1h

plugin

Java class of the plugin implementation.

Extends com.sos.jitl.notification.plugins.notifier.SystemNotifierCustomPlugin

Default: com.sos.jitl.notification.plugins.notifier.SystemNotifierSendJMSPlugin