Configuring User-Defined Performance Monitoring for SIP Failure Responses

The User Defined Failure PM table lets you configure up to 26 (ID 1-26) user-defined performance monitoring rules for SBC calls. Each rule represents a group of performance monitoring parameters that counts the number of specified SIP failure responses (e.g., SIP 403 and 504) or specified responses generated internally by the device (e.g., CAC limit reached). You can configure the group rule to count responses due to sent SIP INVITE or REGISTER messages. In other words, these performance monitoring parameters only count calls that fail before they can be established.

Each user-defined performance monitoring group includes the following 12 performance monitoring parameters (e.g., SNMP MIB names of user-defined group of Index 1):

■ Global (all calls):
● acKpiSbcUserDefinedCurrentGlobalUserDefinedFailuresIn1Total: A realtime counter (incremental) indicating the total number of incoming responses.
● acKpiSbcUserDefinedIntervalGlobalUserDefinedFailuresIn1: A historical gauge indicating the total number of incoming responses.
● acKpiSbcUserDefinedCurrentGlobalUserDefinedFailuresOut1Total: A realtime counter (incremental) indicating the total number of outgoing responses.
● acKpiSbcUserDefinedIntervalGlobalUserDefinedFailuresOut1: A historical gauge indicating the total number of outgoing responses.
■ Per IP Group:
● acKpiSbcUserDefinedCurrentIpGroupUserDefinedFailuresIn1Total: A realtime counter (incremental) indicating the total number of incoming responses per IP Group.
● acKpiSbcUserDefinedIntervalIpGroupUserDefinedFailuresIn1: A historical gauge indicating the total number of incoming responses per IP Group.
● acKpiSbcUserDefinedCurrentIpGroupUserDefinedFailuresOut1Total: A realtime counter (incremental) indicating the total number of outgoing responses per IP Group.
● acKpiSbcUserDefinedIntervalIpGroupUserDefinedFailuresOut1: A historical gauge indicating the total number of outgoing responses per IP Group.
■ Per SRD:
● acKpiSbcUserDefinedCurrentSrdUserDefinedFailuresIn1Total: A realtime counter (incremental) indicating the total number of incoming responses per SRD.
● acKpiSbcUserDefinedIntervalSrdUserDefinedFailuresIn1: A historical gauge indicating the total number of incoming responses per SRD.
● acKpiSbcUserDefinedCurrentSrdUserDefinedFailuresOut1Total: A realtime counter (incremental) indicating the total number of outgoing responses per SRD.
● acKpiSbcUserDefinedIntervalSrdUserDefinedFailuresOut1: A historical gauge indicating the total number of outgoing responses per SRD.
● These performance monitoring parameters only count original responses and not responses that you may have manipulated using Message Manipulation rules. For example, if you have configured a user-defined PM rule to count SIP 408 responses and you have a Message Manipulation rule that changes SIP 403 responses into SIP 408, the performance monitoring parameters will not include these manipulated responses in its' count.
● The performance monitoring parameters consider incoming SIP CANCEL messages as SIP 487 responses.
● The performance monitoring parameters don't count SIP BYE requests.

The following procedure describes how to configure user-defined PM rules through the Web interface. You can also configure it through ini file [UserDefinedFailurePM] or CLI (configure system > user-defined-failure-pm).

➢ To configure user-defined PMs:
1. Open the User Defined Failure PM table (Monitor menu > Monitor tab > Performance Monitoring folder > User Defined Failure PM).
2. Click New; the following dialog box appears:

3. Configure the rule according to the parameters described in the table below.
4. Click Apply.

User Defined Failure PM Table Parameter Descriptions

Parameter

Description

'Index'

[Index]

Defines an index number for the new table row.

Note: Each row must be configured with a unique index.

'User-Defined Failure PM ID'

user-defined-failure-pm

[PMIndex]

Defines the index (ID) of the performance monitoring parameter group. The ID appears in the name of the performance monitoring parameters (e.g., acKpiSbcUserDefinedCurrentGlobalUserDefinedFailuresIn1Total).

The valid value is 1 to 26. The default is 1.

Note: Each rule must be configured with a unique ID.

'Description'

description

[Name]

Defines a descriptive name for the rule.

By default, no value is defined.

'SIP Method'

method

[Method]

Defines the SIP method to which the rule is applied.

