Reset Search



How to enable additional debug logs in EXOS

« Go Back


TitleHow to enable additional debug logs in EXOS
This article focuses on configuring EXOS to display additional debug logs specific to a process. 
Summit and Blackdiamond series
1. Understanding what events are already added to the default filter. (memory buffer that displays logs in the "show log" command)

By default, any events that have the severity of Info through the Critical are displayed in the logs. You can find the details about severity in the link below: 
How do EXOS log severities map to the numerical severity in syslog messages?

We can identify if the particular event is added to be displayed or not with the help of the following command: 

show log counters <event name> 

For example: 
BD-X8.9 # sh log counters epm occurred
Component   SubComponent Condition               Severity      Occurred I Ntfd
----------- ------------ ----------------------- ------------- -------- - ----
EPM                      next                    Debug-Summary       59 N    0
EPM                      next_start              Debug-Summary       59 N    0
EPM                      start                   Notice               1 Y    1
EPM                      state                   Debug-Summary     1712 N    0

In the above output, the flag "Y" under the column "I" indicates that the particular event is added.
The flag "N" indicates that the particular event is not added.
However, when the event happens in the switch, the occurred values would increase irrespective of whether an event is added to be notified in the logs or not. 

2. For debugging a particular process related issue, we may need more debug logs than normal. Once the process is identified, we can execute the following commands to add the event that we are interested in, to be displayed in the logs. To determine which events we want to add it is usefull to check with show log counters <component> which events are triggered and which not. Adding logging for an event that is never triggered (Occurred stays at 0) will not reveal any additional logging.
You can add a group or 1 event to the log filter (in all examples this is added to the defaultfilter but if you use a different log filter use that name).

The example below would help to see if the switch is receiving OSPF hellos from the neighbor or not. 

Verify if the event is already added: 

BD-X8.14 # sh log counters ospf.hello
Component   SubComponent Condition               Severity      Occurred I Ntfd
----------- ------------ ----------------------- ------------- -------- - ----
ospf        hello        PktInv                  Warning              0 N    0
ospf        hello        PktRx                   Info                 0 N    0

The event OSPF.hello.PktRx has the "N" flag to it.

Add the event to the filter: 

configure log filter defaultfilter add events ospf.hello.pktrx 

* BD-X8.19 # sh log counters ospf.hello
Component   SubComponent Condition               Severity      Occurred I Ntfd
----------- ------------ ----------------------- ------------- -------- - ----
ospf        hello        PktInv                  Warning              0 N    0
ospf        hello        PktRx                   Info                 0 Y    0

If the event to be added has the severity of debug-summary/debug-verbose/debug--data, we need to add the following command after adding the event to the defaultfilter. 
enable log debug-mode

3.After you finished you can enter disable log debug-mode to disable the debug mode for logging, be aware the logging is still added. You can remove each added event or you can just reset the log filter to default using the unconfigure syntax.
  • configure log filter Defaultfilter delete events <events>
  • unconfigure log filter Defaultfilter 

Additional notes
While adding the logs that have the severity of debug-data,debug-verbose or debug-data, please ensure to take the advice from the GTAC. Because, the debug logs could be happening every millisecond and hence can cause high CPU as the logs are being printed.
BD-X8.20 # enable log debug-mode
WARNING: Debug mode should only be enabled when advised by technical support,
or when advanced diagnosis is required.  Performance degradation is possible.
Debug mode now enabled.

Debug guide for EXOS



Was this article helpful?



Please tell us how we can make this article more useful.

Characters Remaining: 255