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

Enterprise version.
The Dashboard is a Pandora FMS Enterprise feature that allows users to build their own monitoring pages. It is possible to add more than one page and there you may add monitoring maps, graphs, status summaries, etc.
Dash1.JPG

The set up or see a dashboard, go to Reporting > Dashboard, located on Pandora FMS web console's right side.

Dashboard1.png

When entering this section, a list will appear with the dashboards that the user has permissions to access, as well as the option to create new ones.

Info.png

Pandora FMS simplifies monitoring management through user permissions. There are several permission systems that restrict what a user can see or manage, the most important is the concept of groups (either predefined groups by Pandora FMS and/or customized groups) combined with the profile of each user. Pay special attention to the notes about the All group (ALL) throughout the documentation.

 


1.1.1 Migration to the new dashboard system

From version 745 onwards, a new dashboard system comes into operation in Pandora FMS.

If there are already any dashboards created in your system there will be no need of performing any additional configurations, as the migration to the new system will be done automatically. However, you will need to relocate and resize the corresponding widgets.

Template warning.png

In some cases, the contents of some widgets cannot be migrated, so you must delete and create again the widgets.

 


1.2 Creating a Dashboard

To create a Dashboard, go to Reporting > Dashboard and click New dashboard.

Dash2.JPG

In the popup dialog, assign a name to the dashboard, which will have a single cell by default, and indicate whether it will be private (only the user who created it and the Pandora FMS administrator will be able to see it) or visible for a group.

Dash-options2.png

Only a group to which the user creating the dashboard belongs can be assigned, unless that user explicitly belongs to the ALL group.

If you checked the option Favourite when reloading the page, you will have in the menu a direct access to the recently created dashboard.

Topology maps-dashboard-favorites.png

To edit the Dashboard, click on the editing button located at the right of the icon line, then to add cells click on the circle icon with +.

Dashboard5.png

Click 'Add widget, and you will see a new window where all types of items that can be added are. You may browse through the different pages and see all available widgets by using the buttons at the left corner.

Dash-widgets.png

You may modify again the Dashboard (name, private, users, favorites): click on the icon next to the add cells button. You may also select other dashboards from the deploying list next to it and repeat the widget modifying and adding procedures.

Dash-options.png


1.2.1 Adding widgets 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, their use and the options available for each one are detailed below.

Info.png

Widgets have some common fields such as title, group, background color, etc.

 


1.2.1.1 Display a list of agents/modules

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

Agent module.png

Existing agent common modules are loaded by default. If any of them match, the data will be displayed. It may 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: Group to filter the agent list.
  • Agent: Agent list.
  • Show common modules: There are two options, showing the selected agent common modules or showing all selected agent modules. By default Show common modules.
  • Modules: Module list generated from what has been selected on agents and common modules.

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: Widget title.
  • Background image: Background color in CSS code.
  • Groups: Group from which the alert report is to be obtained.

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, click on the following icon:

Icono reloj.png

The following setup window will appear.

Config reloj.png

In Clock type, choose digital or analogical clock. The other options are those common to the previous widgets.

Analogic reloj.png
Digital reloj.png

1.2.1.4 User defined graphs

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

Custom graph.png

Item configuration window.

Config custom graph3.png
  • Graph: Combo where the graph that will appear can be chosen. Select it from the graphs created on Pandora FMS.
  • Periodicity: Combo where the graph period is established.
  • Stacked: The type of graph that the data will be shown on.

When clicking on update a window like the following should appear:

View custom graph.png

In the Stacked section you have a series of options:

Config custom graph2.png

They are the different graph modes for showing data. 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 values defined within each module. Otherwise, the maximum or minimum value the module took throughout its runtime will be the one shown. Warning or Critical values are shown as orange and red stripes accordingly.


Stacked area:

View stacked graph.png

1.2.1.5 List of latest events

To add a list with the latest events that took place in Pandora FMS, click on the following icon:

Events list.png

When clicking on the icon, the item configuration window appears.

Config event list.png
  • Event Type: Combo where you may choose amongst the different types of events available (Critical, Warning, etc.).
  • Max. hour old: Combo where the time interval to be used is defined (in hours).
  • Limit: Combo where the maximum number of events to be showed is set.
  • Event Status: Combo where the status for each event can be chosen: validated, unvalidated, all.
  • Groups: Groups that will be shown in events.
  • Tags: Tags that will be shown in events.

Click on update and a window like the following should appear:

View event list.png

Click on the agent name to access the agent configuration window.

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
  • Agent: Agent used to obtain the module list of the selected one.
  • Module: Module that provides the historical data.
  • Periodicity: Period covered by the module status history graph. Value between 1h and 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 through Update, 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, the following widget is used.

