2 Setting Up Processing Tier Parameters

This chapter describes how to set up parameters that define how the entire Processing Tier operates. The chapter provides information on configuring the Processing Tier using the Administration Console and Java MBeans.

About Processing Tier Configuration

Configuration of the Processing Tier includes setting up parameters that define the following:

Monitoring: Runtime MBeans that provide statistics and notifications related to the tier performance rather than an individual Service Broker module. For more information, see "Monitoring Service Broker" in Oracle Communications Service Broker System Administrator's Guide.
Overload Protection: Protects Service Broker from failures during unexpected traffic peaks. For more information, see "Preventing System Overload" in Oracle Communications Service Broker System Administrator's Guide.

You can manage the Processing Tier functionality using the Tier Management node in the Domain Navigation pane.

Configuring Monitoring Parameters

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:

Orchestration Engine
Interworking Modules
Supplementary Modules

Monitoring parameters that you can configure for each of these components are common for all the components. However, you can set up 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.

Warning:

Thresholds that you define for notifications serve also as thresholds for key overload indicators. If you select a measurement (Runtime MBean and attribute) as a trigger for both notification and overload protection, the threshold value that you specify in the Monitoring tab is also regarded in the context of overload protection.

This section describes how to set up monitoring using the Service Broker Administration Console and Java MBeans:

Configuring Monitoring with the Administration Console
Configuring Monitoring with Java MBeans

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.

See Oracle Communications Service Broker System Administration Guide for more information on Service Broker monitoring.

The following sections describe these parameters.

Accessing the Monitoring Configuration Screen

To access the Monitoring configuration pane:

Do one of the following according to the component you want to configure for monitoring:
- Orchestration Engine: In the domain navigation pane, expand OCSB, expand Processing Tier, and then select Orchestration Engine.
- Interworking Module: In the domain navigation pane, expand OCSB, expand Processing Tier, expand Interworking Modules and then select the module you want to configure for monitoring.
- Supplementary Module: In the domain navigation pane, expand OCSB, expand Processing Tier, expand Supplementary Modules and then select the module you want to configure for monitoring.
- Processing Tier: In the domain navigation pane, expand OCSB, expand Processing Tier, expand Tier Management and then select Monitoring And Overload Protection.
Click the Monitoring tab.

The Monitoring configuration pane contains the subtabs described in Table 2-1.

Table 2-1 Monitoring Subtabs

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

Subtab

Description

General

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

See "General" for more information.

State Changed Notifications

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

See "State Changed Notifications" for more information.

Threshold Crossed Notifications

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

See "Threshold Crossed Notifications" for more information.

General

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

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

Table 2-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 2-3.

Table 2-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 2-4.

Table 2-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.

Figure 2-1 shows the hierarchy of the monitoring MBeans.

Figure 2-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.

Configuring Overload Protection Parameters

The overload protection mechanism prevents Service Broker failures during traffic peaks. See "Preventing System Overload" in Oracle Communications Service Broker System Administrator's Guide for more information.

The Overload Protection Configuration screen lets you define key overload indicators that you identified, and for which you have defined thresholds using the Thresholds Crossed Notifications subtab of the Monitoring tab.

This section describes how to define key overload indicators and how to configure overload protection behavior, using the Service Broker Administration Console and Java MBeans:

Configuring Overload Protection with the Administration Console
Configuring Overload Protection with Java MBeans

Configuring Overload Protection with the Administration Console

To access the Overload Protection configuration pane:

In the navigation tree in the domain navigation pane, expand OCSB.
Expand Processing Tier.
Expand Tier Management.
Select Monitoring and Overload Protection.
In the configuration pane, click the Overload Protection tab.

The Overload Protection tab contains the subtabs described in Table 2-5.

Table 2-5 Overload Protection Subtabs

Tab	Description
Key Overload Indicators	Enables you to configure gauges and counters that you identified as key overload indicators, to be valid key overload indicators. See "Configuring the Overload Protection Method" for more information.
Overload Protection Methods	Enables you to configure how Service Broker responds to SIP and Diameter network entities that attempt to establish sessions during system overload

Tab

Description

Key Overload Indicators

Enables you to configure gauges and counters that you identified as key overload indicators, to be valid key overload indicators.

See "Configuring the Overload Protection Method" for more information.

Overload Protection Methods

Enables you to configure how Service Broker responds to SIP and Diameter network entities that attempt to establish sessions during system overload

Configuring Key Overload Indicators

Key overload indicators are counters and gauges (that is, attributes of any Runtime MBeans, including module-level Runtime MBeans and tier-level Runtime MBeans) that Service Broker monitors to observe system overload. Usually, key overload indicators are mission critical parameters.

