1 The Dashboard

1.1 Introduction

The Dashboard is a feature of the Enterprise Version of Pandora FMS. It was designed to allow the users to build their own monitoring pages. It's possible to add more than a page, because you're also able to add monitoring maps, graphs, etc.

The dashboard's configuration is carried out from the same place in which it's possible to gain access to it. Please click on 'Reporting' and 'Dashboard' on the web console's right side to gain access to it.

If you click on the dashboard, the user configured pages are going to be displayed.

1.2 Creating a Dashboard

To create a Dashboard, press "New dashboard" the button of the menu Reporting -> Main Dashboard.

A dashboard will be created with a sample object. To customize it, adding widgets and specifying which users will be able to modify it, you must click on the Options button in the upper right menu:

In the popup dialog you must assign a name to the dashboard, select the number of cells (widgets) it will contain, and indicate if it will be of private type (only the user who created it and the Pandora FMS administrator will be able to see it) or visible for a group. Also, you have the option to show each widget as a slide in full screen.

Apply the changes with the "Save" button (note that if you want to change the number of cells, you must click on "Update"). Once the changes have been applied, we will have to save the dashboard in order to start adding objects to it. The next step is to add objects to the dashboard, clicking on "Add Widget". This option will only appear in empty cells:

A new window will appear containing all the object types that can be added. You can navigate between the different pages with the buttons at the top left.

1.2.1 Adding items to the Dashboard

Several different widgets (objects) can be added to each dashboard, each one occupying a cell. Each widget has its own characteristics and configurations, so below we will detail their use and the options available for each one.

1.2.1.1 Display an Agents/Modules list

To show a list of selected agents and modules use the following widget.

Modules in common with agents are loaded by default. If any coincide the data will be displayed. They can also be configured using these options:

When saving the configuration, the widget should look something like the one shown below.

1.2.1.2 Triggered alert reports

To show a report on triggered alerts, use the following widget.

The settings options it shows are:

Title: title the widget will be given.

Background image: color code in CSS.

Groups: group from which we want to obtain the alert report.

When saving the configuration, the widget will look something like this.

1.2.1.3 Clock

This widget displays a clock with the time set in the console. To add this widget, you must click on the following icon:

The following configuration window will appear.

In it you must indicate the name to display for the object and the type of clock you want. Optionally, you can choose a specific background color for the widget, setting its CSS code.

1.2.1.4 User defined graphs

To add a user defined graph, we click on the following icon:

When clicking on the icon, we get the item configuration window.

On the configuration window we must configure the following parameters:

Title: title that'll appear above the graph.

Graph: combo from which the graph that'll appear can be chosen. Choices are from graphs created on Pandora FMS.

Period: combo where the graphs period is established.

Pile-Up: the type of graph that the data will be shown on is chosen.

Graph Colours: we can define the color for the maximum, minimum and average of the graph. If the checkbox Show full legend is not marked, only the average will appear on the chart, and therefore, only that color will be used.

The "update" button is pressed and a window like the following should appear:

In the pile up section we have a series of options:

They're the different graphic modes that we can show data with. For example:

Gauge Mode:

In this type of graph the maximum and minimum for each timer will be defined by the minimum and maximum value defined within each module. If otherwise, the maximum or minimum value our module has taken throughout its runtime will be the one shown. "Warning" or "critical" values are shown as orange and red stripes accordingly.

Piled up area:

1.2.1.5 List of latest events

To add a list with the latest events occurred on Pandora FMS we must click on the following icon:

When clicking on the icon the item configuration window appears.

On the configuration window the following parameters must be configured:

Title: title that'll appear above the graph

Event Type: combo where you can choose amongst the different types of events available (Critical, Warning...).

Max. hours old: limit of hours to extract events.

Limit: combo where the maximum number of events that'll appear can be defined.

Event Status: combo where the status for each event can be chosen: validated, unvalidated, all.

Groups: groups that will be shown in events are selected.

Tags: tags that will be shown in events are selected.

We click on the "update" button and a window like the following should appear:

If we click on the agent name the agent configuration window is accessed.

1.2.1.6 Display module status history graph

To display a graph of historic module status use the following widget.

The settings options are:

Title: title the widget will be given.

Background image: CSS color code for the background.

Agent: autocomplete where the agent is chosen.

Module: Module that provides the historical data.

