6 Configuring Service Broker Monitoring

The following sections describe how to configure monitoring of Service Broker using the Administration Console and Java MBeans:

Understanding Service Broker Monitoring Configuration
Configuring Monitoring with the Administration Console
Configuring Monitoring with Java MBeans

Understanding Service Broker Monitoring Configuration

The Service Broker monitoring mechanism enables you to configure how Runtime MBeans operate and how Service Broker generates notifications. You can configure monitoring separately for the entire Processing Tier and for each of the Processing Tier components:

OE
Interworking Modules
Supplementary Modules

Monitoring parameters that you can configure for each of these components are common for all the components. However, you can setup each of these parameters differently for different components depending on your specific requirements.

For example, you can define different triggers for generating notifications for IM-SCF and IM-SSF.

Configuring Monitoring with the Administration Console

This section describes how to configure monitoring of the OE, Interworking Modules, Supplementary Modules, and Processing Tier using the Service Broker Administration Console.

You need to configure monitoring separately for each Interworking Module, Supplementary Module, the OE, and the Processing Tier using the Monitoring Configuration screen. In the Administration Console, each component has its own Monitoring Configuration screen. Configuration parameters are always the same regardless of a component. (For more information on Service Broker monitoring, see the System Administration Guide.)

The following sections describe these parameters.

Accessing the Monitoring Configuration Screen

To access the Monitoring Configuration page:

Depending on a component for which you want to configure monitoring, do one of the following:
- When you want to configure monitoring of the OE, on the Domain Navigation pane, select OCSB > Processing Tier > OE.
- When you want to configure monitoring of an Interworking Module, on the Domain Navigation pane, select OCSB > Processing Tier > Interworking Modules and select the module for which you want co configure monitoring.
- When you want to configure monitoring of a Supplementary Module, on the Domain Navigation pane, select OCSB > Processing Tier > Supplementary Modules and select the module for which you want to configure monitoring.
- When you want to configure monitoring of the Processing Tier, on the Domain Navigation pane, select OCSB > Processing Tier > Tier Management > Monitoring and Overload.
Click the Monitoring tab. The Monitoring Configuration screen contains the subtabs described in Table 6-1.

Table 6-1 Monitoring Subtabs

Subtab	Description
General	Enables you to specify parameters that determine a general behavior of the notification mechanism. For more information, see "General".
State Changed Notifications	Enables you to configure generation of notifications when a value of an attribute of a specified Runtime MBean changes. For more information, see "State Changed Notifications".
Threshold Crossed Notifications	Enables you to configure generation of notifications when a threshold is passed. For more information, see "Threshold Crossed Notifications".

Subtab

Description

General

Enables you to specify parameters that determine a general behavior of the notification mechanism.

For more information, see "General".

State Changed Notifications

Enables you to configure generation of notifications when a value of an attribute of a specified Runtime MBean changes.

For more information, see "State Changed Notifications".

Threshold Crossed Notifications

Enables you to configure generation of notifications when a threshold is passed.

For more information, see "Threshold Crossed Notifications".

General

The General subtab enables you to specify parameters that determine a general behavior of the Runtime MBeans.

Table 6-2 describes configuration parameters on the General subtab.

Table 6-2 General Monitoring Parameters

Name	Type	Description
Enable Runtime MBeans	BOOL	Specifies whether or not JMX Runtime MBeans are enabled. Possible values: True False Default value: True
Enable Notifications	BOOL	Specifies whether or not JMX notifications are enabled. Possible values: True False Default value: False
Notification Trigger Check Interval in Seconds	INT	Specifies the interval between consecutive sampling of counters. Counters are sampled every few seconds to check whether to invoke notifications. Default value: 30
Counter Interval in Seconds	INT	Runtime MBean counters provide measurements recorded in a recent time interval. This parameter specifies the length of this interval in seconds. Default value: 900

State Changed Notifications

The State Changed Notifications subtab enables you to configure a notification that Service Broker generates when an attribute of a specified Runtime MBean changes to a specified value.

The State Changed Notifications subtab contains a table in which each row represents an individual notification trigger condition based on an attribute of a specific Runtime MBean.

When configuring notifications, you need to specify the fields described in Table 6-3.

Table 6-3 State Changed Notifications

Field	Type	Description
Name	STRING	Specifies a notification name
Enabled	BOOL	Specifies whether or not the notification is enabled. Possible values: True False Default value: True
MBean Type	STRING	Specifies a type of the Runtime MBean to be monitored
MBean Attribute	STRING	Specifies an attribute of the MBean defined in the MBean Type field to be monitored. Notice that in this parameter, you can specify only status attributes. Status attributes indicate a state of a resource.
Value	STRING	Specifies an attribute value that triggers generation of the notification
Server Filter	STRING	Specifies a filter that must be applied on the "server" key property on an MBean's instance name. If this parameter is defined, only the MBean instances with the registration name that matches the filter trigger the notification. The value of this parameter must be defined in the form of a regular expression. Default value: \S* (no filter)
Resource Filter	STRING	Specifies a filter that must be applied on the "name" key property of an MBean's instance name. If this parameter is defined, only the MBean instances with the registration name that matches the filter trigger the notification. The value of this parameter must be defined in the form of a regular expression. For example, if you want to monitor MessageByOperationRuntimeMbean's counters of a specific operation, set ResourceFilter to "\SInitialDP\S". Default value: \S* (no filter)
Message	STRING	Specifies a message to be set in the "message" field of the notification. Default value: "notification"

Threshold Crossed Notifications