■ [1] INVITE = (Default) The performance monitoring parameter group counts only responses associated with INVITE messages.
■ [3] REGISTER = The performance monitoring parameter group counts only responses associated with REGISTER messages. These messages apply to registration failures, including device-initiated registrations according to the SBC User Information table and Accounts table.

'SIP Reason Code'

sip-reason

[SIPReason]

Defines the SIP failure reason(s) to count. This is the response that is received due to the sent SIP method, configured in the 'SIP Method' parameter (above).

The valid value is a SIP response code. You can configure a range of response codes, using the "xx" wildcard (e.g., 4xx). You can configure the parameter with multiple codes, where each code is separated by a comma (e.g., 408,430,5xx). To denote all SIP response codes, configure the parameter to "any".

Note: For the device to apply the rule, you must configure this parameter or the 'Internal Reason Code' parameter (below).

'Internal Reason Code'

internal-reason

[InternalReason]

Defines the failure reason(s) that is generated internally by the device to count. This response is generated due to the sent SIP method, configured in the 'SIP Method' parameter (above).

The valid value is a number representing the internal reason, as shown in the table below. You can configure the parameter with multiple reasons, where each number is separated by a comma (e.g., 1,3,17). To denote all SIP responses, configure the parameter to "All".

Value

Failure Reason

1

Unassigned Number (GWAPP_UNASSIGNED_NUMBER)

3

No Route To Destination (GWAPP_NO_ROUTE_TO_DESTINATION)

17

User Busy (GWAPP_USER_BUSY)

18

No User Responding (GWAPP_NO_USER_RESPONDING)

19

Alert Timeout (GWAPP_NO_ANSWER_FROM_USER_ALERTED)

21

Call Rejected (GWAPP_CALL_REJECTED)

41

Network Temporary Failure (GWAPP_NETWORK_TEMPORARY_FAILURE)

63

Service Not Available (GWAPP_SERVICE_NOT_AVAILABLE)

318

RTP Broken Connection (RELEASE_BECAUSE_RTP_CONN_BROKEN)

320

Device Locked (RELEASE_BECAUSE_GW_LOCKED)

327

Media Mismatch (RELEASE_BECAUSE_MEDIA_MISMATCH)

332

Preemption Due To High Priority (RELEASE_BECAUSE_PREEMPTION_DUE_TO_HIGH_PRIORITY)

333

Preemption Failed (RELEASE_BECAUSE_PREEMPTION_FAILED)

806

Media Limit In Crossed (RELEASE_BECAUSE_IN_MEDIA_LIMITS_EXCEEDED)

807

Call Transferred (RELEASE_BECAUSE_CALL_TRANSFERRED)

808

Classification Failed (RELEASE_BECAUSE_CLASSIFICATION_FAILED)

809

Authentication Failed (RELEASE_BECAUSE_AUTHENTICATION_FAILED)

811

ARM Drop (RELEASE_BECAUSE_ARM_DROP)

812

Media Destination Unreachable (RELEASE_BECAUSE_MEDIA_DEST_UNREACHABLE)

818

No User Found (RELEASE_BECAUSE_NO_USER_FOUND)

819

Admission In Crossed (RELEASE_BECAUSE_IN_ADMISSION_FAILED)

820

Admission Out Crossed (RELEASE_BECAUSE_OUT_ADMISSION_FAILED)

821

Media Limit In Crossed (RELEASE_BECAUSE_IN_MEDIA_LIMITS_EXCEEDED)

822

User Blocked (RELEASE_BECAUSE_USER_BLOCKED)

850

ACD Threshold Crossed (RELEASE_BECAUSE_ACD_THRESHOLD_CROSSED)

851

ASR Threshold Crossed (RELEASE_BECAUSE_ASR_THRESHOLD_CROSSED)

852

NER Threshold Crossed (RELEASE_BECAUSE_NER_THRESHOLD_CROSSED)

853

IP Group Registration Mode (RELEASE_BECAUSE_IPGROUP_REGISTRATION_MODE)

855

Internal Route (RELEASE_BECAUSE_INTERNAL_ROUTE)

857

Other Forked Call Answered (RELEASE_BECAUSE_OTHER_FORKED_CALL_ANSWERED)

858

Media Sync failed (RELEASE_BECAUSE_MEDIA_SYNC_FAILED)

859

Register Threshold Crossed (RELEASE_BECAUSE_REG_MAX_THRESHOLD_CROSSED)

Note: For the device to apply the rule, you must configure this parameter or the 'SIP Reason Code' parameter (above).