The following sections describe how WebLogic SIP Server is integrated with the WebLogic Diagnostic Framework (WLDF):
The WebLogic Diagnostic Framework (WLDF) consists of a number of components that work together to collect, archive, and access diagnostic information about a WebLogic Server instance and its applications. WebLogic SIP Server version 3.1 integrates with several components of the WLDF in order to monitor and diagnose the operation of engine and data tier nodes, as well as deployed SIP Servlets:
The sections that follow provide more details about how WebLogic SIP Server integrates with each of the above WLDF components. Seein the WebLogic Server 9.2 documentation for more information about how the WLDF works, and how to configure different WLDF components. See also in the WebLogic Server 9.2 documentation for information about using the WLDF console extension to collect and monitor diagnostic information.
WebLogic SIP Server uses the WLDF Harvester service to collect data from the attributes of these runtime MBeans:
You can add charts and graphs of this data to your own custom views using the WLDF console extension. To do so, first enable the WLDF console extension by copying the JAR file into the
console-ext subdirectory of your domain directory:
cp ~/bea/sipserver31/server/lib/console-ext/diagnostics-console-extension.jar ~/bea/user_projects/domains/mydomain/console-ext
When accessing the WLDF console extension, the WebLogic SIP Server runtime MBean attributes are available in the Metrics tab of the extension. Seein the WebLogic Server 9.2 documentation for more information.
WebLogic SIP Server also uses the WLDF Logger service to archive SIP and Diameter messages to independent, dedicated log files. In previous releases, log information was written to a common log file, along with general WebLogic Server log messages. WebLogic SIP Server 3.1 now logs messages to a dedicated log file (by default, domain_home
/sipMessages.log). You can configure the name and location of the log file, as well as log rotation policies, using the Configuration->Message Debug tab in the SIP Server Administration Console extension. See in Developing Applications with WebLogic SIP Server. Note that a server restart is necessary in order to initiate independent logging and log rotation.
The data collected from WebLogic SIP Server runtime MBeans can be used to create automated monitors, or “watches,” that observe a server’s diagnostic state. One or more notifications can then be configured for use by a watch, in order to generate a message using SMTP, SNMP, JMX, or JMS when your configured watch conditions and rules occur.
To use watches and notifications, you select the Diagnostics->Diagnostic Modules node in the left pane of the Administration Console and create a new module with the watch rules and notifications required for monitoring your servers. The watch rules can use the metrics collected from WebLogic SIP Server runtime MBeans, messages written to the log file, or events generated by the diagnostic framework. Seein the WebLogic SIP Server 9.2 Administration Console Help for more information.
WebLogic SIP Server 3.1 adds its own image capture information to the diagnostic image generated by the WLDF. You can generate diagnostic images either on demand, or automatically by configuring watch rules.
The information contained in diagnostic images is intended for use by BEA technical support personnel when troubleshooting a potential server problem and includes:
Seein the WebLogic SIP Server 9.2 Administration Console Help for more information on generating diagnostic images.
The WLDF instrumentation system creates diagnostic monitors and inserts them into WebLogic SIP Server or application code at specific points in the flow of execution. WebLogic SIP Server integrates with the instrumentation service to provide a built-in DyeInjection monitor. When enabled, this monitor injects dye flags into the diagnostic context when certain SIP messages enter or exist the system. Dye flags are injected based on the monitor’s configuration properties, and on certain request attributes.
WebLogic SIP Server adds the dye flags described in Table 3-1 below, as well as the WebLogic Server dye flags USER and ADDR. The available WebLogic Server dye flags are described inin the WebLogic Server 9.2 documentation.
This flag is set if a SIP request contains a header matching the value of the property SIP_ANY_HEADER. The value of SIP_ANY_HEADER is specified using the format messageType.headerName=headerValue where
Dye flags can be applied to both incoming and outbound SIP messages. The flags are useful for dye filtering, and can be used by delegating monitors to trigger further diagnostic actions. Seein the WebLogic Server 9.2 documentation for information about configuring the monitor.
WebLogic SIP Server provides several delegating monitors that can be applied at the application and server scope, and which may examine dye flags set by the DyeInjection monitor. The delegating monitors are described in Table 3-2.
To use the server-scoped monitors, you must create a new diagnostic module and create and configure one or more monitors in the module. For the built-in DyeInjection monitor, you then add monitor properties to define the specific dye flags. For delegating monitors such as Sip_Servlet_Before_Message_Send_Internal, you add monitor properties to define diagnostic actions.
Follow these steps to configure the WebLogic SIP Server DyeInjection monitor, a delegate monitor, and enable dye filtering:
|Note:||You can repeat the above steps to create additional delegate monitors.|
You configure application-scoped monitors in an XML configuration file named
weblogic-diagnostics.xml. You must store the
weblogic-diagnostics.xml file in the SIP module’s or enterprise application’s
The XML file enables instrumentation at the application level, defines point cuts, and also defines delegate monitor dye masks and actions. Listing 3-1 shows a sample configuration file that uses the Sip_Servlet_Before_Service monitor.
In this example, if an incoming request’s diagnostic context contains the
SIP_ANY_HEADER dye flag, then the
Sip_Servlet_Before_Service monitor is triggered and the
DisplayArgumentsAction is executed.
weblogic-diagnostics.xml configuration file.