Difference between revisions of "Pandora: Documentation en: Dashboard"

From Pandora FMS Wiki
Jump to: navigation, search
(User-Defined Graphs)
(State of the System)
Line 210: Line 210:
 
<br><br>
 
<br><br>
 
<center>
 
<center>
[[image:dashboard18.png]]
+
[[image:dashboard18.png|250px]]
 
</center>
 
</center>
 
<br><br>
 
<br><br>
Line 218: Line 218:
 
<br><br>
 
<br><br>
 
<center>
 
<center>
[[image:dashboard19.png]]
+
[[image:dashboard19.png|600px]]
 
</center>
 
</center>
 
<br><br>
 
<br><br>

Revision as of 05:39, 13 November 2015

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.



Dashboard2.pgn.png



1.2 Creating a Dashboard

The dashboards are all customizable. Each user configures his own dashboard and is only able to see the ones he has configured for himself.

In order to create a dashboard, please click on 'Reporting' and ' Main Dashboard'. All users have a dashboard named 'default'. Please click on the 'Add Dashboard' menu option as shown below to create a new one.



Dashboard3.png



Please insert the name you'd like to see within the dashboard's tab in the window which appears in this moment. Please click on the 'Add' button after you've assigned the visibility group.



Dashboard4.png



In the moment the new tab has been created, there are two tabs at your disposal: The default tab and the new one. In order to add objects to the tab, please click on the 'Add Widget' menu option as shown on the picture below.



Dashboard5.png



In this moment, a new window within which all objects you're able to add to your new tab are specified.



Dashboard6.png





Dashboard7.png





Dashboard53.png



1.2.1 Adding Objects to the Dashboard

You're also able to add several different objects to the dashboard. Each of them comes with its own features.

1.2.1.1 Group Status Report

In order to add a report to the Pandora FMS group's status, please click on the icon shown below.



Dashboard8.png



By clicking on the icon, the configuration window of the object appears.



Dashboard9.png



Please insert a title, select the groups which are supposed to be contained in the report and click on the 'Update' button, shown on the picture above. If you click on it, a window like the one shown on the picture below is going to appear.



Dashboard10.png



You're able to access the corresponding group within the 'Operation' menu by clicking on the group's name.

1.2.1.2 User-Defined Graphs

Please click on the icon shown on the picture below in order to add a user-defined graph.



Dashboard11.png



By clicking on the icon, the object's configuration window is going to appear.



Dashboard12.png



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

  • Title: The title which is going to appear on the graph's top.
  • Graph: The combo in which you're able to select the appropriate graph to appear. You're able to choose among the graphs created by Pandora FMS.
  • Period: The combo in which you're able to select the appropriate period for the graph.
  • Stacked: The option to select whether you want the different combined graph's values to be displayed above the other or not.
  • Width: The option to select the graph's overall width.
  • Height: The option to select the graph's overall height.

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



Dashboard13.png



At the stacked selection different options are shown:



Dashboard135.png



The options displayed at the selection menu are the different graphic modes. As in the examples below:

Gauge Mode:



Dashboard1355.png



On this type of graphic , the maximum and minimum in each of the clocks will be defined by the maximum and minimum value defined at the module. In other cases, the value shown will be the highest and lowest that the module itself has been along his historical execution. The "Warning" and "Critical" values will be shown with an orange and red line, respectively.


Stacked Area:



Dashboard13555.png



1.2.1.3 The 'Last Events' List

In order to add a list, containing the last events which took place in Pandora FMS, please click on this icon:



Dashboard15.png



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



Dashboard16.png



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

  • Title: The option to determine the title to display on the graph's top.
  • Event Type: The combo in which you're able to choose among the different existing event types like 'OK', warning', 'critical' etc.
  • Interval: The combo in which you're able to define the time interval you intend to use.
  • Limit: The combo in which you're able to define the maximum number of events to appear.
  • Event Status: The combo in which you're able to choose the event's state, e.g. 'validated', 'without validation' or all of them.
  • Groups: The option to select the group from which the events are going to be shown.

If you click on the 'Update' button shown on the picture above, an event window like the one below is going to appear.



Dashboard17.png



If you click on the agent's name, you're accessing the agent's configuration window.

1.2.1.4 State of the System

In order to add a report which contains the state of the Pandora FMS monitors, please click on the icon shown on the picture below.



Dashboard18.png



If you click on the above icon, the 'Global Health' window is going to appear.



Dashboard19.png



1.2.1.5 The Pandora FMS Welcome Message

In order to add the Pandora FMS welcome message, please click on the following icon:



Dashboard20.png



If you click on the above shown icon, the object containing the welcome message is going to appear.

Dashboard21.png

1.2.1.6 The Agent's Module Graph

In order to add a graph to one of the Pandora FMS agent modules, please click on this icon:



Dashboard22.png



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



Dashboard23.png



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

  • Title: The option to determine the title that's going to appear on the graph's top.
  • Group: The combo to select the group the agent belongs to.
  • Agent: The combo to select the agent.
  • Module: The combo to select the module.
  • Period: The combo to select the appropriate time period for the graph to show.

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



Dashboard24.png



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:



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



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

 



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.



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



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.13 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.2 Putting Objects onto the Dashboard

By clicking on the dashboard's objects, it's possible to drag and drop them anywhere.

1.2.3 Editing Objects on the Dashboard

In order to edit the configuration parameters of a dashboard object, please click on the gearwheel-shaped configuration icon on the upper right side of the object you intend to edit as shown below.



Dashboard34.png



Once you have clicked on the icon, the object's configuration menu is going to appear. Please modify it and click on the 'Update' button to save your changes.

1.2.4 Deleting Objects from the Dashboard

In order to delete an object's configuration parameters from the Dashboard, please click on the trash icon on the upper right side of the object you intend to delete.



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

Dashboard36.png



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



Dashboard37.png



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.



Dashboard40.png



Please click on the 'Delete Dashboard' option.

Go back to Pandora FMS Documentation Index