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 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 the web console's right side.



Dashboard1.png



When 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" within 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, click on the Options button in the upper right menu:

Dash-options.png



In the popup dialog, assign a name to the dashboard, select the number of cells (widgets) it will contain, and indicate if it will be of the private type (only the user who created it and the Pandora FMS administrator will be able to see it) or visible for a group. You also 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, save the dashboard in order to start adding objects. The next step is precisely 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 and see all the available widgets 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, their use and the options available for each one are detailed below.

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



Indicate in there the name to be displayed for the object and choose the type of clock you want. Optionally, you can choose a specific background color for the widget, setting it on its CSS code.



Analogic reloj.png





Digital reloj.png



1.2.1.4 User defined graphs

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

Dashboard11.png

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

Single graph01.png

On the configuration window, configure the following parameters:

  • Title: Title that will appear on top of the graph.
  • Background: CSS code to choose the background color.
  • Graph: Combo where the graph that will appear can be chosen. Select it from the graphs created on Pandora FMS.
  • Period: Combo where the graph period is established.
  • Pile-Up: The type of graph that the data will be shown on.
  • Color: Select the color for each agent/module that will appear on the graphic. If the type of the graph is Gauge, bullet graphic, horizontal bars or circular graphic colors cannot be selected.

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

View custom graph.png

In the piled-up section you have a series of options:

Config custom graph2.png

They are the different graphic 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. If otherwise, the maximum or minimum value the 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 that took place in Pandora FMS, 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 will appear above the graph.
  • Background: CSS code to choose the background color.
  • Event Type: Combo where you may choose amongst the different types of events available (Critical, Warning...).
  • Event type: Combo where you may choose among the different event types (critical, Warning, etc.).
  • Interval: Combo where the time interval to be used is defined.
  • 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 the "update" button 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

  • Title: Widget title.
  • Background image: CSS code for the background color.
  • 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, 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

  • Title: Widget title.
  • Background: CSS code to choose the background color.
  • Amount to show: Amount of event types.
  • Max. hours old: Time 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:

Dashboard8.png

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

Config groups stats.png

It should indicate the object's name to be shown and the group it should be included in. Optionally, a specific background color for the widget may be chosen, by modifying its CSS code. The resulting widget should be something similar to this:

Group stats widget.png

You may access the corresponding group by clicking on its name, once the widget is created.

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 wish. The settings options are:

Config tree.png

  • Title: Widget title.
  • Background image: CSS color code for the background.
  • Tab: The desired tree view tab.
  • Group: Desired group.
  • Open all nodes: If chacked, 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 option is supported in desktop screens only.

 


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

Dashboard31.png

If you click on the icon above, the object's configuration window will appear.

Dashboard32.png

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

Click on the "Update" button and a window like the one shown below will appear.

Dashboard33.png

Template warning.png

Maps must be previously created by clicking on Administration > Reporting and Visual Console.

 


1.2.1.11 Visual maps report

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

Dashboard25.png

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

Dashboard26.png

Enter the title, select the appropriate visual console's maps to appear in the report and click on "Update". Then a window like this one will appear.

Dashboard27.png

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

  • Title: Widget title.
  • Background image: CSS code for background color.
  • 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: Size in pixels of text value. If nothing is specified, Pandora FMS default one will be indicated.
  • Text size of label in px: Size in pixels of label text. If nothing is specified, Pandora FMS default one will be indicated.
  • Size icon: Icon size, default icon size.

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

Config module status.png

  • Title: Widget title.
  • Background image: CSS code for background color.
  • Label: Text label to be shown.
  • 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

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

Dashboard 42.png

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

  • Title: Title that will appear on top of the widget.
  • Background: CSS code to choose background color.
  • URL: The combo where agent name font size may be selected.

If you click on the "Update" button, a window like the one shown below will appear.

Dashboard 43.png

Bear in mind that the widget will only show embedded url. That is because the option "X-Frame_Options: SAMEORIGIN" is sent in the answer header. This option prevents the browser from showing iFrames that are ont hosted within the main page domain. That is why only url with embedded content can be displayed.

For example, if you wish have a video with the url "https://www.youtube.com/watch?v=ql6LEwhmDWE" displayed, the url must be changed, since that url shows the complete web where the video is hosted. Fro that purpose, replace the text "watch?v=" by "embed/" and the result will be the url "https://www.youtube.com/embed/ql6LEwhmDWE", which will be correctly displayed in the iFrame corresponding to the widget cell.