Top n events by module.png

The configuration options are:

Config topn modules.png
  • Amount to show: Amount of event types.
  • Max. hours old: Time (in hours) where the existing events to show will be taken into account.
  • Groups: Agent groups 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

This widget shoss the selected Pandora FMS group status, pointing out the total amount of agents and modules within that group as well as an organized counting by its state. To add this widget, click on the following icon:

Groups status.png

Configuration window:

Dash-groups.png

Once configurad as explained in previous sections, the resulting widget will be something similar to this:

Group stats widget.png

Once the widget is created, you may access the corresponding group by clicking on its name.

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. However, there are some things that can be modified if you wish. The settings options are:

Config tree.png
  • Type tree: Tree view grouped by tags, (policies), etc.
  • Groups: Desired group.
  • Open all nodes: If checked, the tree view will have all nodes opened.
  • Agents status: Filter by agent status.
  • Filter Agents: Filter by agent name.
  • Modules status: Filter by module status.
  • Filter modules: Filter modules by name.

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

View tree.png

1.2.1.10 The Visual Console's Map

Template warning.png

This version is supported in desktop screens only for now. Maps must be previously created in Topology maps > Visual console.

 


Click on the icon shown below in order to add a map from Pandora FMS visual console.

Dashboard31.png

Item configuration window:

Dashboard32.png

Choose a map, among those created, in the Visual console combo and click Ok. Wait a little. Adjust the size to the appropriate measures according to the screen size where the visual map will be displayed.

Dashboard33.png

1.2.1.11 Visual maps report

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

XTnRoDU6dW.png

Item configuration window:

HbeimKu7p6.png

Select a visual console in Maps. You may select several if you press CTRL while you click on each of the desired visual consoles. Click OK and the report with the selected data will be created:

ZgNtkh9asC.png

This list will show a green rectangle (OK) if everything in the console is in normal status, but if one of the modules is in any of the other possible states, it will be red (BAD).

If you click on the map's name, you will access the map within the visual console.

1.2.1.12 Show icon and module value

To show the icon and a module value, use the following widget.

Module icon.png

The settings options it shows are:

Config module icon.png
  • Label: Text label to be shown.
  • Agent: Agent used to abotain the module list of the selected one.
  • Module: Module used to obtain the data to be shown.
  • Icon: Icon displayed on the widget.
  • Text size of value in px and Text size of label in px: Size in pixels of text value and tag accordingly. If nothing is specified, Pandora FMS default one will be indicated.
  • Size icon: Icon size, default icon size if nothing is specified.

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

View module icon.png

1.2.1.13 Show module status

To display the module value, use the following widget represented by the following icon:

Module status.png

Setting options:

Config module status.png
  • Agent: Agent used to obtain the module list of the selected one.
  • 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, Pandora FMS 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 See URL content

In order to have the URL content displayed in Pandora FMS, click on the icon shown on the picture below.

Dashboard 41.png

Item configuration window:

Dashboard 42.png

Within the configuration window, the following parameters must be configured:

  • URL: The combo where agent web address of the website to be shown must be included. By clicking Ok and loading the page, it will show something like this:
Dashboard 43.png

Bear in mind that the website must match the size of the cell that hosts the widget or have responsive web design technology. Likewise, pay attention to the iFrame or boxes you have and in addition the possible links that use HTTP instead of HTTPS (encrypted content).

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 setting options it shows are:

Config module table.png
  • Agent: Agent chosen to obtain the module list of the selected one.
  • Module: Module used to obtain the data to be shown.
  • Text size of value in px: Pixel size for value size. If no value is indicated, Pandora FMS will specify it.
  • Data separator: 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.

Haga clic para ampliar

1.2.1.16 Show module value

To show the module value view use the following widget.

Module value.png

The setting options are:

Config module value.png
  • Agent: Agent used to obtain the module list of the selected one.
  • Module: Module used to obtain the data to be shown.
  • Text size of value in px and Text size of label in px: Size in pixels of text value and tag accordingly. If nothing is specified, Pandora FMS sets the default one.

When saving, 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, click on the following icon:

Monitor health.png

The item with all the information about the current system status is displayed automatically.

Dashboard19.png

1.2.1.18 Network Map

Template warning.png

This type of element is not compatible with another network map or with a services map in the same dashboard

 


In order to add a Pandora FMS network map, click on the icon:

Dashboard28.png

Item configuration window:

Dashboard29.png
  • Map: Combo where the network map is selected.
  • X offset and Y offset: Amount that moves along the X and Y axis, negative numbers are accepted.
  • Zoom level: Level of focus on the network map.

If you click Update, a window the one shown below will appear.

Dashboard30.png

1.2.1.19 Message panel

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

