The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Cisco Unified Border Element (SP Edition) provides various features for working with logs. Logging can be configured so that logs are generated under specified conditions. Logs can also be generated on demand. Information derived from the logs can be used for analyzing and troubleshooting issues pertaining to the operation of the network and for identifying areas for improvement in the network.
Cisco Unified Border Element (SP Edition) was formerly known as Integrated Session Border Controller and may be commonly referred to in this document as the session border controller (SBC).
For a complete description of the commands used in this chapter, refer to Cisco Unified Border Element (SP Edition) Command Reference: Unified Model at:
http://www.cisco.com/en/US/docs/ios/sbc/command/reference/sbcu_book.html
For information about all Cisco IOS commands, use the Command Lookup Tool at http://tools.cisco.com/Support/CLILookup or a Cisco IOS master commands list.
Feature History for Logging Support
All the Cisco Unified Border Element (SP Edition) debug messages that are displayed on the console are recorded in the Cisco IOS syslog. All the Cisco IOS syslog commands that configure log size, persistence, and redirection can be used for managing the syslog.
In addition to the console messages, Cisco Unified Border Element (SP Edition) records a log in its own internal buffer. This is known as the problem determination log and is saved in the event of a software-forced reload or as a result of using the sbc dump-diagnostics command. When you compile the problem reports, the problem determination log file is included as part of the problem reports.
The Session Border Controller (SBC) application uses an internal log level to control the verbosity of the console and the PD log. Although both the console and problem determination log levels can be changed independently, we do not recommend changing the problem determination log level because the problem determination log buffer is of limited size and important logs may be lost.
The default SBC problem determination logging level is 63 for the console and 60 for the buffer. You can change the default SBC problem determination logging level using the debug sbc log-level console command, the debug sbc log-level filter command, or the debug sbc log-level buffer command.
|
|
---|---|
To enable the syslog functionality on the SBC, set the internal log levels, and issue the syslog-specific logging commands. The following example assumes a default problem determination level of 63 (no further action is needed if this is a fresh reboot).
1. Enable logging using the following commands:
Note The logging standby command allows the synchronization of the active and standby syslog settings.
2. Configure the location to which you want the syslog messages to be sent. Locations can be one of the following:
– Console: logging console <1-7>
– Buffer: logging buffer <1-7>
Note Use the show logging command to view the logging statistics and the logging buffer. Use the clear logging command to clear the logging buffer.
– Syslog server: logging trap <1-7>
Note The logging device-id command allows the customization of syslog messages when sending the log to a remote server.
– Telnet sessions: logging monitor <1-7>
– SNMP management station: logging history <1-7>
– Supervisor: logging supervisor <1-7>
3. Configure specific syslog message manipulation:
4. Configure the global syslog settings:
The Call Log Correlation feature enables all the correlation logs associated with a particular call to be linked together using a correlator ID. This feature also enables real-time filtering of logs on a particular call. A 64-bit diagnostics correlator is assigned to each SIP call, REGISTER, SUBSCRIBE, or NOTIFY messages.
You can set the filters based on the following parameters:
The logs that match the selected filter type are saved in a separate problem determination trace file and inter process signal (IPS) trace file.
Use the following command to enable the correlation-logs filter:
debug sbc sbc-name correlation-logs filter filter-name [pdtrc-log-level value]
Use the following command to disable the correlation-logs filter:
no debug sbc sbc-name correlation-logs filter filter-name
Use the following command to display the debug logs, filters, and log levels:
You can set the problem determination log level in the filter using the pdtrc-log-level option in the debug sbc sbc-name correlation-logs filter filter-name [pdtrc-log-level value ] command. The problem determination trace log level ranges from 0 to 100. The default log level is 60. A log level of 100 indicates that no logs are output, and 0 indicates that all the logs are output.
Table 44-1 lists the problem determination log levels:
|
|
---|---|
The following example shows the various filters available for filtering the correlation logs:
The following example shows the filtering of correlation logs based on the adjacency parameter:
The following example shows the filtering of correlation logs based on the dialing number parameter:
The following example shows the filtering of correlation logs based on the remote signalling address parameter:
The following example shows the filtering of correlation logs based on the SIP URI parameter:
The following example shows the filtering of correlation logs based on the VRF parameter:
You can configure the SBC to generate alarms for various types of events associated with the operation of the SBC. You can also configure the SBC to log debugging information, which you can use to monitor and tune the functioning of the system. On the basis of the alarms, you can take corrective and preventive action to ensure that the SBC continues functioning according to your business requirements. It is also important to monitor the alarms generated by the SBC over a period of time and analyze this information. To address this requirement, you can configure the SBC to generate, display, and store alarm logs. The information provided in the alarm logs can help resolve some common issues, such as interoperability problems and incorrect configurations. These logs can also be used to identify issues that might potentially require escalation and investigation by more specialized support staff. Information in the logs can be used to improve the overall efficiency of the system.
Note All alarm log information is lost after a route processor failover.
You can use any combination of the following commands to configure alarm logs:
This task explains the commands that you can use to configure alarm logs. Note that it is not mandatory to use any particular command described in this task. You can use any combination of these commands to configure alarm logs.
1. debug sbc sbc-name alarm-filter alarm-type
2. debug sbc sbc-name alarm-log-level [buffer | console] severity-level
3. sbc periodic-dump-alarms {dump-location file-system [time-period time-period ] | time-period time-period }
The following sample output of the show debugging command shows the debugging settings created by running the debug sbc alarm-filter command and the debug sbc alarm-log-level command. In this example, these debug commands have been used to specify that logs must be generated for call audit congestion alarms that are of severity level 60 or higher and that these logs must be moved to the specified file system at 120-minute intervals: