Support logs screen

About support logs

The support logs maintain an internal record of events of interest from the operations of an active SDN controller. This information is the type of data a support engineer would request when troubleshooting an SDN installation.

Support logs and controller teams 

In a controller team environment:

  • Each controller maintains its own support logs.

  • Changing the log.queue.size on any controller propagates to all active controllers in the team.

  • The Export action gathers the set of support log file data from all active controllers in the team, and stores the data as a single compressed archive.

Multiple support logs 

The log file is configured to have a maximum size of 10MB and to keep 4 previous versions). With 4 full previous versions and the one active log, the core controller logging will consume at most 50 MB of disk space. The controller allows up to five support logs; one active and four in storage:

  • When the current log reaches 10MB, the controller copies the log to storage and starts a new log.

  • When the space allocated for all support logs is full, the controller purges the oldest log file to make room for continued logging operation.

  • Support logs are stored in the controller /var/log/sdn/virgo/logs directory.

  • Support logs can be exported to a file (see “Exporting the support logs ”)

Support logs screen details

Screen componentDescription
Refresh

Displays a listing of the most recent log messages, as determined by the currently configured queue size. For example, with a queue size of 100, Refresh lists the 100 most recent log messages.

Export

Gathers the set of support log file data from the standalone controller or all active controllers in the team, and stores the data as a single compressed archive.

Level

The severity level for the entry. Levels are:

ValueDescription
ERRORRecorded in support logs
WARN 
INFO 
DEBUG 
TRACE 

In the default configuration, the ERROR, WARN, and INFO levels are recorded in the Support Logs. DEBUG and TRACE are verbose logging that are used in troubleshooting situations that might involve support engineering.

The logging level for a component that is writing to the support log can be dynamically changed using the Virgo Administrator console. For example, DEBUG level logging can be enabled for just the NodeManager configuration component.

Logger 
Thread 
Message 
Data

Detailed information about the log entry.

Controller ID

A hexadecimal number that identifies controller that generated the log entry. When you use controller teaming, this ID enables you to identify which controller in the team generated the alert.

Configuring the support log queue size

The default queue size is 100 lines. To configure a different queue size, change the value for the max.display.rows key of the LogManager component.

  1. From the Configurations screen, under Component, select the com.hp.sdn.adm.log.impl.LogManager component.

  2. Click Modify.

    The Modify Configuration dialog box appears.

  3. Change the value for the max.display.rows key.

  4. Click Apply.

Exporting the support logs

The Export operation:

  1. Gathers the set of support log file data from the controller, or in a team environment, all active controllers in the team, and stores the data as a single compressed archive file:

    sdn-all-logs.zip

  2. Downloads the archive file from the controller to the default download directory specified by your browser. For example, in Ubuntu installations, this is usually the Downloads directory.

  1. Click Export.

    The following menu appears in the lower-left corner of the controller console:

    Completion of the export operation

    Completion of the export operation

  2. When the download completes, you can either resume interaction with the controller or examine the log by selecting an item from the menu, such as:

    • Open a window showing the new log zip file.

    • Set the default operation to always open the directory containing the log zip file.

    • Show the log zip file in the default directory for receiving downloads.


    NOTE: The actions resulting from these choices depend on the browser and operating system, not on the controller.