Enabling Debugs

This chapter describes how to use debug commands to monitor and troubleshoot the device configurations. The debug commands are accessible from the Privileged EXEC mode in the RUCKUS command line interface (CLI).

Many debug commands are specifically designed to be used in conjunction with calls to RUCKUS Technical Support. If you report a problem, the support engineer may ask you to execute one or more of the debug commands described in this guide.

Attention: Some debug commands report information about internal hardware settings and registers, which is relevant primarily to the RUCKUS engineering staff. These commands are not described in this document.

There are 2 ways to enable debugs:

  • Debug
  • Distributed Logger

The logs that are generated using debug and distributed logger utilities are sent to Log Manager. For more information refer to Log Manager .

Debug

The debug commands display information about the device operations, generated or received traffic, and any error messages. The output from the debug commands provides diagnostic information that include a variety of events relating to protocol status and network activity in general.

Distributed Logger

Distributed Logger (dlogger) is a simple debug log filtering facility for application debug logs. It provides a common infrastructure for each of the applications to filter logs at sub-module level and the corresponding sub-modules further with different severity levels. This filtering capability provided by the distributed logger helps to perform detailed debugging with complete control on enabling debug logs.

It has the capability to classify always-on logs and on-demand logs based on severity level. The always-on logs that is, logs with high severity (0-4), are logged into Log Manager by default. Manual configuration is required to log the low-severity logs.

There are certain modules that are supported in distributed logger but do not have the filtering capability. Their logs are directly logged only into the circular buffer and will not be logged in the Log Manager. These logs can be displayed using the show dlogger logs command. For more information on enabling distributed logger and viewing the debug logs, refer to Viewing logs for debugs enabled using distributed logger utility.

Disabling debug commands

When activated, most debug commands instruct the system to collect specific information about router configurations and activity. In all cases, adding no in front of the command disables the debug function.

In this section:

  1. Log Manager
    The Log Manager infrastructure provides the capability to store the application log files in a centralized repository. The centralized repository can be accessed for viewing the log files (to aid in taking appropriate troubleshooting actions). By default, all logs are enabled and the log files are categorized based on module, sub-module, and severity levels. Each entry in a log file has important information, including module, sub-module, severity level, unit number, and timestamp.
  2. Viewing logs for debugs enabled using debug utility
    The following example shows the configuration steps to generate and view debug logs using debug utility.
  3. Viewing logs for debugs enabled using distributed logger utility
    The following example shows the configuration steps to generate and view debug logs using distributed logger utility.
Parent topic: Using diagnostic commands