1/31
Contents
Title and Copyright Information
Preface
Audience
Related Documents
Documentation Accessibility
Part I Configuring Converged Application Server
1
Converged Application Server Configuration Overview
About the Oracle WebLogic Platform
Overview of Configuration and Administration Tools
Administration Console
WebLogic Scripting Tool (WLST)
Additional Configuration Methods
Editing Configuration Files
Custom JMX Applications
Common Configuration Tasks
2
Getting Started
Accessing the Administration Console
Locking and Persisting the Configuration
Using WLST (JMX) to Configure Converged Application Server
Configuration MBeans for the SIP Servlet Container
Locating the Converged Application Server MBeans
WLST Configuration Examples
Invoking WLST
WLST Template for Configuring Container Attributes
Creating and Deleting MBeans
Working with URI Values
Setting Logging Levels
Startup Sequence for a Converged Application Server Domain
Startup Command Options
Reverting to the Original Boot Configuration
3
Configuring Converged Application Server Container Properties
Configure General SIP Application Server Properties
Adding Servers to the Converged Application Server Cluster
Configuring Timer Processing
Configuring Timer Affinity (Optional)
Configuring NTP for Accurate SIP Timers
4
Configuring Network Connection Settings
Overview of Network Configuration
Configuring External IP Addresses in Network Channels
About IPv4 and IPv6 Support
Enabling DNS Support
Configuring Network Channels for SIP or SIPS
Reconfiguring an Existing Channel
Creating a New SIP or SIPS Channel
Configuring Custom Timeout, MTU, and Other Properties
Configuring SIP Channels for Multihomed Machines
Configuring Engine Servers to Listen on Any IP Interface
Configuring Static Source Port for Outbound UDP Packets
Configuring Listen Addresses for Servers
Configuring Coherence Cluster Addressing
5
Using the Engine Cache
Overview of Engine Caching
Configuring Engine Caching
Monitoring and Tuning Cache Performance
6
Configuring Coherence
About Coherence Engine Communication and State Management
Configuring Coherence for Engine Communication and State Management
About Call-State Storage and Management for SIP Calls
Configuring Coherence Call-State Storage
Modifying the Call-State Storage Configuration
Monitoring Coherence Call-State Storage
7
Configuring Server Failure Detection
Overview of Failover Detection
Coherence Cluster Overview
Split-Brain Handling
Coherence Configuration
Cluster Configuration File
8
Avoiding and Recovering From Server Failures
Failure Prevention and Automatic Recovery Features
High Availability
Overload Protection
Redundancy and Failover for Clustered Services
Automatic Restart for Failed Server Instances
Managed Server Independence Mode
Automatic Migration of Failed Managed Servers
Geographic Redundancy for Regional Site Failures
Directory and File Backups for Failure Recovery
Enabling Automatic Configuration Backups
Storing the Domain Configuration Offline
Backing Up Logging Servlet Applications
Backing Up Security Data
Backing Up the WebLogic LDAP Repository
Backing Up Additional Operating System Configuration Files
Restarting a Failed Administration Server
Restarting an Administration Server on the Same System
Restarting an Administration Server on Another System
Restarting Failed Managed Servers
9
Storing Long-Lived Call State Data in an RDBMS
Overview of Long-Lived Call State Storage
Requirements and Restrictions
Configuring RDBMS Call State Storage
Create the Database Schema
Configure JDBC Resources
Configuring Persistence Options (Primary and Secondary Sites)
Using Persistence Hints in SIP Applications
10
Configuring Geographically-Redundant Installations
About Geographic Redundancy
Situations Best Suited to Use Geo-Redundancy
Situations Not Suited to Use Geo-Redundancy
Geo-Redundancy Considerations
Using Geographically-Redundant SIP Engines
Example Domain Configurations
Requirements and Limitations
Steps for Configuring Geographic Persistence
Configuring Geographic Redundancy
Configuring JDBC Resources (Primary and Secondary Sites)
Configuring Persistence Options (Primary Site Only)
Configuring JMS Resources Options (Primary Site Only)
Configuring Persistence Options (Secondary Sites)
Configuring JMS Resources (Secondary Site Only)
Configuring Cross Domain Security (Both Primary and Secondary Sites)
Understanding Geo-Redundant Replication Behavior
Call State Replication Process
Call State Processing After Failover
Removing Backup Call States
Monitoring Replication Across Regional Sites
Troubleshooting Replication
11
Upgrading Deployed SIP Applications
Overview of SIP Application Upgrades
Requirements and Restrictions for Upgrading Deployed Applications
Steps for Upgrading a Deployed SIP Application
Assign a Version Identifier
Defining the Version in the Manifest
Deploy the Updated Application Version
Undeploy the Older Application Version
Roll Back the Upgrade Process
Accessing the Application Name and Version Identifier
Using Administration Mode
Part II Configuring Infrastructure Components
12
Configuring the Proxy Registrar
About Proxy Registrar Configuration
Setting Authentication for the Proxy Registrar
Using the Administration Console to Configure Trusted Hosts
Configuring the Proxy Registrar
Configure the Proxy
Configuring the Registrar
Configuring the Proxy-Required Options for the Sip Server Proxy
Provisioning Users
Launching Sash
Launching Sash from the Command Line
Connecting Sash to an External Converged Application Server Instance
Connecting to an External Instance of Converged Application Server
Using Sash
Viewing Available Commands
Viewing Subcommands
Creating a User
Creating a User from the Sash Command-Line Prompt
Creating a User with the Command Service MBean
Creating a User with the Identity Add Command
Deleting a User
Scripting with Sash
Error Logging in Sash
13
Configuring Diameter Client Nodes and Relay Agents
Overview of Diameter Protocol Configuration
About the Diameter Domain Template
Steps for Configuring Diameter Client Nodes and Relay Agents
Installing the Diameter Domain Template
Creating TCP, TLS, and SCTP Network Channels for the Diameter Protocol
Configuring Two-Way SSL for Diameter TLS Channels
Configuring and Using SCTP for Diameter Messaging
Configuring Diameter Nodes
Creating a New Node Configuration (General Node Configuration)
Configuring Diameter Applications
Configuring the Sh Client Application
Configuring the Rf Client Application
Configuring the Ro Client Application
Configuring a Diameter Relay Agent
Configuring the Sh and Rf Simulator Applications
Enabling Profile Service (Using an Sh Backend)
Configuring Peer Nodes
Configuring Routes
Example Domain Configuration
Troubleshooting Diameter Configurations
Part III Monitoring, Tuning, and Troubleshooting
14
Monitoring, Tuning, and Troubleshooting Overview
Getting Started: Your System Stack
Hardware/VM Monitoring, Tuning, and Troubleshooting
Operating System and CPU Monitoring, Tuning, and Troubleshooting
JVM Monitoring, Tuning and Troubleshooting
Converged Application Server Monitoring, Tuning, and Troubleshooting
15
Monitoring the Sessions for License Limits
About the Monitoring of Licenses
About the License Metrics
About the High Water Mark
About the Monitoring Process
Setting Up the Logging Parameters
Configuring the License Tracking as Startup Command Options
About the Log Information
16
Monitoring, Tuning, and Troubleshooting the JVM
Profiling JVM Performance
Using Java Flight Recorder
Using the Command Line
Using Diagnostic Command
Configuring Recordings
Creating Recordings Automatically
Troubleshooting
Java Flight Recorder Command Reference
Using Java Mission Control
Starting the Java Mission Control Client
Using the Java Mission Control GUI
Creating Thread and Heap Dumps Using jcmd
Creating a Heap Dump using jcmd
Creating a Thread Dump using jcmd
Other jcmd Commands
jcmd Command Reference
The Java Control+Break Handler
Tuning JVM Garbage Collection for Production Deployments
Goals for Tuning Garbage Collection Performance
Modifying JVM Parameters in Server Start Scripts
Tuning Garbage Collection with Oracle JDK
Avoiding JVM Delays Caused by Random Number Generation
Troubleshooting Memory Leaks
17
Configuring Converged Application Server SNMP
Overview of Converged Application Server SNMP
Browsing the MIB
Configuring SNMP
Understanding and Responding to SNMP Traps
Trap Descriptions
overloadControlActivated, overloadControlDeactivated
serverStopped
sipAppDeployed
sipAppUndeployed
sipAppFailedToDeploy
18
Converged Application Server Debugging and Tuning
Debugging Issues in the Runtime Environment
About the Runtime Debug Process
About the Debug Attributes Configuration Method
Recommended Debug Log Settings
Issues that Require the Enabling of Multiple Debug Attributes
SIP Specific Issues Involving Calls
Transport-level Issues
Server Does not Process SIP Messages
Locking and Timer-related Issues
Message Validation Issues
Enabling the Runtime Debug Attributes
Server Performance Tuning Recommendations
Manage SIP Application Session Timeout
Max Application Session Timeout
Specifying the Minimum Thread Pool Size
Files for Troubleshooting
19
Converged Application Server Monitoring and Overload Protection
About Monitoring and Overload Protection
SIP Server and Application Monitoring
General
SIP Performance
SIP Applications
Call State Storage
Call State Service
Call State Cache
Call State Metadata Cache
Call State Index Cache
Other Ways to Monitor Converged Application Server
Monitoring Applications with the WebLogic Scripting Tool
Developing Custom Management Utilities with JMX
WebLogic Server Diagnostic Framework
About Converged Application Server Overload Protection
About the Overload Protection Framework
Configuring Overload Protection
About Event Handlers
Configuring an Event Handler
About Actions
Configuring an Action
About Statistics Collectors
Configuring a Statistics Collector
About Thresholds
Configuring a Threshold
Example: Configuring Overload Protection Based upon Session Rate
20
Using the WebLogic Server Diagnostic Framework (WLDF)
Overview of Converged Application Server and the WLDF
Data Collection and Logging
Watches and Notifications
Image Capture
Instrumentation
Configuring Server-Scoped Monitors
Configuring Application-Scoped Monitors
21
Logging SIP Requests and Responses
Overview of SIP Logging
Defining Logging Servlets in sip.xml
Configuring the Logging Level and Destination
Specifying the Criteria for Logging Messages
Using XML Documents to Specify Logging Criteria
Using Servlet Parameters to Specify Logging Criteria
Specifying Content Types for Unencrypted Logging
Enabling Log Rotation and Viewing Log Files
trace-pattern.dtd Reference
Adding Tracing Functionality to SIP Servlet Code
Order of Startup for Listeners and Logging Servlets
Part IV Reference
22
Engine Server Configuration Reference (sipserver.xml)
Overview of sipserver.xml
Editing sipserver.xml
Steps for Editing sipserver.xml
XML Schema
Example sipserver.xml File
XML Element Description
enable-timer-affinity
message-debug
proxy—Setting Up an Outbound Proxy Server
t1-timeout-interval
t2-timeout-interval
t4-timeout-interval
timer-b-timeout-interval
timer-f-timeout-interval
max-application-session-lifetime
enable-local-dispatch
cluster-loadbalancer-map
default-behavior
default-servlet-name
retry-after-value
sip-security
route-header
engine-call-state-cache-enabled
server-header
server-header-value
persistence
use-header-form
enable-dns-srv-lookup
connection-reuse-pool
globally-routable-uri
domain-alias-name
enable-rport
image-dump-level
stale-session-handling
enable-contact-provisional-response
23
SIP Coherence Configuration Reference (coherence.xml)
Overview of coherence.xml
Editing coherence.xml
XML Schema
Example coherence.xml File
XML Element Description
24
Diameter Configuration Reference (diameter.xml)
Overview of diameter.xml
Editing diameter.xml
Steps for Editing diameter.xml
XML Schema
Example diameter.xml File
XML Element Description
configuration
target
host
realm
address
port
tls-enabled
sctp-enabled
debug-enabled
message-debug-enabled
application
class-name
param*
name
value
peer-retry-delay
allow-dynamic-peers
request-timeout
watchdog-timeout
include-origin-state-id
supported-vendor-id+
peer+
host
address
port
protocol
route
realm
application-id
action
server+
default-route
action
server+
Scripting on this page enhances content navigation, but does not change the content in any way.