Difference between revisions of "Pandora: Documentation en: Data Presentation/Visualization"

From Pandora FMS Wiki
Jump to: navigation, search
(Monitor Details)
(The Mobile Console)
 
(5 intermediate revisions by the same user not shown)
Line 646: Line 646:
 
===Alert Details===
 
===Alert Details===
  
This section shows a list of alerts created in Pandora FMS. They can be filtered by group, state, label, text, action and whether they are enabled or disabled. Besides the information of each alert, we can force its execution.
+
This section shows a list of alerts created in Pandora FMS. They can be filtered by group, state, label, text, action and whether they are enabled or disabled. Besides the information of each alert, their execution can be forced.
  
Additionally, we can validate an alert. With this, we will only change the state of the alert to "not fired" restoring this way the counter of the same ones, without having to wait for the configured threshold.
+
Additionally,an alert can be validated. With this, just the state of the alert is changed to "not triggered", restoring their counter, without having to wait for the configured threshold.
  
 
<center>
 
<center>
Line 656: Line 656:
 
=== Agent/ Alert View ===
 
=== Agent/ Alert View ===
  
This section shows a list of agents that have alerts, with the type of alert they have. You can also show those agents that do not have any type of alert.They can be filtered by group and show those agents that don’t have any configured alert.  
+
This section shows a list of agents that have alerts, along with their type of alert. Those agents that do not have any type of alert can be displayed too. They can be filtered by group and shown.  
  
 
<center>
 
<center>
Line 662: Line 662:
 
</center>
 
</center>
  
=== Agents / Modules View ===
+
=== Agent / module view ===
  
By clicking on 'Monitoring' > 'Views' and 'Agent/Module View', a matrix containing modules, agents and the state of every single module is displayed.
+
This section shows a matrix with modules, agents and each module's status.
  
In order to invoke the extensions, please click on 'Operation' -> 'Extensions' and the 'Agents/Modules' view.
+
Access the extension from ''Monitoring'' > ''Views'' > ''Agents/Modules View''.
  
 
<center>
 
<center>
Line 672: Line 672:
 
</center>
 
</center>
  
If we tick the recursion token, we can list the agent / module content taking into account the secondary groups and subgroups of the agents.
+
If you check the recursion token, you can list the agent / module content taking into account secondary groups and agent subgroups.
  
 
=== Module Groups View ===
 
=== Module Groups View ===
  
This section allows to have a precise overview in a module table by its state, regarding the module's group and the module itself.
+
This section allows to have a total overview in a module table by their state, regarding the module's group and the group.
In order to access the extensions, please click on 'Monitoring' > 'Views' and 'Module Groups'.
+
Access the extension clicking on ''Monitoring'' > ''Views'' and ''Module Groups''.
  
 
<center>
 
<center>
Line 683: Line 683:
 
</center>
 
</center>
  
As you can see on the image above, there is a matrix containing the module's number, assorted by agent group along with different colors, depending on whether there are modules in 'critical', 'warning' or 'OK' states or not.
+
As you can see on the image above, there is a matrix containing the number of modules, assorted by agent group along with different colors, depending on whether there are modules in critical, warning or OK states or not.
  
 
== The Mobile Console ==
 
== The Mobile Console ==
  
Pandora FMS comes with a new mobile console. This console a reduced version of the default console and allows any user with a mobile device with at least 600x280 pixels of screen resolution to browse all information provided by Pandora FMS like agents, monitor view, alerts, agent detail (graphs included), group view and last events.
+
Pandora FMS comes access to the console from smartphones or tablets. This is a "special" version of the common Pandora FMS console and works on any device with internet access, a browser and at least 600x280 pixels of screen resolution. Then you have access to all information provided by Pandora FMS such as: agents, monitor view, alerts, agent detail (graphs included), group view and last events.
  
The mobile interface is located at '/mobile' [url], so if your regular console is located at '<nowiki>http://firefly.artica.es/pandora_demo/</nowiki>' your mobile console is located at '<nowiki>http://firefly.artica.es/pandora_demo/mobile</nowiki>'.
+
The mobile interface is located at '/mobile'. So if your regular console is located at '<nowiki>http://firefly.artica.es/pandora_demo/</nowiki>' your mobile console is located at '<nowiki>http://firefly.artica.es/pandora_demo/mobile</nowiki>'.
  
