Logs and statistics

You can view logs and statistics for the appliance and Minion software using the Appliance Service. You can also download appliance logs.

View status for all appliances

The Appliances area includes seven donut charts to display the overall status of all activated appliances. The largest circle on a donut chart displays the total number of activated appliances. Each of the smaller circles represents a status and the number of appliances in that state.

  • Up: Appliance is connected to the Appliance Service, the Minion is up, and it can communicate with OpenNMS.

  • Down: Appliance is connected to the Appliance Service and either the Minion is up and cannot connect to OpenNMS or the Minion is down.

  • Unknown: Appliance is connected to the Appliance Service, but cannot determine Minion or OpenNMS connectivity.

  • Initializing: Appliance is connected to the Appliance Service, but the Minion is in a transient state (grace period) as it restarts.

  • Offline: Appliance is not connected to the Appliance Service.

  • Ready: Appliance is connected to the Appliance Service, but no Minion is defined.

States are determined by a combination of indicators: connectivity to the Appliance Service (CLOUD), status of Minion (Minion), and connectivity with OpenNMS (ONMS). See global status mapping for a high-level summary.

Click on a donut chart to filter and search appliances. When you click on a donut, the appliance list filters to display only appliances that are in the corresponding state (for example, if you click on the Offline donut, only appliances that are offline appear in the list). You can further filter the results by typing text in the search field; only appliances that match the search text appear in the list.

View Minion Appliance events

Events include appliance activities such as "failed to start," "started for the first time," and upgraded.

  1. Navigate to Appliances.

  2. Click the vertical ellipsis (⋮) beside an appliance to view the drop-down menu and choose Appliance Events.

The UI displays a list of recent appliance activity in reverse chronological order.

View appliance logs

To display appliance logs, including errors and warnings, follow these steps:

  1. Navigate to Appliances.

  2. Click the vertical ellipsis (⋮) beside an appliance to view the drop-down menu and choose Appliance Logs.

  3. Click the play button to view logs.

  4. Click the pause button to pause appliance logging, and the play button to resume.

You can also view logs in the terminal user interface (TUI).

View appliance statistics

To view statistics related to the appliance’s CPU (usage and temperature) and memory (used, free, cached, or available) click the vertical ellipsis (⋮) beside an appliance to view the drop-down menu and choose Appliance Stats.

By default, graphs of all the available statistics appear, showing data from the last hour with a limit of 100 data points. Change the statistics type(s) displayed, date/time, or specify a value in the associated field to set a limit.

View Minion logs

Minion logs are those generated by the Minion, Karaf, and the Dominion process that interacts with the Appliance Service and creates the Minion.

The default configuration for Minion logs is a level of WARN (warning) and a maximum aggregation time of 30 seconds (30,000 milliseconds). You can add or edit Minion log configurations and assign them to appliance profiles.

To view Minion logs, follow these steps:

  1. Navigate to Appliances.

  2. Click the vertical ellipsis (⋮) beside an appliance to view the drop-down menu and choose Minion Logs.

  3. Click the play button to view logs.

  4. Click between the tabs to view logs.

  5. Click the pause button to stop the Minion logs, and the play button to resume.

Manage logger configuration

The default configuration for appliance and Minion logs is a level of WARN (warning) and a maximum aggregation time of 30 seconds (30,000 milliseconds).

To change default logger configuration, do the following:

Create a logger configuration

A logger configuration specifies the aggregation time and log levels for the Minion and Karaf logs.

Changing the Karaf logging level will respawn the Minion.

  1. Navigate to Appliances → Logger Configs and click Add New.

  2. Edit the appropriate fields and click Add New.

Download appliance diagnostic bundles

Diagnostic bundles (Dominion, Minion Karaf, Minion System) contain logs, images/running containers, heap dumps, and other information about the appliance across a user-defined time range. You can download these bundles as .tar.gz files for easier troubleshooting or to share with support to help diagnose issues.

Only Admin users can create diagnostic bundles and download them. The system stores bundles for 48 hours.

Note that you can generate diagnostic bundles only for appliances that are online.

  1. Navigate to Appliances.

  2. Click the vertical ellipsis (⋮) beside an appliance to view the drop-down menu and choose Diagnostic Bundle.

  3. Specify the type of bundle you want to generate or click Select All.

  4. Specify a time range (in UTC) for the logs and click Generate Diagnostic Bundle.

  5. Click Download beside the log bundle(s) to save locally.

    1. If bundle generation fails, click the Show Details button in the status column for more information.

src="https://polyfill.io/v3/polyfill.min.js?features=es6">