The Call State Service subtab of the Call State Storage subtab describes state and statistics about the call state Coherence cache service for the entire Converged Application Server domain.

For more details on Coherence statistics and monitoring, see "Introduction to Coherence Management" in Coherence Management Guide.

The Call State Cache subtab of the Call State Storage subtab describes state and statistics about the call state Coherence cache for the entire Converged Application Server domain.

The Call State Metadata Cache subtab of the Call State Storage subtab describes state and statistics about the call state metadata Coherence cache for the entire Converged Application Server domain.

The Call State Index Cache subtab of the Call State Storage subtab describes state and statistics about the call state index Coherence cache for the entire Converged Application Server domain.

To configure an overload protection event handler:

1. Open the Administration Console for your domain.
2. If your domain is running in Production mode, click Lock & Edit.
3. Click the SipServer link in the Domain Structure pane.

   The right pane of the console provides two levels of tabbed pages that are used for configuring and monitoring Converged Application Server. By default, the General configuration subtab is selected.

4. Click the Overload Protections subtab and then click the Event Handlers subtab.
5. In the Event Handlers table, click New.

   Enter the following information:

   • Event Handler Name: Required. Enter a name for the event handler, for example: com.oracle.sendSnmpTrap

     Table 3-9 Default Event Handlers

     Event Handler	Description
     com.bea.wcp.sip.engine.server.olp.handler.ControlTrafficHandler	Used for a new call setup on a SIP container and either reject or accept call traffic.
     com.bea.wcp.sip.engine.server.olp.handler.SendSNMPTrapHandler	Used to send SNMP traps.

   • Attributes: Optional. Specify key/value attribute pairs separated by semicolons, for example: attribute1=21;attribute2=64

     Attributes are passed to the event handler as parameters when the event is triggered.

     Note:

     The com.bea.wcp.sip.engine.server.olp.handler.SendSNMPTrapHandler event handler supports a snmp-trap-message attribute. Its default value is overloadControlActivated. No attributes are supported for the com.bea.wcp.sip.engine.server.olp.handler.ControlTrafficHandler event.
6. Click Save to save your configuration changes.
7. If your domain is running in Production mode, click Activate Changes to apply your changes to the engine servers.

To configure an overload protection action:

1. Open the Administration Console for your domain.
2. If your domain is running in Production mode, click Lock & Edit.
3. Click the SipServer link in the Domain Structure pane.

   The right pane of the console provides two levels of tabbed pages that are used for configuring and monitoring Converged Application Server. By default, the General configuration subtab is selected.

4. Click the Overload Protections subtab and then click the Actions subtab.
5. In the Actions table, click New.

   Enter the following information:

   • Action Name: Required. Enter a name for the action, for example:

     TrafficReject
     

   • Event Handler: Required. Choose the name of an event handler you have created from the drop down list. For information on configuring an event handler, see "About Event Handlers".
   • Action Type: Required. Enter an Action Type supported by the Event Handler, for example:

     reject-traffic
     

     Table 3-10 Default Action Types

     Action Type	Description
     accept-traffic	Used by the event handler, com.bea.wcp.sip.engine.server.olp.handler.ControlTrafficHandler . After an overload condition has cleared, accepts SIP session traffic.
     reject-traffic	Used by the event handler, com.bea.wcp.sip.engine.server.olp.handler.ControlTrafficHandler . When an overload condition occurs, rejects SIP session traffic. SIP session traffic will continue to be rejected until an accept-traffic action is triggered.
     default	Used by the event handler, com.bea.wcp.sip.engine.server.olp.handler.SendSNMPTrapHandler.

   • Attributes: Optional. Specify key/value attribute pairs separated by semicolons, for example:

     attribute1=21;attribute2=64
     

     Attributes are passed when the action is triggered.

     Note:

     Support for attributes is dependent upon the implementation of the particular action. None of the default Action Types support any attributes.
6. Click Save to save your configuration changes.
7. If your domain is running in Production mode, click Activate Changes to apply your changes to the engine servers.

To configure an overload protection statistics collector:

1. Open the Administration Console for your domain.
2. If your domain is running in Production mode, click Lock & Edit.
3. Click the SipServer link in the Domain Structure pane.

   The right pane of the console provides two levels of tabbed pages that are used for configuring and monitoring Converged Application Server. By default, the General configuration subtab is selected.

