Cisco IOSRP Trace Management User Manual PDF: Настройка и отладка трассировки (EN)

Introduction to Conditional Debugging and Radioactive Tracing

Trace Management Information About Trace Management, on page 1 How to Configure Conditional Debugging, on page 4 Configuration Examples for Trace Management, on page 7 Additional References for Trace Management, on page 10 Feature History for Trace Management, on page 10 Information About Trace Management The tracing functionality logs internal events. Trace files are automatically created and saved on the persistent storage device of specific platforms. If the device has issues, the contents of the trace files are useful to troubleshoot the issue.

The trace file outputs provide logs that are used to locate and solve the issue, and helps to get a detailed view of system actions and operations. To view the recent trace information for a specific process, use the show logging [process | Profile | process-helper] command. The process keyword uses the first few letters of the name of a process and provides trace logs of the process that starts or matches with the entered string, the profile keyword lists the predefined set of process names, and the profile-helper keyword displays the available names.

To change the verbosity in a trace message output, you can adjust the trace level of processes using the set platform software trace level command. You can choose the all keyword to adjust the trace level for all the processes listed or you can select a specific process. When you select a specific process, there's also the option to adjust the trace level for a specific module, or you can use the all-modules keyword to adjust all the modules of processes. Introduction to Binary Tracing Binary tracing is helpful in gathering trace information with a minimal impact on performance.

In binary tracing, the tracing is always on for the system components and a basic level of trace is collected on all the time; thus, the data necessary for troubleshooting a problem has been captured the first time it occurs. Introduction to Conditional Debugging and Radioactive Tracing The Conditional Debugging feature allows you to enable debugging and logging for specific features based on the set of conditions you define. This feature is useful in systems where many features are supported. Trace Management 1

Стр. 1

Tracing Levels

The Conditional debug allows granular debugging in a network that is operating at a large scale with a large number of features. It allows you to observe detailed debugs for granular instances within the system. This type of debugging is useful when we need to debug only a particular session among thousands of sessions. It's also possible to specify multiple conditions. A condition refers to a feature or identity, where an identity could be an interface, IP Address, or a MAC address and so on. Conditional debugging is in contrast to the general debug command, that produces its output without discriminating on the feature objects that are being processed.

General debug command consumes numerous system resources and impacts the system performance. Radioactive tracing provides the ability to form a chain of execution for operations of interest across the system, at an increased verbosity level. This provides a way to print conditionally debug information (up to DEBUG Level or a specified level) across threads, processes, and function calls. Radioactive Tracing when coupled with Conditional Debugging, provides a single debug command to debug all execution contexts related to the condition.

You can execute this command without being aware of the various control flow processes of the feature within the box and without having to issue debugs at these processes individually. Tracing Levels Trace level determines the types of traces outputted. Each trace message is assigned a trace level. If the trace level of a process or its module it set as greater than or equal to the level as the trace message, the trace message is displayed otherwise, it's skipped. For example, the default trace level is Notice level, so all traces with the Notice level and below the notice level are included while the traces above the Notice level are excluded.

The following table shows the available tracing levels, and provides descriptions of the message that are displayed with each tracing level. The tracing levels listed in the table are from the lowest to the highest order. The default trace level is Notice . Table 1: Tracing Levels and Descriptions Trace Management Tracing Levels Tracing Level Description Fatal The message stating the process is aborted. Emergency The message is regarding an issue that makes the system unusable. Alert The message indicating that an action must be taken immediately. Critical The message is regarding a critical event causing loss of important functions. Error The message is regarding a system error.

Warning The message is regarding a system warning. Notice The message is regarding a significant event. Informational The message is useful for informational purposes only. Trace Management 2

Стр. 2

Payload Filter

Payload Filter This feature is used to filter trace messages. Trace messages contain actual debug information such as text strings, special characters, and variable arguments (strings), integers, long, IPv4/IPv6/MAC addresses, and so on. Using the payload feature, the trace messages can be filtered based on the selected criteria and without string operations. You can use the following set and show commands to configure a payload filter and to view the applied filters. Table 2: Set Commands for Payload Filter Table 3: Show Commands for Payload Filter Trace Management Payload Filter Tracing Level Description Debug The message provides debug-level output.

Verbose All possible trace messages are sent. Noise All possible trace messages for the module are logged. The noise level is always equal to the highest possible tracing level. Even if a future enhancement to tracing introduces a higher tracing level, the noise level will become equal to the level of that new enhancement. set platform software btrace-manager ... utm-pf enable Enables and disables the payload filtering feature. set platform software btrace-manager ... utm-pf disable set platform software btrace-manager ... consumer-name create Creates and deletes consumer/stream. set platform software btrace-manager ... consumer-name delete set platform software btrace-manager ...

consumer-name filter add Applies and removes filter on stream/consumer set platform software btrace-manager ... consumer-name filter remove #show platform software btrace-manager ... utm-pf Shows the current status of the payload feature and other additional details show platform software btrace-manager ... utm-pf consumer-name all-filters Shows all filters currently applied on consumer/stream. Trace Management 3

Стр. 3

Configuring Conditional Debugging

How to Configure Conditional Debugging Conditional Debugging and Radioactive Tracing Radioactive Tracing when coupled with Conditional Debugging, prpvides a single debug command to debug all execution contexts related to the condition. You can execute this command without being aware of the various control flow processes of the feature within the box and without having to issue debugs at these processes individually. Configuring Conditional Debugging Follow the steps to configure conditional debugging: Procedure Trace Management How to Configure Conditional Debugging show platform software btrace-manager ...

utm-pf consumer-name all-luids Shows all or selected LUID of consumer for the applied filter. show platform software btrace-manager ... utm-pf consumer-name filter show platform software btrace-manager ... utm-pf message Shows consumer/stream messages. Command or Action Purpose Step 1 enable Example: Device> enable Enables privileged EXEC mode. • Enter your password if prompted. Step 2 debug platform condition mac {mac-address} Example: Device# debug platform condition mac bc16.6509.3314 Configures conditional debugging for the MAC Address specified. Step 3 debug platform condition start Example:

Device# debug platform condition start Starts conditional debugging (this step starts radioactive tracing if there's a match on one of the preceding conditions). Step 4 show platform condition OR show debug Example: Device# show platform condition Device# show debug Displays the current conditions set. Trace Management 4

Стр. 4