Pandora: Documentation en: Dashboard

Go back to Pandora FMS documentation index

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

Dashboards are customized, each user configures his or her own Dashboards and can only see those that he or she has configured.

To create a Dashboard, we click on Reporting -> Main Dashboard, all users have a dashboard named "default".

Click on the "add" button.

In the prompt that appears, the name is placed and the group this dashboard will be visible for is assigned. After we click on 'Add'

Since a new tab has been added, we should know have two tabs, the default tab and the new one. The next step is to add items. For this we press "Add Widget"

A new window appears where all items that can be added are shown.

1.2.1 Adding items to the Dashboard

A series of different items can be added, each with its own characteristics.

1.2.1.1 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.2 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.

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.3 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.4 System status

To add a report with Pandora FMS monitors status, we click on the following icon:

When clicking on the icon we get the item with the system status.

1.2.1.5 Pandora FMS welcome message

To add a welcome message on Pandora FMS we click the following icon:

When clicking on the icon the item with the welcome message appears.

1.2.1.6 Agent module graph

To add a graph for an agent module on Pandora FMS, we click on the following icon:

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

On the configuration window we must configure the following parameters:

• Title: title that'll appear above the graph
• Group: combo where the agent's group is assigned.
• Agent: combo where the agent is chosen
• Module: combo where the module is chosen
• Period: combo where the period of time for the graph is set.

We click on the "Update" button, and should get a window like the following:

1.2.1.7 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.8 The Network Map

In order to add a Pandora FMS Network Map, please click on the icon shown below.

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

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

• Title: título que aparecerá encima del mapa.
• Map: combo where select a network map
• X offset: Amount that moves along the y axis, negative amounts are accepted.
• Y offset: Amount that moves along the y axis, negative amounts are accepted.
• Zoom level: Level of focus on the network map.

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

1.2.1.9 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.10 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.11 The Tactical View

In order to add a tactical view of Pandora FMS, please click on the icon shown 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.
• Status and Monitor Checks: It provides general information on the modules.
• Server Performance: It provides a summary of server statistics.
• Summary:: It provides summary information about agents and modules.

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

1.2.1.12 Panel with a Message

In order to add a panel which contains a message under Pandora FMS, please click on the icon shown below.

If you click on the icon above, 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.
• Text: A free-text field containing the message itself.

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

1.2.1.13 User-Defined Reports

In order to add user defined reports under Pandora FMS, please click on the icon shown below.

If you click on the icon above, 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 report's top.
• Report: The field for the report's name which is going to contain the widget.

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

1.2.1.14 Top Number of events per agent groups

To show the graph for top events for agents, we'll use the following widget.

The setting options that it presents are:

• Title: title the widget will be given.
• Amount to show: amount of agents.
• Max. hours old: time during which existing events shown will be taken into account.
• Groups: defines which agent groups we wish to include.
• Legend position: graph key position.

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

1.2.1.15 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.16 Top N modules

To show the graph for top modules, we'll use the following widget.

The settings options it shows are:

• Title: title the widget will be given.
• Period: period of data that will be used to show the widget's information.
• Quantity (n): amount of modules that will be shown.
• Order: way in which elements are organized.
• Display: which is going to be the top module. Minimum, maximum or average values.
• Items: in order to add modules we want the widget to use. Can be added individually or massively.

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

1.2.1.17 Showing a service map

To show a service map we'll use the following widget.

The settings options it shows are:

• Title: title the widget will be given
• Background Image: background color must be set in CSS value.
• Service: service to show. Must be created in the service section previously.
• Key: if we want it to show an explanatory key for graphs.

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

1.2.1.18 Triggered alert reports

To show a report on triggered alerts, we'll 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.19 Show tree graph view

To show the tree graph view we'll 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 we want it so. 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 tre 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.20 Show icon and value of module

To show the icon and value of module view we'll 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.21 Show module value

To show the module value view we'll 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.
• 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.

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

1.2.1.22 Mostrar el estado del módulo