This URL is compatible to any device which is able to access native websites. It has been thoroughly tested with iPhone and android-based cellphones and tablets and adapts automatically to the width of your device's screen.
+
This mobile console is supported by any modern, and it has been tested on iPhone and android-based devices as well as Android and iPad tablets.
  
 
<center>
 
<center>
 
[[Image:Mobile1.png]]
 
[[Image:Mobile1.png]]
  
The login screen within the mobile web interface.
+
Login screen
 
</center>
 
</center>
  
Line 702: Line 702:
 
[[Image:Mobile2.png]]
 
[[Image:Mobile2.png]]
  
The tactical view of the mobile web interface.
+
Tactical view
 
</center>
 
</center>
  
Line 708: Line 708:
 
[[Image:Mobile3.png]]
 
[[Image:Mobile3.png]]
  
The detailed event view.
+
Event detail view
 
</center>
 
</center>
  
Line 714: Line 714:
 
[[Image:Mobile4.png]]
 
[[Image:Mobile4.png]]
  
The detailed module graph.
+
Detailed module graph view
 
</center>
 
</center>
  
Line 720: Line 720:
 
[[Image:Mobile5.png]]
 
[[Image:Mobile5.png]]
  
The general options menu.
+
Menu general options
 
</center>
 
</center>
  
Line 726: Line 726:
 
[[Image:Mobile6.png]]
 
[[Image:Mobile6.png]]
  
The agent's detailed view.
+
Agent detailed view
 
</center>
 
</center>
  
Line 732: Line 732:
 
[[Image:Mobile7.png]]
 
[[Image:Mobile7.png]]
  
The module's detailed view.
+
Module detailed view
 
</center>
 
</center>
 
[[Pandora:Documentation_en|Go back to Pandora FMS documentation index]]
 
[[Pandora:Documentation_en|Go back to Pandora FMS documentation index]]

Latest revision as of 02:57, 7 November 2019

Go back to Pandora FMS documentation index

Template wip.png

We are working on the translation of the Pandora FMS documentation. Sorry for any inconvenience.

 


1 Typography and languages

Pandora FMS includes a collection of fonts that can be used within graphics, maps and reports. Among the included fonts, smallfont.ttf is used by default, because it supports different alphabets such as Latin, Arabic, hiragana, katakana and many others.

The fonts are located in the directory named '/include/fonts' where you may paste new fonts if you need them.

2 Graphs

Graphs show data collected by Pandora FMS during a time threshold defined by the user. Pandora FMS graphs show data on request, and they are generated every time the operator requires one of them, showing the most recent data.

2.1 Interpreting graphs in Pandora FMS

The graphs in Pandora represent the values that a module has had over a period of time.

Due to the great amount of data that Pandora FMS stores, two different types of features are offered, the normal graphs and the full scale graphs or TIP.

2.1.1 Normal graphs

General features

These are graphs that represent the information stored by the module at a basic level.

It allows us to see an approximation of the value range of the module.

They divide the module data into boxes in such a way that a sample of the module values is represented.

Not all values are represented, which is complemented by dividing the view into three graphs:

  • Max (maximum values).
  • min (minimum values).
  • avg (average values).
  • Advantages: They are generated very quickly, without hardly consuming any resources.
  • Disadvantages: The information provided is approximate. The states of the monitors they represent are calculated based on events.

Graphs normal.png

2.1.2 TIP Graphs

General features

These graphs represent real data.

It shows us a true representation of the data reported by the module.

As these are real data, it will not be necessary to add extra graphs to the information (avg, min, max).

Calculating periods in unknown state is supported by events, such as normal graphs, but is complemented by extra detection for cases where events have been purged (by performance optimization, for example).

  • Advantages: The data represented are all decompressed data from the database. It is the most realistic way to review module data.
  • Disadvantages: Its processing is slower than that of normal graphs. Depending on the time range and the volume of data to be displayed, your display may be less fluid.

Graphs tip.png