It is also necessary to "authorize" the content on your browser, validating this content manually.

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

Config module table.png

  • Title: Widget title.
  • Background image: CSS code for background color.
  • 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.

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

Config module value.png

  • Title: Widget title.
  • Background image: CSS code for background color.
  • Label: Label to be shown.
  • 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: Size in pixels of text value. If nothing is specified, Pandora FMS sets the default one.
  • Text size of label in px: Label size in pixels of label text. If nothing is specified, Pandora FMS sets the default one.

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

Dashboard18.png

When clicking on the icon, the item with all the information about the current system status is displayed.

Dashboard19.png

1.2.1.18 Network Map

In order to add a Pandora FMS network map, click on the icon shown below.

Dashboard28.png

When clicking on the icon shown above, the object's configuration window will appear.

Dashboard29.png

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

  • Title: Title on top of the map.
  • Background: CSS code to choose background color.
  • Map: Combo where the network map is selected.
  • X offset: Amount that moves along the x 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 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

If you click on the icon, the object's configuration window will appear.

Dashboard 48.png

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

  • Title: Title on top of the widget.
  • Text: A free-text field containing the message itself.

If you click on the "Update" button, 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

If you click on the icon above, the object's configuration window will pop up.

Dashboard 51.png

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

  • Title: Title on top of the report.
  • Background: CSS code to choose background color.
  • Report: Widget report name.

If you click on the "Update" button, a window like the one shown below will 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: Widget title.
  • Background Image: Background color under the form of a CSS value.
  • Service: Service to show. Must be previously created in the service section.
  • Key: If you want a graph key.

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

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

Config custom graph3.png

On the configuration window, configure the following parameters:

  • Title: Title on top of the graph.
  • Agent: Combo where the agent is chosen.
  • Module: Combo where the module is chosen.
  • Show full legend: If the box is checked, the full legend will be displayed.
  • Period: Combo where the graph time period is set.
  • Graph color: Define the colors graph's maximum, minimum and average. If the check-box Show full legend is not checked, only the graph's average will appear, so only that color will be used.

Click on the "Update" button, 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

The setting options it shows are:

Config sla.png

  • Title: Widget title.
  • Background image: CSS code for background color.
  • 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. The selected value must be between 1h and 48h.
  • 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: Value size in pixels. If nothing is indicated, Pandora FMS will set the default one.
  • Text size of label in px: Label size in pixels. If nothing is specified, Pandora FMS will set the dafult one.

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 selected groups:



Icono group status.png



A configuration window will appear.



Config group status.png



The following parameters must be configured in the configuration window:

  • Title: Item name.
  • Background image: Specific background color for the widget, setting its CSS code.
  • Groups: Groups to be shown in the widget.

Press the "Update" button, 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

By clicking on the icon, the object's setup window will be shown.

Dashboard 45.png

Within the configuration window, these parameters must be configured:

  • Title: Title on top of the widget.
  • Status and Monitor Checks: General information on the modules.
  • Server Performance: Summary of server statistics.
  • Summary:: Summary information about agents and modules.

If you click on the "Update" button, a window like the one shown below will appear.

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

The setting options that it contains are:

Config topn agents.png

  • Title: Widget title.
  • 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 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 see the top module graph, use the following widget.

Top n.png

The settings options it shows are:

Config topn agents modules.png

  • Title: Widget title.
  • Period: Data period that will be used to show the widget's information.
  • Quantity (n): Amount of modules shown.
  • Order: Way to organize elements.
  • Display: Top to be shown. Minimum, maximum or average .
  • Items: To add modules for the widget to use. They 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 setup window will appear.



Config wux trans.png



The following parameters must be configured in the configuration window:

  • Title: The display name of the item.
  • Background image: specific background color for the widget, setting its CSS code.
  • Agent: Choose the agent that has the WUX monitoring to be shown.
  • WUX Transaction: Choose the WUX module to show.

Press the "Update" button, 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



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 item.
  • Background image'’': Specific background color for the widget, setting its CSS code.
  • Agent: Choose the agent that has WUX monitoring to show.
  • WUX Transaction: Choose the wux module to show.

Press "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 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, 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 "Update" on the modified element.

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




Go back to Pandora FMS Documentation Index