Pandora: Documentation en: Dashboard

From Pandora FMS Wiki
Jump to: navigation, search

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.

Dashboard1.png

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

Dash1.JPG

1.2 Creating a Dashboard

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



Dash2.JPG



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:

Dash-options.png



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.

Dash-options2.png



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:



Dashboard5.png



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.



Dash-widgets.png




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.

Agent module.png

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:

Config agent module.png

  • Title: title the widget will be given.
  • Background image: CSS color code for the background.
  • Group: to filter the list of agents.
  • 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.

View agent module.png


1.2.1.2 Triggered alert reports

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

Alerts fired.png

The settings options it shows are:

Config alerts.png

  • 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.

View alerts.png

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:



Icono reloj.png



The following configuration window will appear.



Config reloj.png



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.



Analogic reloj.png





Digital reloj.png



1.2.1.4 User defined graphs

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

Dashboard11.png

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

Single graph01.png

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:

View custom graph.png

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

Config custom graph2.png

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

Gauge Mode:

View gauges.png

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:

View stacked graph.png

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:

Dashboard15.png

When clicking on the icon the item configuration window appears.

Config event list.png

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:

View event list.png

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.

Graph module histogram.png

The settings options are:

Config grapg module.png

  • 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.

View graph module.png

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.

Top n events by module.png

The configuration options it presents are:

Config topn modules.png

  • 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.

View topn modules.png

1.2.1.8 Group Status Report

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

Dashboard8.png

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

Config groups stats.png

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:

Group stats widget.png

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.

Tree view.png

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:

Config tree.png

  • 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.

View tree.png

1.2.1.10 The Visual Console's Map

Template warning.png

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.

Dashboard31.png

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

Dashboard32.png

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.

Dashboard33.png

Template warning.png

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:

Dashboard25.png

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

Dashboard26.png

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.

Dashboard27.png

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.

Module icon.png

The settings options it shows are:

Config module icon.png

  • 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.

View module icon.png

1.2.1.13 Display module status

To display the module value use the following widget.

Module status.png

The settings options it shows are:

Config module status.png

  • 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.

View module status.png

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.

Dashboard 41.png

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

Dashboard 42.png

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.

Dashboard 43.png

1.2.1.15 Show the module value as a chart

To show the module value use the following widget.

Module table value.png

The settings options it shows are:

Config module table.png

  • 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.
  • Separator of data: Separator to generate different lines. Possible options are: carriage return, vertical bar, semi-colon, colon, comma, space.

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

View module table.png

1.2.1.16 Show module value

To show the module value view use the following widget.

Module value.png

The settings options it shows are:

Config module value.png

  • 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.

View module value.png

1.2.1.17 System status

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

Dashboard18.png

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

Dashboard19.png

1.2.1.18 The Network Map

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

Dashboard28.png

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

Dashboard29.png

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.

Dashboard30.png

1.2.1.19 Panel with a Message

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

Dashboard 47.png

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

Dashboard 48.png

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.

Dashboard 49.png

1.2.1.20 User-Defined Reports

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

Dashboard 50.png

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

Dashboard 51.png

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.

Dashboard 52.png

1.2.1.21 Showing a service map

To show a service map use the following widget.

Service map.png

The settings options it shows are:

Config service.png

  • 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.

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

View service.png

1.2.1.22 Agent module graph

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

Dashboard22.png

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

Config custom graph3.png

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.
  • Color: for each agent/module, a color can be selected for the graphic. If the graphic type is Gauge, bullet graph, horizontal bars or pie chart, colors cannot be selected.

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

Dashboard24.png

1.2.1.23 Show SLA percentage of a module

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

Sla percent.png

The settings options it shows are:

Config sla.png

  • 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 on which the data for the history will be obtained.
  • Periodicity: Period on which the graph of the status history of the selected module will be made. The value to be selected is between 1h and 48h.
  • Text size of value in px:Size in pixels for the size of the value, if nothing is indicated it will be specified in PandoraFMS.
  • Text size of label in px:Size in pixels for the size of the label, if nothing is indicated it will be what is specified in PandoraFMS.

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

View sla.png


1.2.1.24 System Group Status

This widget shows a table with the status of the groups we have selected:



Icono group status.png



A configuration window will appear.



Config group status.png



The following parameters must be configured in the configuration window:

  • 'Title’: The display name of the object.
  • Background image'’': specific background color for the widget, setting its CSS code.
  • Groups: groups that we want to show in the widget.

Press the "update" button, and a window like the following appears:



Imagen group status.png



1.2.1.25 The Tactical View

In order to add a tactical view of Pandora FMS, please click on the icon shown below.

Dashboard 44.png

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

Dashboard 45.png

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.

Dashboard 46.png

1.2.1.26 Top Number of events per agent groups

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

Top n events by group.png

The setting options that it presents are:

Config topn agents.png

  • 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:

View topn agents.png

1.2.1.27 Top N modules

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

Top n.png

The settings options it shows are:

Config topn agents modules.png

  • 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.

View topn agents modules.png

1.2.1.28 Show agent WUX transaction

This widget shows a selected wux transaction:



Icono wux trans.png



A configuration window will appear.



Config wux trans.png



The following parameters must be configured in the configuration window:

  • 'Title’: The display name of the object.
  • Background image'’': specific background color for the widget, setting its CSS code.
  • Agent’’’:choose the agent that has the wux monitoring to show.
  • WUX Transaction’’’: choose the wux module to show.

Press the "update" button, and a window like the following appears:



Imagen wux trans.png




1.2.1.29 Show agent WUX transaction statistics

This widget shows the stats of a selected wux transaction:



Icono wux stat.png



A configuration window will appear.



Config wux stat.png



The following parameters must be configured in the configuration window:

  • 'Title’: The display name of the object.
  • Background image'’': specific background color for the widget, setting its CSS code.
  • View all statistics: option to show all the stats of the chosen wux transaction.
  • Agent’’’:choose the agent that has the wux monitoring to show.
  • WUX Transaction’’’: choose the wux module to show.

Press the "update" button, and a window like the following appears:





Imagen wux stat.png



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.

Dashboard343.png

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.

Dashboard352.png

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.



Dash-options2.png



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

1.4 Deleting a Dashboard

In order to delete a dashboard, go to the list of created dashboards and delete the one you want.



Dash61.JPG



1.5 Slides mode

To activate the slideshow mode, or presentation, simply access this mode in the top right menu, from the dashboard section, and select the dashboards you want to show in the presentation.



Dash4.JPG



The console will switch to slide mode, from where we can control, among other things, the rotation frequency.



Dash5.JPG



1.6 Full screen mode

To access the full screen mode, click on the icon below.



Dash25.JPG



This simple and intuitive screen and controls resemble those of the slide mode. It allows us to set a refresh rate and switch to slide mode.




Dash26.JPG




Go back to Pandora FMS Documentation Index