After having seen how Pandora FMS interprets graphs, the different types of graphs available depending on the data source will be discussed:

  • Module graphs.
  • Interface graphs.
  • Custom graphs.

2.2 Module graphs

2.2.1 Introduction

Module graphs represent data reported by specific modules.

You may define in the visual configuration the interactive or static graphs. In the case of interactive graphs, by placing the mouse at some point on the backside of the graph, the specific data of that point will be shown.

Non-interactive graphics will generate a static image with which you cannot interact.

They have normal and TIP modes for their representation.

In normal mode, it is possible to adjust the resolution of the graph to improve the display, as you can see in the following example image. The values between which the resolution can be configured are 1 (lowest) and 5 (highest).

Comparativa resolucion graficas2.jpg

Low resolution (1)


Comparativa resolucion graficas.jpg

High resolution (5)

Comparativa resolucion graficas3.jpg

Pure Data TIP

Note: You may configure all aspects of the graphs in the menu Setup > Setup > Visual Style.

2.2.2 Where can module graphs be found?

Module graphs are accessible through monitor detail, which can be reached by clicking on Monitoring > Views > Monitor detail.

Monitor detail.png

You may also find them in the agent view (module list). To access these graphs, choose an agent from Monitoring > Views > Agents Detail:

Pre1.png

After filtering, click on the agent name, for example localhost.localdomain, to access the agent operation menu.

Pre2.png

In this screen there is a list with all agent modules. In the module table view, two icons appear under the legend "Graph", one will show the raw data (right) and the other one a link to access the module graph (left).

Pre3.png

If you click on the graphic icon, you will access a new window where you may customize the module data to be displayed.

Quick graph.png

The graphs have a configuration menu that allows (by hovering over the tab to the left of the graph window), reconfiguring the view of the current graph. In the legend you can see statistical data (Last value, Average, Maximum and Minimum) for each of the series shown.

Pre4.png

To select an area of ​​the graph that you want to represent, selecting that area with the mouse in the graph below, zooming in the desired area.

The following parameters can be set in quick graph configuration:

2.2.3 Display options

Refresh Time

The field where the graph's refresh time is defined.

Avg. Only

If you select it, it will show the average data graph.

Begin Date

Date until which the graph will be drawn.

Begin Time

Time until which the graph will be drawn (hour, minutes, seconds).

Zoom Factor

Graph visor size, multipliable.

Time Range

Time range when data will be collected.

Show Events

It shows indicator points with event information at the top.

Show Alerts

It shows indicator points with triggered alert information at the top.

"Show percentile"

It adds a graph that indicates the percentile line (configurable in Pandora FMS general visual options).

Time Compare (Overlapped)

It shows the same graph overlapped but in the previous interval to the selected one. For instance, if you request a period of one week and activate this option, the week prior to the chosen one will also be shown overlapped.

Time Compare (Separated)

It shows the same graph as the overlapped version but in a separated graph. For example, if you request a period of one week and activate this option, the week before the chosen one will also be displayed.

"Show Unknowns Chart."

It shows boxes in grey shading covering the periods where Pandora FMS cannot guarantee the module's status, either due to data loss, software agent shutdown, etc.

Show Full Scale Graph (TIP).

It switches the drawing mode from "normal" to "TIP". That way, graphs will show real data rather than approximations, so the time it will take to generate them will be longer.

Once the values have been changed, click on "Reload" to apply them.

2.3 Interface graphs

Interface graphs are specialized combined graphs that allow to analyze the performance of a network interface.

They are automatically shown whenever the following modules exist in the agent:

  • interface_ifOperStatus
  • interface_ifInOctets
  • interface_ifOutOctets

Input and output octets may also appear as your HC alternatives (ifHCInOctects, ifHCOutOctects).

When the system detects the existence of these modules, it will automatically generate the interface analysis section and the following graphs:

Interface charts1.png

Agent overview with network traffic data

Interface charts2.png

Interface graph detail

These graphs also enable quick option selection, as in module graphs, with the particularity that they add to same view information from different sources (input and output octets) and the variety of drawing options is smaller.

2.4 Custom graphs