Para mostrar el valor del módulo usaremos el siguiente 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: Módulo que se utilizará para obtener el estado para la imagen.
• Icon: Icono que se mostrará en el widget y que cambiará según el estado del módulo.
• Text size of label in px:Tamaño en pixeles para el tamaño de la etiqueta, si no se indica nada será lo especificado en PandoraFMS.
• Size icon: Tamaño del icono, si no se indica nada será el tamaño del icono.

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

1.2.1.23 Mostrar el valor del módulo en formato tabla

Para mostrar el valor del módulo usaremos el siguiente widget.

The settings options it shows are:

• Title: title the widget will be given.
• Background image: CSS color code for the background.
• Agent: autocomplete where the agent is chosen.
• Module: Módulo que se utilizará para obtener el dato a mostrar.
• Text size of value in px:Tamaño en pixeles para el tamaño del valor, si no se indica nada será lo especificado en PandoraFMS.
• Separator of data: Separador que se utilizará para generar las diferentes lineas. Las opciones posibles son: Retorno de carro, barra vertical, punto y coma, dos puntos, coma, espacio en blanco.

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

1.2.1.24 Mostrar la gráfica del histórico de estados de un módulo

Para mostrar una gráfica del histórico de estados del módulo usaremos el siguiente widget.

The settings options it shows are:

• Title: title the widget will be given.
• Background image: CSS color code for the background.
• Agent: autocomplete where the agent is chosen.
• Module: Módulo sobre el que se obtendrá los datos para el histórico.
• Periodicity: Periodo sobre el que se realizará la grafica del historico de estado del módulo seleccionado. El valor a seleccionar está comprendido entre 1h y 48h.
• Text size of value in px:Tamaño en pixeles para el tamaño del valoe, si no se indica nada será lo especificado en PandoraFMS.

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

1.2.1.25 Mostrar un listado de Agentes/Módulos

Para mostrar un listado de agentes seleccionados y los módulos usaremos el siguiente widget.

Por defecto carga los módulos en común de los agentes existentes, si hay alguno coincidente entonces saldrán datos. Existe también la posibilidad de configurarlo, estás son las opciones:

• Title: title the widget will be given.
• Background image: CSS color code for the background.
• Group: grupo para filtrar el listado de agentes.
• Agent: list of agents.
• Show common modules: Hay dos opciones, mostrar los módulos comunes a los agentes seleccionados o mostrar todos los módulos de los agentes seleccionados. Por defecto 'Show common modules'.
• Modules: Lista de módulos generada a partir de lo seleccionado en agentes y mostrar los módulos en común.

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

1.2.1.26 Mostrar el porcentaje SLA de un módulo

Para mostrar un listado de agentes seleccionados y los módulos usaremos el siguiente 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: Módulo sobre el que se obtendrá los datos para el histórico.
• Periodicity: Periodo sobre el que se realizará la grafica del historico de estado del módulo seleccionado. El valor a seleccionar está comprendido entre 1h y 48h.
• Text size of value in px:Tamaño en pixeles para el tamaño del valor, si no se indica nada será lo especificado en PandoraFMS.
• Text size of label in px:Tamaño en pixeles para el tamaño de la etiqueta, si no se indica nada será lo especificado en PandoraFMS.

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

1.2.2 Placing items on the dashboard

When clicking on the items from the Dashboard it's possible to move them around and place them wherever the user wants.

1.2.3 Editing objects on the dashboard

To edit configuration parameters for a Dashboard item we press on the configuration icon that can be found on the top right corner of the item we wish to edit.

Once we've clicked on the icon the settings menu will appear. It can be modified and click on "update" to save the changes.

1.2.4 Deleting objects on the Dashboard

To delete the configured parameters for an item on the dashboard we click on the trashcan icon that's on the top right part of the item we wish to delete.

1.3 Editing a Dashboard

You may edit the dashboard's name and group. In order to update an already existing dashboard, please click on the 'Dashboard Options' and 'Update Dashboard' options.

Please click on the 'Update Dashboard' option as shown above.

1.4 Deleting a Dashboard

In order to delete a dashboard, please click on the triangle-shaped icon, which is located on the tab you intend to delete. It's also going to display the 'Update Dashboard' and 'Delete Dashboard' options.

Please click on the 'Delete Dashboard' option.

Go back to Pandora FMS Documentation Index