Pandora:Documentation en:Dashboard

From Pandora FMS Wiki

Jump to: navigation, search

Go back to Pandora FMS documentation index

The Dashboard

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



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.



Dash2.JPG



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'



Dash3.JPG



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"



Dashboard5.png



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



Dashboard6.png





Dashboard7.png





Dashboard53.png



Adding items to the Dashboard

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

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.



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



Dashboard10.png



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

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.



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

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



Dashboard13.png



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



Dashboard135.png



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

Gauge Mode:



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



Dashboard13555.png



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.



Dashboard16.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...).
  • Interval: combo where the time interval to be used can be defined.
  • 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.

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



Dashboard17.png



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

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



Pandora FMS welcome message

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



Dashboard20.png



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



Dashboard21.png



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.



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

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



Dashboard24.png



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.

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: The option to determine the title which is going appear on the map's top.
  • Group: The combo to select the agent's group to appear on the map.
  • Layout: The combo to select the location of the agents, depending on the map's type.
  • No Overlap: If selected, the agents aren't going to be displayed in an overlapping manner.
  • Simple: If selected, the agents are going to appear without any icons.
  • Font Size: The combo intended to select the font's size used to display the agent's names.

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



Dashboard30.png



The Visual Console's Map

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

 



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



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



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



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



Top Number of events per agent groups

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



Dash8.JPG



The setting options that it presents are:



Dash9.JPG



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



Dash10.JPG



Top N events per modules

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



Dash11.JPG



The configuration options it presents are:



Dash12.JPG



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



Dash10.JPG



Top N modules

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



Dash13.JPG



The settings options it shows are:



Dash14.JPG



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



Dash15.JPG



Showing a service map

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



Dash16.JPG



The settings options it shows are:



Dash17.JPG



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



Dash18.JPG



Triggered alert reports

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



Dash19.JPG



The settings options it shows are:



Dash20.JPG



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



Dash21.JPG



Show tree graph view

To show the tree graph view we'll use the following widget.



Dash22.JPG



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:



Dash23.JPG



  • 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.
  • Agents status: filters by agent status.
  • Modules status: filters by module status.
  • Filtrar módulos: filters modules by name.

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



Dash24.JPG



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.

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.



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

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.



Dashboard35.png



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.

Dashboard36.png



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



Dashboard37.png



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.



Dashboard40.png



Please click on the 'Delete Dashboard' option.

Go back to Pandora FMS Documentation Index