Custom graphs allow to combine information from multiple modules into a single, size-variable graph. That way, information from several sources can be compared visually.

2.4.1 Creating combined graphs

To add a combined graph, go to Reporting > Custom graphs

Cg menu.png

And click on "Create graph".

Graph builder.png

These are the fields that can be found:

Name

Name assigned to the graph.

Group

Here you the graph can be added to a specific group.

Description

Field you write information.

Width

Field intended for the graph's width value.

Height

Field intended for the graph's height value.

Period

Combo to define the time period used to create the graph.

Graphic Type

Combo to select the type of graph choosing between Horizontal bars, Vertical bars, Bullet graph, Circular graph, Line, Stacked line, Meter, Area, and Stacked area.

Equalize thresholds

It indicates whether the general maximum and minimum thresholds should be set for value comparisons in bullet charts.

Percentile

It displays data percentile (customizable value in Pandora fMS console visual options).

Add summation series

It displays the sum of all data.

Add average series

It displays the average of all data.

Modules and series

This field will only be active if you select add summatory and/or average series. If checked, the graph will show the module data next to its summation and average. Otherwise, it will only show the summation and average.

Show TIP graphic.

The TIP drawing system will be used to display real values of each data source selected in the element configuration.

Template warning.png

When exporting graphics in CSV format, it is important to bear in mind the decimal separator configuration of the CSV file management program to be used. Pandora FMS uses a dot as a separator by default.

 


2.4.2 Adding elements to combined graphs

To add new modules, click on the Graph Editor button, you will be presented with a form where you can add new modules from any agent.

Pre8.png

The "weight" option allows to adjust the data in order to compare graphs of different magnitudes. This field multiplies the data by the defined weight.

For example, if you want to put in the same CPU graph with values between 0 and 100 and number of connections with values between 1000 and 10000, it is convenient to multiply the CPU by 10.

There is no limit to the number of elements that can be displayed, but from five onwards, the amount of information displayed makes it difficult to interpret, unless large graphics (800x600, etc.) are used.

Example of custom graph:

Pre7.png

You can adjust certain displays within the view screen:

Cg view.png

2.4.3 Seeing combined graphs

To see a combined graph, go to Reporting > Custom Graph where a list of all saved graphs appears. To see a graph, click on its name.

Pre12.png

When accessing the graph, it will be made up by the most recent values for the selected time threshold.

Pre13.png

From this page, it is possible to modify certain display parameters such as time period, graph type and zoom (Graph definition, Zoom x1, Zoom x2 and Zoom x3).

The following is an example with the different types of graphics (the area type is in the image above). Area, Horizontal bars, Vertical bars, Bullet charts, Gauge, Pie, Line, Stacked line y Stacked area.

  • Area Type

Area.png

  • Horizontal bars Type

Horbars.png

  • Vertical bars Type

Vertbars.png

  • Bullet chart Type

Bear in mind, this type of chart is not compatible with negative values.

Bullchart.png

  • Gauge Type

Gauge.png

  • Pie Type

Pie.png

  • Line Type

Pre14.png

  • Stacked area Type

Pre15.png

  • Stacked line Type

Pre16.png

2.4.4 Deleting stored combined graphs

To delete a stored combined graph, click on Reporting > Custom Graph. It is where all stored graphs are listed. Click on the trash icon on the graph's right side to delete it.

Cg list2.png

2.4.5 Graph containers

From Pandora FMS 7.0NG. 710 the concept of "Graph container" appears.

This concept allows:

  • Defining as many containers as desired.
  • Nesting containers.
  • Creating simple module graphs.
  • Referencing custom graps.
  • Creating graphs using dynamic rules.
2.4.5.1 Creating a container

To create a graph container, access the container tab from the custom graphs homepage:

Cg container.png

Click on "Create container"

Cg container2.png

Which will take you to the creation form:

Cg container3.png

In the creation form, you can fill in the following fields:

Name

Container name.

Group

Owner group of the container.

Description

Container custom description.

Parent container

Where to store the container.

2.4.5.2 Adding graphs to the container

There are three options to add graphs to a container:

Simple module graph

It allows to add a simple module graph, select the agent and module to be drawn, as well as the time threshold.

