Support logs

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.

The log file is configured to have a maximum size of 10 MB 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 10 MB, the controller copies the log to storage and starts a new log.

  • When the log file has rolled over four times, the controller purges the oldest log file when it needs to roll over again. The core controller has at most 5 log files.

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

  • Support logs can be exported to a file.

In a controller team environment:

  • Each controller maintains its own support logs.

  • Changing the support 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.

See also:

Support logs screen details

Selecting the Support Logs screen

Support Logs screen example
Screen component Description
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.

The logging levels are hierarchical. Messages are logged with the lowest logging level and above. The lowest level is TRACE, which results in all messages being logged for the selected logger when the TRACE logging level is specified. INFO is the logging level In the default configuration.

Severity levels are:

Value Description
ERROR

Indicates a problem to investigate. The problem could cause functional or performance issues with application.

WARN

Indicates a problem that you might want to investigate. The problem could be an early indication of issues that could later cause an error.

INFO

Indicates a normal operational event that requires no action.

DEBUG

Indicates an informational event that is most useful for debugging applications.

TRACE

Indicates an informational event that is most useful for debugging applications. Often used to show program execution details when DEBUG-level events do not provide enough information

Using the Virgo Administrator console, you can dynamically change the logging level for a component that is writing to the support log. For example, you can enable the DEBUG level logging for just the NodeManager configuration component.

You can also dynamically change the logging level by using the REST API. See HPE VAN SDN Controller REST API Reference

Logger

The module or feature that triggered the logging condition.

Thread

The thread that caused the logging condition to occur.

Message

Describes the details of the logging condition.

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 com.hp.sdn.adm.log.impl.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 is displayed.

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

  4. Click Apply.

The LogManager Configuration Component Controls Support Log queue size

Configurations screen with LogManager component keys

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.

  3. 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
  4. 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: ]

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