The Threshold Crossed Notifications subtab enables you to configure generation of notifications when a threshold is passed. The Threshold Crossed Notifications subtab contains a table in which each row represents an individual notification triggering condition based on an attribute of a specific Runtime MBean.

When configuring notifications, you need to specify the fields described in Table 6-4.

Table 6-4 Threshold Crossed Notifications Fields

Field	Type	Description
Name	STRING	Specifies a unique notification name
Enabled	BOOL	Specifies whether or not the notification is enabled. Possible values: True False Default value: True
MBean Type	STRING	Specifies a type of the Runtime MBean to be monitored
MBean Attribute	STRING	Specifies an attribute of the MBean defined in the MBean Type field to be monitored
Class	STRING	Specifies a notification class. Possible values: High A notification is triggered when a Runtime MBean counter or gauge crosses an upper threshold. Low A notification is triggered when a Runtime MBean counter or gauge crosses an lower threshold. Default value: High
Threshold Value	INT	Specifies a high threshold, when the Class field is set to "High", or low threshold, when the Class field is set to "Low"
Threshold Ceased Value	INT	Specifies a threshold for which the "ceased" notification must be triggered
Server Filter	STRING	Specifies a filter that must be applied on the "server" key property on an MBean's instance name. If this parameter is defined, only the MBean instances with the registration name that matches the filter trigger the notification. The value of this parameter must be defined in the form of a regular expression. Default value: \S* (no filter)
Resource Filter	STRING	Specifies a filter that must be applied on the "name" key property of an MBean's instance name. If this parameter is defined, only the MBean instances with the registration name that matches the filter trigger the notification. The value of this parameter must be defined in the form of a regular expression. For example, if you want to monitor MessageByOperationRuntimeMbean's counters of a specific operation, set ResourceFilter to "\SInitialDP\S". Default value: \S* (no filter)
Threshold Crossed Message	STRING	Specifies a text for the notification message that Service Broker generates when a threshold is crossed.
Threshold Ceased Message	STRING	Specifies a text for the notification message that Service Broker generates when a notification is ceased.

Configuring Monitoring with Java MBeans

Service Broker provides a set of MBeans that contain attributes and operations for configuring monitoring through JMX. You need to configure monitoring separately for each Interworking Module, Supplementary Module, the OE, and the Processing Tier using instances of monitoring MBeans created for a particular component. Attributes and operations of monitoring MBeans are always the same regardless of a component.

The hierarchy of the monitoring MBeans is shown on Figure 6-1.

Figure 6-1 Monitoring MBeans Hierarchy

The following sections provide reference information for the monitoring configuration MBeans.

Note:

MBeans described in this guide may include additional advanced attributes, which are not described in the guide. Advanced attributes are reserved for internal use. Do not change these attributes.

MonitoringGeneralMBean

MonitoringGeneralMBean enables you to configure SIP SSU monitoring tools, such as logger, counters, and notifications.

Factory Method

Created automatically

Attributes

CounterIntervalInSeconds
EnableRuntimeMbeans
EnableNotifications
NotificationTriggerCheckIntervalInSeconds

For more information on these attributes, see Table 6-2.

Operations

None

StateChangedNotificationRulesMBean

StateChangedNotificationRulesMBean is a root MBean for configuring attribute change notifications.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName createStateChangedNotificationRule()

Creates a new instance of StateChangedNotificationRuleMBean

void destroyStateChangedNotificationRule()

Destroys an existing instance of ChangeNotificationMBean

ObjectName[] getStateChangedNotificationRule()

Returns a list of StateChangedNotificationRuleMBean instances

ObjectName lookupStateChangedNotificationRule()

Returns a specified instance of StateChangedNotificationRuleMBean

StateChangedNotificationRuleMBean

StateChangedNotificationRuleMBean enables you to configure how attribute change notifications for individual attributes of specified runtime MBeans are generated. StateChangedNotificationRulesMBean creates a separate instance of StateChangedNotificationRuleMBean for each attribute of an MBean.

Factory Method

StateChangedNotificationRules.createStateChangedNotificationRule()

Attributes

Name
Enabled
MBeanType
MBeanAttribute
Value
ServerFilter
ResourceFilter
Message

For more information on these attributes, see Table 6-3.

Operations

None

ThresholdCrossedNotificationRulesMBean

ThresholdCrossedNotificationRulesMBean is a root MBean for configuring how notifications of a counter or gauge crossing a threshold are generated.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName createThresholdCrossedNotificationRule()

Creates a new instance of ThresholdCrossedNotificationRuleNotificationMBean

void destroyThresholdCrossedNotificationRule()

Destroys an existing instance of ThresholdCrossedNotificationRuleMBean

ObjectName[] getThresholdCrossedNotificationRule()

Returns a list of ThresholdCrossedNotificationRuleMBean instances

ObjectName lookupThresholdCrossedNotificationRule()

Returns a specified instance of ThresholdCrossedNotificationRuleMBean

ThresholdCrossedNotificationRuleMBean

ThresholdCrossedNotificationRuleMBean enables you to configure how threshold notifications for individual attributes of specified runtime MBeans are generated. ThresholdCrossedNotificationRulesMBean creates a separate instance of ThresholdCrossedNotificationRuleMBean for each attribute of an MBean.

Factory Method

ThresholdCrossedNotificationRules.createThresholdCrossedNotificationRule()

Attributes

Name
Enabled
MBeanType
MBeanAttribute
Class
ThresholdValue
ThresholdCeasedValue
ServerFilter
ResourceFilter
ThresholdCrossedMessage
ThresholdCeasedMessage

For more information on these attributes, see Table 6-4.

Operations

None