System Administrator’s Guide

     Previous  Next    Open TOC in new window    View as PDF - New Window  Get Adobe Reader - New Window
Content starts here

Managing and Configuring EDRs, CDRs and Alarms

The following section describes how to manage and configure EDRs, CDRs, and alarms in Oracle Communications Services Gatekeeper.

 


About EDRs, CDRs, and Alarms

Event Data Records (EDRs), are generated in the following ways:

EDR categories and XML markup

EDRs are the base component of both CDRs and alarms: they are, in fact, subsets of EDRs.

In order to categorize the objects in the EDR flow as either pure EDRs, alarms or CDRs, the EDR service uses an EDR configuration file:

$DOMAIN_HOME/config/custom/wlng-edr.xml

The configuration file contains a set of sections:

Out-of-the-box, Oracle Communications Services Gatekeeper comes with a set of pre-defined descriptors. Changing and adapting the descriptors is done as a part of an integration project.

The XML configuration file can be edited and reloaded using the EDR Configuration pane, see Managing EDR, CDR, and alarms configuration files using the EDR Configuration Pane.

Listing 7-1 illustrates the structure of wlng-edr.xml. See section in Oracle Communications Services Gatekeeper Platform Development Studio - Developer’s Guide for more information.

Listing 7-1 structure of wlng-edr.xml
<edr-config xsi:schemaLocation="http://www.bea.com/ns/wlng/30 edr-config.xsd">
  <edr id="<ID>" description="<description>">
    <filter>
      <method>
        <name><message response> <message></name>
        <class><fully qualified class name></class>
      </method>
    </filter>
  </edr>
.....
</edr-config>

EDR format

The following values are always available in an EDR when it is generated from an aspect:

In addition to these values, the EDR may also contain values relevant to the context of the request.

Figure 7-1 Plug-in north and plug-in south EDR generation

Plug-in north and plug-in south EDR generation

Below is a description of the contents of an EDR. Individual value fields in an EDR are retrieved by name using a key in a name/value pair.

Table 7-1 Contents of an EDR
String value of name (key) in name/ value pair
Description
EdrId
Defined in wlng-edr.xml
ServiceName
The name, or type, of the service.
ServerName
Name of server where the EDR was generated.
Timestamp
The time at which the EDR was triggered.
Milliseconds since midnight, January 1, 1970 UTC.
ContainerTransactionId
WebLogic Server transaction ID (if available)
Class
Name of the class that logged the EDR
Method
Name of the method that logged the EDR
Direction
Direction of the request
Source
The type of source that logged the EDR
Position
Position of the EDR relative to the method that logged the EDR
Interface
Interface where the EDR is logged
Exception
Name of the exception that triggered the EDR
SessionId
Session ID
ServiceProviderId
Service provider account ID
ApplicationId
Application account ID
AppInstanceGroupId
Application instance ID.
OrigAddress
The originating address with scheme included. For example tel:1212771234
DestAddress
The destination address, or addresses, with scheme included.
May contain multiple addresses.
<custom>
Any additional context-specific information

EDRs

All EDRs are passed through the EDRService. All EDRs are dispatched to a JMS distributed topic so external clients can receive them over JMS.

EDRs are not persisted in the database.

Alarms

Alarms are EDRs that are mapped to alarms using the alarm.xml configuration file: see EDR categories and XML markup.

Alarms can be configured to be persisted, see Attribute: StoreAlarms.

CDRs

CDRs are EDRs that are mapped to CDRs using the wlng-edr.xml configuration file, see EDR categories and XML markup.

CDRs can be configured to be persisted, see Attribute: StoreCDRs.

External EDR listeners

External EDR listeners are JMS topic subscribers, see section in Oracle Communications Services Gatekeeper Platform Development Studio - Developer’s Guide for information on how to create a EDR listeners.

 


EDRService

Configuration of the EDRService

To configure the behavior of the EDRService, in the managed object EdrService:

  1. Specify Attribute: PublishToJMS.
  2. Specify Attribute: StoreAlarms.
  3. Specify Attribute: StoreCDRs.

Management of the EDRService

Defining batch attributes

To configure the maximum number of EDRs sent in a batch to a JMS EDR listener and the maximum time to wait before the EDRs in the buffer are sent to listeners:

  1. Specify Attribute: BatchTimeout.
  2. Specify Attribute: BatchSize.

Reference: Attributes and Operations for EDRService

Managed object: Container ServicesArrow symbolEdrService

MBean: com.bea.wlcp.wlng.edr.management.EdrServiceMBean

Below is a list of attributes and operations for configuration and maintenance.

Attribute: BatchTimeout

Scope: Cluster

Format: int

Unit: milliseconds

Specifies the time-out value for a JMS batch.

Attribute: StatisticsEnabled

Scope: Cluster

Format: boolean

Specifies if statistics is enabled for EDRService. Must be enabled for Operation: displayStatistics to be relevant.

Attribute: BatchSize

Scope: Cluster

Format: int

Unit: number of EDRs

Specifies the size of the JMS batch.

Attribute: PublishToJMS

Scope: Cluster

Format: boolean

Specifies if EDRs shall be published in the JMS topic or not. Needs to be true if external EDR listeners are used.

Attribute: StoreAlarms

Scope: Cluster

Format: boolean

Specifies if alarms shall be stored in the database or not.

Attribute: StoreCDRs

Scope: Cluster

Format: boolean

Specifies if CDRs shall be stored in the database or not.

Operation: displayStatistics

Scope: Cluster

Displays a snapshot of the current statistics for EDRService. Attribute: StatisticsEnabled must be true in order for this operation to be relevant.

The following information is displayed:

Signature:

displayStatistics()

Table 7-2 displayStatistics
displayStatistics
Parameter
Description
-
-

Operation: resetStatistics

Scope: Cluster

Resets the statistics for the EDRService.

Signature:

resetStatistics()

Table 7-3 resetStatistics
resetStatistics
Parameter
Description
-
-

 


Managing EDR, CDR, and alarms configuration files using the EDR Configuration Pane

The Oracle Communications Services Gatekeeper EDR Configuration pane allows the administrator to load new EDR, CDR, and Alarm configuration files.

Open the pane by selecting OCSGArrow symbol<Server Name>Arrow symbolEDR Configuration from the Domain Structure in the Administration Console.

Note: Lock and Edit must be used.

Table 7-4 Oracle Communications Services Gatekeeper EDR Configuration pane
Entry field
Input
EDR descriptor:
The EDR configuration file, see EDR categories and XML markup.
CDR descriptor
The CDR configuration file, see EDR categories and XML markup.
Alarm descriptor
The alarms configuration file, see EDR categories and XML markup.


  Back to Top       Previous  Next