Periodicity: Period that the graph covers. Value between 1h - 48h.

Text size of value in px: Pixel size for the value size. If not indicated Pandora FMS will indicate it.

When saving the configuration, the widget should look something like the one shown below.

1.2.1.7 Top N events per modules

To show the graph for top events per modules, based on the group, we'll use the following widget.

The configuration options it presents are:

Title: title the widget will be given.

Amount to show: amount of event types.

Max. hours old: time during which the existing events to show will be taken into account.

Groups: which groups we wish to include.

Legend position: graph key position.

When saving the configuration the widget should look something like the one below.

1.2.1.8 Group Status Report

To add a report with Pandora FMS group status, we click on the following icon.

When clicking on the icon, the item's configuration window will appear.

The title is then placed, the groups that have to appear are marked on the report, and we press the "update" button and a window like the following should appear:

clicking the group names we can access the corresponding group in the operations menu

1.2.1.9 Show tree graph view

To show the tree graph view use the following widget.

This widget will show the default tree graph view without the need to modify configuration options. Nevertheless there are some things that can be modified if you want. The settings options are:

Title: title the widget will be given.

Background image: CSS color code for the background.

Tab: tab that shows the tree graph we wish to see.

Group: filters by group.

Open all nodes: if is marked, see tree view with all nodes opened.

Agents status: filter by agent status.

Filter Agents: filter by agent name.

Modules status: filters by module status.

filter modules: filters modules by name.

When saving the configuration, the widget should look something like the one shown below.

1.2.1.10 The Visual Console's Map

This option is supported in computer screens only

Please click on the icon shown below in order to add a map from the Pandora FMS Visual Console.

If you click on the icon above, the object's configuration window is going to appear.

Please insert an appropriate title and select the map which is supposed to appear within the object from a combo.

If you click on the 'Update' button, a window like the one shown below is going to appear.

Before you're able to put them to any use, all maps are required to be created by clicking on 'Administration' -> 'Reporting' and 'Visual Console'.

1.2.1.11 The Visual Maps Report

In order to add a report containing Pandora FMS visual maps, please click on the following icon:

If you click on the icon, the object's configuration window is going to appear as shown below.

Please insert the title, select the appropriate visual console's maps, supposed to be contained in the report and click on 'Update'. If you do, a window like the one shown below is going to appear.

If you click on the map's name, you're accessing the map within the visual console.

1.2.1.12 Show icon and value of module

To show the icon and value of module view use the following widget.

The settings options it shows are:

Title: title the widget will be given.

Background image: CSS color code for the background.

Label: text label to show in widget.

Agent: autocomplete where the agent is chosen

Module: Module with used to show data.

Icon: select with icon to select.

Text size of value in px: Size in pixels of text value, default size of config in PandoraFMS.

Text size of label in px: Size in pixels of label text, default size of config in PandoraFMS.

Size icon: Size of icon, default size of icon.

When saving the configuration, the widget should look something like the one shown below.

1.2.1.13 Display module status

To display the module value use the following widget.

The settings options it shows are:

Title: title the widget will be given.

Background image: CSS color code for the background.

Label: text label to show in widget.

Agent: autocomplete where the agent is chosen.

Module: Module used to obtain status for the image.

Icon: Icon shown in the widget that reflects changes in module status.

Text size of label in px: Pixel size for the label size. If no size is displayed PandoraFMS will specify it.

Size icon: Icon size.

When saving the configuration, the widget should look something like the one shown below.

1.2.1.14 Displaying URL Content

In order to display URL content under Pandora FMS, please click on the icon which is shown on the picture below.

If you click on the icon, the object's configuration window is going to appear.

Within the configuration window, you have the following configurable parameters at your disposal:

Title: The option to determine the title which is going to appear on the widget's top.

URL: The combo in which you're able to select the font's size to for the agent's names.

Height: The height of the widget in pixels. Please insert '0' for an automatic determination.

If you click on the 'Update' button, a window like the one shown below is going to appear.

1.2.1.15 Show the module value as a chart

To show the module value use the following widget.

The settings options it shows are:

Title: title the widget will be given.

Background image: CSS color code for the background.

Agent: autocomplete when the agent is chosen.

Module: Module used to obtain the data to be shown.

Text size of value in px: Pixel size for the size value. If no value is indicated Pandora FMS will specify it.