Dashboard 47.png

Item configuration window:

Dashboard 48.png
  • Text: A free-text field containing the message itself.

If you click Update, a window like the one below will appear.

Dashboard 49.png

1.2.1.20 Custom reports

In order to add custom reports in Pandora FMS, click on the icon shown below.

Dashboard 50.png

Item configuration window:

Dashboard 51.png
  • Report: Choose the report, which must be previously created and contains the widget.

Click Update:

Dashboard 52.png

1.2.1.21 Showing a service map

Template warning.png

This type of element is not compatible with another service map or with a network map in the same dashboard

 


To show a service map use the following widget.

Service map.png

Settings options:

Config service.png
  • Service: Service to be shows. It must have been previously created in the service section.
  • Legend: If you want a graph legend.

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 in Pandora FMS, click on the following icon:

Dashboard22.png

Item configuration screen:

Single graph01.png
  • Agent: Combo where the agent is chosen.
  • Module: Combo where the agent module selected in the previous point is chosen.
  • Show full legend: If the box is checked, the full legend will be displayed.
  • Periodicity: Combo where the graph time period is set.
  • Graph color: Define the colors graph's maximum, minimum and average. If Show full legend is not checked, only the graph's average will appear, so only that color will be used.

Click Update, which should provide a window like the following:

Dashboard24.png

1.2.1.23 Show module SLA percentage

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

Sla percent.png

Setting options:

Config sla.png
  • Agent: Agent used to obtain the module list of the selected one.
  • Module: Module that will provide the data for the selected module status history graph.
  • Periodicity: Period on which the status history graph of the selected module will be made. The value to be selected must be between 1h and 48h.
  • Text size of value in px and Text size of label in px: Value size in pixels for the value and the tag accordingly. If nothing is indicated, Pandora FMS will set the default one.

Click Update:

View sla.png

1.2.1.24 Group Status

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

Icono group status.png

Configuration window:

Config group status.png
  • Groups: Groups to be shown in the widget.
  • Status: Status of the groups to be shown.

Click Update, and a window like the following will appear:

Imagen group status.png

1.2.1.25 Tactical View

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

Dashboard 44.png

Configuration window:

Dashboard 45.png
  • Status and Monitor Checks: General information on the modules.
  • Server Performance: Summary of server statistics.
  • Summary: Summary information about agents and modules.

Click Update:

Dashboard 46.png

1.2.1.26 Top Number of events per agent groups

To show the graph for top events for agents, use the following widget:

Top n events by group.png

Setting options:

Config topn agents.png
  • Amount to show: Amount of agents.
  • Max. hours old: Time during which existing events shown will be taken into account.
  • Groups: Agent groups to be included.
  • Legend position: Graph legend position.

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

View topn agents.png

1.2.1.27 Top N modules

To see graph of the list of more recent modules, use the following widget:

Top n.png

Setting options:

Config topn agents modules.png
  • Agent: Agents to include through a regular expression (regex).
  • Module: Modules to be included through a regular expression.
  • Period: Data period that will be used to show the widget's information.
  • Quantity (n): Amount of modules shown.
  • Order: Way to organize elements, either ascending, descending, or even by agent name.
  • Display: List to be shown by minimum, maximum or average.

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

Setup window:

Config wux trans.png
  • Agent: Choose the agent that has the WUX monitoring to be shown.
  • WUX Transaction: Choose the WUX module to show.

Click Update, and a window like the following will appear:

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

Setup window:

Config wux stat.png


  • Agent: Choose the agent that has WUX monitoring to show.
  • WUX Transaction: Choose the WUX module to show.

Click Update, and a window like the following will appear:

Imagen wux stat.png

1.2.2 Placing items on the dashboard

When clicking on the items from the Dashboard it is 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, press on the configuration icon that can be found on the top right corner of the item to edit.

Dashboard343.png

Once clicked on the icon, the settings menu will appear. Modify it and click Update to save the changes.

1.2.4 Deleting objects on the Dashboard

To delete the configured parameters for an item on the dashboard, click on the trashcan icon at the top right of the item you wish to delete.

Dashboard352.png

1.3 Editing a Dashboard

Dashboard values that can be changed include name and group. In order to update an already existing dashboard, click Options.

Dash-options2.png

Click Ok on the modified element to save the changes.

1.4 Deleting a Dashboard

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

Dash61.JPG

1.5 Slideshow mode

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



Dash4.JPG



The console will switch to slide mode, from where you may 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 to set a refresh rate and switch to slideshow mode.

Dash26.JPG

1.7 Share Dashboard

To share a dashboard, you just need to click the following button, copy the URL and share it with whomever you want.

ShareDashboard1.PNG

Go back to Pandora FMS Documentation Index