Persistent Protocol Tracing

This section explains how to configure persistent protocol tracing to capture specific SIP protocol message logs and persistently send them off the Oracle® Enterprise Session Border Controller, even after rebooting the system. This feature is not applicable to log for H.323 or IWF.

About Persistent Protocol Tracing

You can configure sending protocol message logs off of the Oracle® Enterprise Session Border Controller, and have that persist after a reboot. You no longer have to manually issue the notify command each time you reboot.

To support persistent protocol tracing, you configure the following system-config parameters:

• call-trace—Enable/disable protocol message tracing (currently only sipmsg.log and alg.log) regardless of the process-log-level setting. If the process-log-level is set to trace or debug, call-trace will not disable.
• internal-trace—Enable/disable internal ACP message tracing for all processes, regardless of process-log-level setting. This applies to all *.log (internal ACP message exchange) files other than sipmsg.log and alg.log. If the process-log-level is set to trace or debug, call-trace will not disable.
• log-filter—Determine what combination of protocol traces and logs are sent to the log server defined by the process-log-ip parameter value. You can also fork the traces and logs, meaning that you keep trace and log information in local storage as well as sending it to the server. You can set this parameter to any of the following values: none, traces, traces-fork, logs, logs, all, or all-fork.

  The Oracle® Enterprise Session Border Controller uses the value of this parameter in conjunction with the process-log-ip and process-log-port values to determine what information to send. If you have configured the proc-log-ip and proc-log-port parameters, choosing traces sends just the trace information (provided they are turned on), logs sends only process logs (log.*), and all sends everything (which is the default).

About the Logs

When you configure persistent protocol tracing, you affect the following types of logs.

Note:

Enabling logs can have an impact on Oracle® Enterprise Session Border Controller performance.

Process Logs

Events are logged to a process log flow from tasks and are specific to a single process running on the Oracle® Enterprise Session Border Controller. By default they are placed into individual files associated with each process with the following name format:

log.<taskname>

By setting the new log-filter parameter, you can have the logs sent to a remote log server (if configured). If you set log-filter to logs or all, the logs are sent to the log server. Otherwise, the logs are still captured at the level the process-log-level parameter is set to, but the results are stored on the Oracle® Enterprise Session Border Controller’s local storage.

Communication Logs

These are the communication logs between processes and system management. The logs are usually named <name>.log, with <name> being the process name. For example, sipd.log.

This class of log is configured by the new internal-trace parameter.

Protocol Trace Logs

The only protocol trace logs included at this time are sipmsg.log for SIP. The H.323 system tracing is not included. All of the logs enabled with the call–trace parameter are sent to remote log servers, if you also set the log-filter parameter to logs or all.

Persistent Protocol Tracing Configuration

Before you configure persistent protocol tracing, ensure you have configured the process logs by setting the system configuration’s process-log-ip parameter.

To configure persistent protocol tracing:

1. In Superuser mode, type configure terminal and press Enter.

   ORACLE# configure terminal

2. Type system and press Enter to access the system-level configuration elements.

   ORACLE(configure)# system

3. Type system-config and press Enter. The system prompt changes to let you know that you can begin configuring individual parameters.

   ORACLE(system)# system-config
   ORACLE(system-config)#

4. call-trace—Set to enabled to enable protocol message tracing for sipmsg.log for SIP. The default is disabled. The valid values are:

   • enabled | disabled

5. internal-trace—Set to enabled to enable internal ACP message tracing for all processes. The default is disabled. The valid values are:

   • enabled | disabled

6. log-filter—Choose the appropriate setting for how you want to send and/or store trace information and process logs. The valid values are:

   • none—No information will be sent or stored.

   • traces—Sends the trace information to both the log server; includes <name>.log files that contain information about the Oracle® Enterprise Session Border Controller’s internal communication processes (<name> is the name of the internal process)

   • traces-fork—Sends the trace information to both the log server and also keeps it in local storage; includes <name>.log files that contain information about the Oracle® Enterprise Session Border Controller’s internal communication processes (<name> is the name of the internal process)

   • logs—Sends the process logs to both the log server; includes log.* files, which are Oracle® Enterprise Session Border Controller process logs

   • logs-fork—Sends the process logs to both the log server and also keeps it in local storage; includes log.* files, which are Oracle® Enterprise Session Border Controller process logs

   • all—Sends all logs to the log servers that you configure

   • all-fork—Sends all logs to the log servers that you configure, and it also keeps the logs in local storage

7. Save and activate your configuration.