System overload occurs when at least one key overload indicator crosses the upper threshold defined on the Thresholds Crossed Notifications subtab of the Monitoring tab of the Monitoring and Overload configuration screen. See "Configuring Monitoring Parameters" for more information.

Note:

To enable Service Broker to observe system overload, you must set up thresholds of Runtime MBean attributes, which you define as key overload indicators, as follows:

If a key overload indicator is a module-level Runtime MBean, you need to set up thresholds using the Monitoring tab of the appropriate module.
If a key overload indicator is a tier-level Runtime MBean, you need to set up thresholds using the Monitoring tab of the Monitoring and Overload configuration screen.

Table 2-6 describes the fields that you define for each key overload indicator.

Table 2-6 Key Indicators Parameters

Name	Type	Description
Name	STRING	Specifies a unique name of a key overload indicator
MBean Instance Name	STRING	Specifies the object name of a Runtime MBean instance whose attribute was identified as key overload indicator.
MBean Attribute Name	INT	Specifies the name of a Runtime MBean attribute (gauge or counter) that you identified as key overload indicator.

Configuring the Overload Protection Method

When system overload occurs, Service Broker declines new sessions and responds to the network entities that attempted to establish new sessions.

The Overload Protection Methods subtab enables you to configure how Service Broker responds to attempts by SIP and Diameter network entities to establish new sessions.

Table 2-7 describes configuration parameters on the Overload Protection Methods subtab.

Table 2-7 Overload Protection Methods Parameters

Name	Type	Description
Enabled	BOOL	Specifies whether or not the overload protection mechanism is enabled. Possible values: True False
SIP Response Status Code	STRING	Specifies a SIP error that Service Broker returns to a SIP network entity when Service Broker declines an attempt to establish a session.
SIP Retry-After	STRING	Specifies the value that Service Broker sets in the Retry-After header of the error response sent to the network entity. This value defines how long the network entity waits before it retries to establish a session.
Diameter Response Result-Code	STRING	Specifies a response Result-Code AVP that Service Broker returns to a Diameter network entity when Service Broker declines the attempt to establish a session.
Web Service Response Status Code	INT	Specifies an error code that Service Broker returns to a Web service network entity when Service Broker declines the attempt to establish a session. Default value: 503
SAL Response Status Code	INT	Specifies an error code that Service Broker returns to a SAL application when Service Broker declines the attempt to establish a session. Default value: 503

Configuring Overload Protection with Java MBeans

Service Broker provides a set of MBeans that provide attributes and operations for configuring overload protection parameters through JMX. Figure 2-2 shows the hierarchy of the overload protection MBeans.

Figure 2-2 OverloadProtectionMBean Hierarchy

MBeans used in configuring overload protection.

The following sections provide reference information for the overload protection configuration MBeans.

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 2-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 2-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 2-4.

Operations

None

OverloadProtectionBean

OverloadProtectionMBean is a root MBean for overload protection configuration.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName getOverloadProtectionIndicators()

Returns a reference to the instance of OverloadProtectionIndicatorsMBean

ObjectName getOverloadProtectionMethods()

Returns a reference to the instance of OverloadProtectionMethodsMBean

OverloadProtectionIndicatorsMBean

OverloadProtectionIndicatorsMBean provides access to instances of OverlodProtectionIndicatorMBean. For each gauge or counter that you identified as a key overload indicator, you need to create a separate instance of OverloadProtectionIndicatorMBean.

Factory Method

Created automatically

Attributes

None

Operations

ObjectName getOverloadProtectionIndicators()

Returns an array of references to instances of OverloadProtectionIndicatorMBean

ObjectName createOverloadProtectionIndicator()

Creates an instance of OverloadProtectionIndicatorMBean

ObjectName destroyOverloadProtectionIndicator()

Destroys an instance of OverloadProtectionIndicatorMBean

ObjectName lookupOverloadProtectionIndicator()

Returns a reference to a specified instance of OverloadProtectionIndicatorMBean

OverloadProtectionIndicatorMBean

OverloadProtectionIndicatorMBean enables you to define a counter or a gauge (that is, an attribute of any Runtime MBean, including module-level Runtime MBeans and tier-level Runtime MBeans), that you wish to set as a valid key overload indicator.

Factory Method

OverloadProtectionIndicators.createOverloadProtectionIndicator()

Attributes

Name
MbeanInstanceName
MbeanAttributeName

See Table 2-6 for more information on these attributes.

Operations

None

OverloadProtectionMethodsMBean

Overload ProtectionMethodsMBean enables you to specify how Service Broker responds to SIP and Diameter network entities that attempt to establish sessions during system overload.

Factory Method

Created automatically

Attributes

Enabled
SipResponseStatusCode
SipRetryAfter
DiameterResponseResultCode
WSResponseStatusCode
SALResponseStatusCode

See Table 2-7 for more information on these attributes.