You also have the following options:

Only average: It just displays the graph corresponding to the average of values (normal system).

Show TIP graph: It shows the module's real data.

Cg container add1 new.png

Custom graph

It allows to select an existing custom graph and add it to the list of graphs in the container.

It allows to select the time threshold and whether or not you want real data.

Cg container add2.png

Simple module graphs based on dynamic rules

It allows you to add several simple module graphs using selectors based on regular expressions.

Specify the regular expressions that agents and modules must meet to be added to the list of graphs to generate.

For example, if you have the agents called office1, office2, room1, room2 with the inOctects modules, and you would only like to represent the modules of the office agents, you should specify it as follows:

  • agent: office.*
  • module: inOctects

The system would automatically create 2 graphs, one for the office1 agent module inOctects, and another for the office2 agent inOctects module.

These options are also available:

Only average: It displays only the graph corresponding to the average of values (normal system).

Show TIP graph: It shows the module's real data.

Cg container add3 new.png
2.4.5.3 Listing and managing container graphs

At the bottom of the container's editing page, you may see the list of graphs registered in this container. You can delete them by clicking on the trash can icon.

It is not possible to edit container graphics, you must create it again with the required modifications and then remove it.

Cg container edit list.png
2.4.5.4 Container view

By clicking on the container tab, you may access the list of containers and their graphs:

Cg container list.png

On this tab you will see nested those containers defined like that.

To see the graphs stored in a container, click on the container title.

2.5 Real-time Graphs

There are two ways to display graphs in real time. On the one hand, there is a series of checks generated by Pandora FMS and others generated by SNMP modules.

The first to be discussed is graphs created by Pandora FMS. Therefore, go to Monitoring > Views > Real-time graphs.

Grafica realtime.png

These graphs are based on command execution from the console to the machine where it is hosted, where the following checks can be performed:

  • Pandora FMS Server Apache load: It shows in real time the load by the Apache service.
  • Pandora FMS Server CPU: It shows in real time the CPU load where the Pandora FMS console you are working with is installed.
  • Pandora FMS Server Disk IO wait: It shows in real time the input/output disk requests that are queueing.
  • Pandora FMS Server load: It shows in real time the load caused by the server.
  • Pandora FMS Server MySQL load: It shows in real time the load caused by the MySQL service.
  • Pending packages from Pandora FMS Server: It shows in real time the amount of queued packets that the Pandora FMS server has yet to manage.
  • SNMP Interface throughput: Once SNMP data about the machine are entered: IP, community and OID, it will show in real time the data returned by the machine to which you are making the request. In this type of graphs, only versions 1, 2 and 2c can be checked. In order to know the OID, there is the SNMP walk tool with which you can see in tree form the OID of the machine to which you point. To learn more about SNMP monitoring, go to the following link.

Grafica realtime snmpwalk.png

Grafica realtime snmpwalk OID.png

Besides choosing the type of graph to use, select the graphic update interval (which minimally affects the performance) and if you wish to show the data incrementally or not. If you use the incremental, you will see a rate of the changes made in the results per second (if the interval is 1 second). It is important to emphasize that it is not possible to generate new graphs apart from those that come by default in Pandora FMS.

The second key points discussing the graphs generated by SNMP modules, which, unlike the graphs described above, can also be made in version 3. These graphs can be seen in two places. Both in Monitoring > Views > Monitor Detail or within the view the agent view.

Grafica realtime monitor detail.png

These graphs are the same as those generated in SNMP Interface throughput explained above, with the data added to the module.

3 Views

3.1 Tactical view

This section shows general information about Pandora FMS status. On the one hand, there is a visual report with the status of server, modules and alerts, a count of created and fired alerts, a summary of modules by state, the total of agents and modules, as well as the server performance. On the other hand, the last generated events can be seen, as well as their statistics. Finally, there is also a list with the status of active servers.

Vista tactica nueva.png

3.2 Group view

This section shows a summary of the agent and module status divided by groups. On the one hand, it is possible to see a percentage statistic of agent and module states. On the other hand, a matrix with the number of agents and modules by state and by group.