4. Click the Overload Protections subtab and then click the Statistics Collector subtab.
5. In the Statistics Collector table, click New.

   Enter the following information:

   • Statistics Collector Name: Required. Enter a name for the action, for example: MBeanStatsCollector
   • Statistics Collector Type: Required. Enter an Action Type supported by the Event Handler, for example: mbean-stats

     The following table lists the Statistics Collector Types supplied with Converged Application Server.

     Table 3-11 Default Statistics Collector Types

     Statistics Collector Type	Description
     queue-length	Uses the sum of the length of the transport and timer work manager queue lengths.
     mbean-stats	Uses an MBean counter as a statistics example.
     memory-usage	Returns the call state memory usage from Coherence.
     active-diameter-session	Returns the number of active Diameter sessions.

   • Attributes: Optional except for the mbean-stats collector type. Specify key/value attribute pairs separated by semicolons, for example: attribute1=21;attribute2=64

     Attributes are passed when the action is triggered.

     Note:

     The mbean-stats collector lets you use an MBean counter for statistics samples. When configuring the collector, the attributes object-name and attribute-name must be set so that the collector can find the attribute value of the particular MBean.

     For the object-name attribute, a variable ${server_name} can be used that will be replaced with name of managed server on which the statistics collector is running.

     The following example shows a configuration retrieving the ServerAppSessionCount from the SipServerRuntime MBean on the current server.

     object-name="com.bea:ServerRuntime=${server_name},Name=${server_name},Type=SipServerRuntime";attribute-name=ServerAppSessionCount

     For a complete list of Converged Application Server MBeans, see the Oracle Communications Converged Application Server Java API Reference.

6. Click Save to save your configuration changes.
7. If your domain is running in Production mode, click Activate Changes to apply your changes to the engine servers.

To configure an overload protection Threshold:

1. Open the Administration Console for your domain.
2. If your domain is running in Production mode, click Lock & Edit.
3. Click the SipServer link in the Domain Structure pane.

   The right pane of the console provides two levels of tabbed pages that are used for configuring and monitoring Converged Application Server. By default, the General configuration subtab is selected.

4. Click the Overload Protections subtab and then click the Thresholds subtab.
5. In the Thresholds table, click New.

   Enter the following information:

   • Threshold Name: Required. Enter a name for the action, for example:

     queueLengthThreshold
     

   • Threshold Value: Required. Enter the level of the threshold. This is the value that the threshold must exceed to trigger an event, for example:

     10.0

     Note:

     The Threshold Value cannot be greater than 100.

   • Sampling Mode: Required. Choose either realtime or sampling from the drop down list. In realtime mode, statistics are compared against the Threshold Value when every initial SIP message is received. No calculations are supported.
   • Sampling Interval. Required when sampling mode is selected. Enter the interval at which samples should be taken in milliseconds, for example:

     1000
     

   • Sampling Number. Required when sampling mode is selected. Enter the number of samples to be taken at each Sampling Interval, for example:

     5
     

   • Algorithm Name: Required. Choose an appropriate algorithm to calculate samples.

     Table 3-12 Algorithm Types

     Algorithm Name	Description
     PERCNTILE	Calculates the Pth percentile value of the samples. When PERCNTILE is selected, an Algorithm Parameter value must be provided.
     AVERAGE	Calculates the average of the samples (sum of samples divided by number of samples).
     VALUE	The straight value of the last sample.
     RATE	The sample rate calculated as (last sample - first sample)/(sampling interval).

   • Algorithm Parameter: Required when the PERCNTILE algorithm is selected. Enter a percentile value that the threshold must match, for example:

     65
     

   • Enable: Optional. Check Enable to enable the Threshold.
6. Click Next.
7. Choose the Actions to be executed when a threshold is breached upwards (if any) by moving an Action from the Available list to the Chosen list.
8. Click Next.
9. Choose the Actions to be executed when a threshold is breached downwards (if any) by moving an Action from the Available list to the Chosen list.
10. Click Finish to save your configuration changes.
11. If your domain is running in Production mode, click Activate Changes to apply your changes to the engine servers.