[8.5.5.7 or later]
This topic applies to WebSphere Application Server Liberty V8.5.5.9 and earlier. For the latest Liberty topics, see the WebSphere Application Server Liberty documentation.

Troubleshooting the SIP container session repository on Liberty

When you troubleshoot the SIP container session repository, you might need the SIP session details to dump to a specified trace file.

About this task

You can use the SIP session memory dump utility to help debug problems that are related to SIP container sessions. The SIP container provides the SipContainerMBean method to perform several serviceability type operations on the SIP container, including the initiation of a server quiesce through the command line. This task describes how you can use the SipContainerMBean method to dump SIP application session and SIP session information that is contained in the in-memory session repository for SIP containers. By configuring the SIPContainerMBean method to use various trace methods, you can specify the SIP session details to dump to the specified trace file.

When the session dump methods are started, the requested information about the sessions prints by default into the console.log file. You can also send the information to a predefined source specified on the setDumpMethod method.

You can run the dumping utility in two modes, succinct and verbose. When you use the succinct session dump methods, only the session IDs are printed for every dump method execution. If you want to use the verbose session dump methods, the following actions occur:
  • Transaction user details, along with the SIP session details, if they exist, print for every dump method execution.
  • The only attributes that dump to the trace file are those attributes that the JSR 289 specification permits for exposure.
  • The verbose methods print the following information in the trace file: appName, callID, dialog state, creation time, attribute names.

The trace printouts occur per SIP application; therefore, the sorting of all the SIP session data structures occurs before printing. The SIPContainerMBean dump facility runs in a low-priority thread so that the tracing does not affect the call processing latency of the overall system for a production server.

The dump distinguishes between a transaction user that has a SIP session versus a transaction user that has no SipSession object. Also included in the dump, in a delineated fashion, are SIP sessions that no longer exist, that are no longer valid, or that exist at the time of the trace snapshot.

On Liberty, you can invoke the SIPContainerMBean dumping methods in two ways:
  • By running the server dump command
  • By implementing a Java™ Management Extensions (JMX) client that establishes a connection to the JMX connector to invoke the methods
The following succinct SipContainerMBean methods are used to dump SIP session IDs.
Table 1. Succinct SipContainerMBean methods used to dump SIP session information
Method Description
dumpAllSASIds() Prints a number of all SIP application sessions and the SIP application session IDs.
dumpAllTUSipSessionIds() Prints a number of transaction users and the SIP session IDs within the transaction user (TU), if one exists.
The following verbose SipContainerMBean methods are used to dump SIP session details.
Table 2. Verbose SipContainerMBean methods used to dump SIP session information
Method Description
dumpAllSASDetails() Prints a number of all SIP application sessions and the SIP application session ID details.
dumpAllTUSipSessionDetails() Prints a number of transaction users and details of the SIP session IDs within the transaction user (TU), if one exists.
dumpSASDetails(String sasId) Prints the details of the SIP application session that is specified by the sasId parameter.
dumpSipSessionDetails(String sessionId) Prints the details of the SIP session that is specified by the sessionId parameter.
Note: Use the following information to help parse print output:
  • For all print output, the first line provides an application name and a number of records.
  • The delimiter between the output is a TAB.
  • The delimiter between session attributes is a ; (semi-colon).

Procedure


Icon that indicates the type of topic Task topic



Timestamp icon Last updated: Tuesday, 12 December 2017
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=phil&product=was-libcore-mp&topic=twlp_sip_trblsipcontsess
File name: twlp_sip_trblsipcontsess.html