Vista grupos nueva.png

3.3 Tree View

This section shows agent and module information in tree form. It is possible to choose through which classification this information is displayed. In all of them you may filter by group, agent or module.

The classification can be sorted out by:

  • Groups (default view)
  • Tags
  • OS
  • Module groups
  • Modules
  • Policies

Tree nueva.png

The information about and agent will be displayed by clicking on it.

Tree agent.png

At the same time, by clicking on a module, its graph or information will be displayed.

Tree module.png

Tree module2.png

Tree module3.png

3.4 Agent Details

This section shows a list with the existing agents in Pandora FMS installation. The result of the list can be filtered by group, agent name, status or custom fields.

Inside the represented information you may see the agent status and the alerts it contains. The status of the agent will depend on the status of its modules or the status of the agent:

  • Critical (red): At least one monitor is in critical state.
  • Warning (yellow): At least one monitor is in warning state.
  • Normal (green): All your monitors are in normal state.
  • Not Started (blue): No associated data.
  • Unknown (grey): Agent down.

The status of the alerts will depend on whether any alerts have been triggered (orange), whether they have been disabled (grey) or no alerts have been fired (green).

From this view, we will be able to access the desired agent edition or view.

Vista detallesagentes nueva.png

3.5 Monitor details

This section shows a list with the existing monitors in Pandora FMS installation. You can filter the list result by group, monitor status, module group, module name, label, server type, data type and if they are enabled/disabled.

Inside the represented information you can see the agent it belongs to, the data it hosts and its state. Module states can be:

  • Critical (red): The data received is within the threshold set as critical.
  • Warning (yellow): The data received is within the threshold set as warning.
  • Normal (green): The data received is outside critical and warning thresholds.
  • Not initiated (blue): No information received.
  • Unknown (grey): Information has been received at some point, but not anymore.

Vista detallesmonitores nueva.png

3.6 Tag view

This section shows a list of agents and modules that have tags. They can be filtered by group, monitor status, module group, module name, server type, agent custom field or labels.

Vista etiquetas nueva.png

3.7 Alert Details

This section shows a list of alerts created in Pandora FMS. They can be filtered by group, state, label, text, action and whether they are enabled or disabled. Besides the information of each alert, their execution can be forced.

Additionally,an alert can be validated. With this, just the state of the alert is changed to "not triggered", restoring their counter, without having to wait for the configured threshold.

Vista detallesalertas nueva.png

3.8 Agent/ Alert View

This section shows a list of agents that have alerts, along with their type of alert. Those agents that do not have any type of alert can be displayed too. They can be filtered by group and shown.

Agente-alerta.png

3.9 Agent / module view

This section shows a matrix with modules, agents and each module's status.

Access the extension from Monitoring > Views > Agents/Modules View.

Ex4c new.png

If you check the recursion token, you can list the agent / module content taking into account secondary groups and agent subgroups.

3.10 Module Groups View

This section allows to have a total overview in a module table by their state, regarding the module's group and the group. Access the extension clicking on Monitoring > Views and Module Groups.

Ex4.png

As you can see on the image above, there is a matrix containing the number of modules, assorted by agent group along with different colors, depending on whether there are modules in critical, warning or OK states or not.

4 The Mobile Console

Pandora FMS comes access to the console from smartphones or tablets. This is a "special" version of the common Pandora FMS console and works on any device with internet access, a browser and at least 600x280 pixels of screen resolution. Then you have access to all information provided by Pandora FMS such as: agents, monitor view, alerts, agent detail (graphs included), group view and last events.

The mobile interface is located at '/mobile'. So if your regular console is located at 'http://firefly.artica.es/pandora_demo/' your mobile console is located at 'http://firefly.artica.es/pandora_demo/mobile'.

This mobile console is supported by any modern, and it has been tested on iPhone and android-based devices as well as Android and iPad tablets.

Mobile1.png

Login screen

Mobile2.png

Tactical view

Mobile3.png

Event detail view

Mobile4.png

Detailed module graph view

Mobile5.png

Menu general options

Mobile6.png

Agent detailed view

Mobile7.png

Module detailed view

Go back to Pandora FMS documentation index