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

From Pandora FMS Wiki
Jump to: navigation, search
(Programación automática de informes)
(Availability)
 
(190 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
[[Pandora:Documentation_en|Go back to Pandora FMS Documentation Index]]
 +
 
== Reports ==
 
== Reports ==
  
Pandora FMS offers you the possibility of presenting the monitored data in an orderly way in the form of reports.
+
Pandora FMS offers you the possibility of presenting the monitored data sorted out through reports.
 
 
 
 
Within a report, the information to be presented is organized in '''report elements''. There are many different types of elements, which perform calculations and present the information in very different ways. For example, we can choose a "simple graph" type element that makes individual graphs or an "SLA" type element that shows us the degree of compliance of a number of monitors.
 
  
 +
Within a report, the information to be presented is organized in '''report elements''. There are many different types of elements, which perform calculations and present the information in very different ways. For example, you may choose a "simple graph" type element that makes individual graphs or an "SLA" type element that shows the degree of compliance of a number of monitors.
  
 
Although they generally have a very similar configuration form, each type of element will be configured independently.
 
Although they generally have a very similar configuration form, each type of element will be configured independently.
  
 
+
You may have as many elements as you want, of the type of your choosing.
You can have as many elements as you want, of the type you want.
 
  
 
=== Creating a Report ===
 
=== Creating a Report ===
  
In order to add a report, please click on ''Reporting -> Custom reporting''.  
+
In order to add a report, click on ''Reporting > Custom reports''.  
  
 
<center>
 
<center>
Line 20: Line 19:
 
</center>
 
</center>
  
It's going to show you a list which contains all the reports. In order to create a report, please click on "Create Report".
+
It will show a list containing all the reports. In order to create a report, click on "Create Report".
  
 
<center>
 
<center>
Line 26: Line 25:
 
</center>
 
</center>
  
There is one window within which the name of the report, the group it belongs to, whether it's private or not and the description is defined and contained.  
+
There is a form where to enter the name of the report, select the group it belongs to, whether it is private or not and add its description.  
  
Once the fields have been filled out, please click on "Create Report".
+
Once the fields have been filled out, click on "Create".
  
 
<center>
 
<center>
Line 34: Line 33:
 
</center>
 
</center>
  
Once done, it will appear a blank report, where we will continue its edition including new elements.
+
Once done, a blank report will appear, where you may edit it including new elements.
  
=== Editing a Report ===
+
=== Editing a report ===
  
In order to edit a report, please click on ''Reporting -> Custom Reporting''. It contains a list in which all the reports so far are listed. In order to edit a report, please click on the report's name.
+
In order to edit a report, click on ''Reporting > Custom reports''. It contains a list with all the created reports. In order to edit a report, click on the report's name.
  
 
<center>
 
<center>
Line 44: Line 43:
 
</center>
 
</center>
  
=== Deleting a Report ===
+
=== Deleting a report ===
  
In order to delete a report, please click on 'Reporting' -> 'Custom Reporting' and 'Report Builder'. It contains a list in which all the reports so far are listed. In order to delete a report, please click on the trash icon which is located on the right side of the report's name.
+
In order to delete a report, click on ''Reporting'' > ''Custom reports''. It contains a list where all the reports up to that moment are listed. In order to delete a report, click on the trash icon located at the right side of the report's name.
  
 
<center>
 
<center>
Line 54: Line 53:
 
=== Tabs ===
 
=== Tabs ===
  
==== Main Tab ====
+
==== Main tab ====
  
The main tab is the only one available within a new report, so this one defines the report's basic data (name, access group and description). After storing it properly, you're able to access the rest of the tabs.
+
The main tab is the only one available within a new report, since there one defines the report's basic data (name, access group and description). After saving it properly, you may access the rest of the tabs.
  
 
<center>
 
<center>
Line 62: Line 61:
 
</center>
 
</center>
  
The fields pertaining to this particular tab are the following:  
+
The fields belonging to this particular tab are the following:  
  
 
* '''Name:''' Intended to define the name of the form.
 
* '''Name:''' Intended to define the name of the form.
* '''Group:''' Intended to define the access group that is visualized within the report.
+
* '''Group:''' Intended to define the access group displayed within the report.
* '''Description:''' Intended for providing more report information to the users (which is also going to be shown within the report's list). It's also going to be shown within the visualization of the report as XML and PDF.
+
* '''Description:''' Intended for providing more report information to the users (which will be shown within the report's list). It will also be displayed on the report in XML and PDF formats.
  
==== The 'List Items' Tab ====
+
==== The 'List Items' tab ====
  
By this tab, you're going to obtain a global visualization of all items the report is composed of. The items contained in the list will be displayed in the same order they're going to have within the report later. Within this tab, you have the following options:
+
In this tab, you have a global view of all items the report is made up by. The items contained in the list will be displayed in the same order as in the report later on. This tab provides the following options:
  
* To modify the item (by clicking on the adjustable spanner).
+
* Modifying the item (by clicking on the wrench).
* To modify the order with the right side boxes "sort" and the pannel below "Sort items".
+
* Modifying the order with the right side boxes and the drop-down "Sort items".
* To modify the order manually by the green arrows on the left.
+
* Modifying the order manually through the green arrows on the left.
* To delete the item by clicking on the red x-shaped icon.
+
* Deleting the item by clicking on the red x-shaped icon.
  
If it's a big report which contains several items, it has a form on the top in order to filter the items by different criteria.
+
If it is a long report that contains several items, it has a form at the top in order to filter the items by different criteria.
  
 
<center>
 
<center>
Line 83: Line 82:
 
</center>
 
</center>
  
The columns pertaining to this particular tab are the following:
+
The columns belonging to this particular tab are the following:
  
 
* '''P.:''' The items appear exactly in this column's order within the report.
 
* '''P.:''' The items appear exactly in this column's order within the report.
* '''Type:''' The column in which the item's type is displayed.
+
* '''Type:''' The column where the item's type appears.
* '''Agent:''' The column in which the agent's name is mentioned. It's also allowed to leave it blank for item types like [http://en.wikipedia.org/wiki/Service-level_agreement '''SLAs'''], custom graphs, import texts from [http://en.wikipedia.org/wiki/Url '''URLs'''], [http://en.wikipedia.org/wiki/Sql '''SQL'''] queries, simple graphs and texts.
+
* '''Agent:''' The column that contains the agent's name. It can be empty for item types like SLA, custom graph, import texts from URL, SQL queries, simple graphs and texts.
* '''Module:''' The column in which the module's name will be extracted from the data in order to generate the report. It's also allowed to leave it blank for item types like detailed agent view, alert report agent, custom graph, event report agent, import text from URL, SLA, SQL queries and text.  
+
* '''Module:''' The column that contains the name of the module from which data will be obtained in order to generate the report. It may also be empty for item types like detailed agent view, alert report agent, custom graph, event report agent, import text from URL, SLA, SQL queries and text.  
* '''Period:''' The time period that it's going to receive in the specific moment the report is generated.
+
* '''Period:''' The time period based on which the report is generated.
* '''Description:''' The column which displays the description you've given the item in order to render the work with it a little easier.
+
* '''Description:''' The column displaying the description given to the item in order to make the work with it a little easier.
* '''Options:''' The column which displays the buttons and icons to edit or to delete it.
+
* '''Options:''' The column that displays the buttons and icons to edit or to delete it.
  
==== The 'Item Editor' Tab ====
+
==== Item Editor tab ====
  
The Item Editor tab is more complex than the others, because you'll be able to create the form items or to edit them by it. The form is dynamically designed, depending on the type of item you intend to create. In the editing process, all fields except the type are editable. If you e.g. need to change the type, the way to do it is to delete the current and to generate a new one along with a similar configuration.
+
Item Editor tab is more complex than the others, because there you will be able to create the form items or edit them. The form is dynamically designed, according to the type of item you intend to create. In the editing process, all fields except the type are editable. If you need to change the type, the way to do it is to delete the current one and generate a new one along with the same configuration.
  
 
The common fields for all types are the following:
 
The common fields for all types are the following:
  
* '''Type:''' The pop-up list containing the types of items intended for the report which determines the appropriate fields to configure this type of item by selecting the type: Agents, Modules, Agent Detailed View, Alert Report Agent, Alert Report Module, Avg. Value, Custom Graph, Event Report Agent, Event Report Module, Import text from URL, MTBF, MTTR, Max. Value, Min. Value, Monitor Report, SLA, SQL query, Serialized Data, Simple Graph, Summary, TTO, TTRT and Text
+
* '''Type:''' Drop-down list containing the types of items intended for the report, which determines the appropriate fields to configure this type of item by selecting the type: Agents, Modules, Agent Detailed View, Alert Report Agent, Alert Report Module, Avg. Value, Custom Graph, Event Report Agent, Event Report Module, Import text from URL, MTBF, MTTR, Max. Value, Min. Value, Monitor Report, SLA, SQL query, Serialized Data, Simple Graph, Summary, TTO, TTRT and Text
  
* '''Description:''' The text box intended for a description of the reported item.
+
* '''Description:''' Text box intended for a description of the report item.
  
 
==== Types of Items ====
 
==== Types of Items ====
  
We can include different elements into out report, which can be:
+
You may add different items to the report, which can be:
  
 
===== Graph Items =====
 
===== Graph Items =====
Line 117: Line 116:
  
 
This form's fields are:
 
This form's fields are:
 +
* ''Name'': The following macros can be used:
 +
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in the report item.
 +
** _agentgroup_ : Agent group selected in the report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : Name of the module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 
* ''Period'': Time interval over which the report will be calculated (from the current point in time).
 
* ''Period'': Time interval over which the report will be calculated (from the current point in time).
* ''Agent'': Intelligent control to choose the agent for this item.
+
* ''Agent'': Intelligent control to choose the agent for that item.
 
* ''Module'': Drop-down list that is dynamically loaded with the modules of the agent selected in the previous control.
 
* ''Module'': Drop-down list that is dynamically loaded with the modules of the agent selected in the previous control.
* ''Time comparison (overlapped)'': shows you overlapped above the module graph in that time frame, for example if the graph shows a 1 month span, the overlapped graph above is the previous month.
+
* ''Time comparison (overlapped)'': It shows the module graph overlapped in that time range, for example if the graph shows a 1 month span, the overlapped graph over it is the previous month.
 +
* ''Label'': Label you can assign to an element. The following macros can be used: ''_agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.''
  
Excample of this type of report:
+
 
 +
Example of this type of report:
  
 
<center>
 
<center>
Line 129: Line 137:
 
<br><br>
 
<br><br>
  
====== Simple Baseline Graph ======
+
====== Simple baseline graph ======
  
By this type of graph, you're able to display future estimation values for the selected module. Let's assume for a moment you e.g. select a period of a week and today would be Tuesday, this particular graph provides real data from Monday through Tuesday and estimation values for all other days within the selected week.
+
With this type of graph, you may see future estimation values for the selected module.Suppose you select a period of a week and today is Tuesday, this particular graph provides real data from Monday through Tuesday and estimation values for all other days within the selected week.
  
 
<center>
 
<center>
Line 137: Line 145:
 
</center>
 
</center>
  
The fields pertaining to this particular form are the following:
+
The fields belonging to this particular form are the following:
 +
* '''Name''': The following macros can be used:
 +
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in the report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : Name of the module selected in report item.
 +
** _moduledescription_ : Description of the agent module selected in report item.
 +
* '''Period:''' Time interval on which the report is calculated (from now onwards).
 +
* '''Agent:''' Intelligent control for selecting the appropriate agent for this item.
 +
* '''Module:''' A drop-down list which is dynamically loaded with the agent's modules selected in the control above.
 +
* '''Label''': Label you can assign to an element. The following macros can be used: ''_agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.''
  
* '''Period:''' The time frame it takes to get back to the temporary point within which the report is generated.
 
* '''Agent:''' An intelligent control for selecting the appropriate agent for this item.
 
* '''Module:''' A drop-down list which is dynamically loaded by the agent's modules selected in the control above.
 
  
Within the HTML version of the report, an item of this type is generated as you can see below.
+
Example view of this type of report:
  
 
<center>
 
<center>
Line 150: Line 166:
  
  
{{warning|This type of graph has the potential to '''overload''' Pandora FMS if you're utilizing too much data to generate future estimations.}}
+
{{warning|This type of graph has the potential to '''overload''' Pandora FMS if you use too much data to generate future estimations.}}
  
====== The Custom Graph ======
+
====== Custom graph ======
  
It's a user-defined combined graph. A field is added with a combo to select the graph we intend to add.
+
It is a user-defined combined graph. A field is added with a combo to select the graph intended to add.
  
 
<center>
 
<center>
Line 161: Line 177:
  
 
The fields within this form are the following:
 
The fields within this form are the following:
 +
* '''Name''': The following macros can be used:
 +
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : Name of the module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* '''Period:''' The time interval on which the report is generated.
 +
* '''Custom Graph:''' A deployable list containing the user-defined graphs. In order to create theses graphs, click on ''Administration'' > ''Manage Reports'' > ''Graph Builder''.
  
* '''Period:''' The time frame it takes to get back to the temporary point within which the report is generated.
+
An example view of this type of report:
* '''Custom Graph:''' A deployable list containing the user-defined graphs. In order to create theses graphs, please click on 'Administration' -> 'Manage Reports'<br>and 'Graph Builder'.
 
 
 
Within the HTML version of the report, an item of this type is generated as you can see below.
 
  
 
<center>
 
<center>
Line 173: Line 195:
 
====== Graphs defined from SQL ======
 
====== Graphs defined from SQL ======
  
This type of report element allows custom graphs to be defined for use in reports. These graphs will be created using SQL code entered by the user. This SQL code should always return a variable called '''"label"'' for the text labels or name of the elements to be displayed and a field called '''"value"'' to store the numerical value to be represented. This is an example of SQL used to create graphs of this type:
+
This type of report element allows custom graphs to be defined for use in reports. These graphs will be created using SQL code entered by the user. This SQL code should always return a variable called '''"label"''' for the text labels or name of the elements to be displayed and a field called '''"value"''' to store the numerical value to be represented. This is an example of SQL used to create graphs of this type:
  
  SELECT a.nombre as `label`, count(st.id_agente_modulo) as `value`
+
  SELECT a.name as `label`, count(st.id_agente_modulo) as `value`
  FROM tagente_estado st, tagente a
+
  FROM tagent_status st, tagent to
  WHERE a.id_agente=st.id_agente AND (unix_timestamp(now()) - st.utimestamp) > st.current_interval * 2 group by 1;
+
  WHERE a.id_agent=st.id_agent AND (unix_timestamp(now()) - st.utimestamp) > st.current_interval * 2 group by 1;
  
In this example, we will display a graph in which we will show the number of modules in unknown status per agent. It's quite similar to an SQL query, but it doesn't use headers, and it just needs the SQL code:
+
For this example, there is this graph displayed where the number of modules in unknown status per agent is shown. It is quite similar to an SQL query, but it does not use headers, and it just needs the SQL code:
  
 
<center>
 
<center>
Line 187: Line 209:
  
  
These are some examples of each of the three types of graphs that can be drawn with this tool: pie graphs, vertical bar graphs and horizontal bar graphs. In this example several UTF (western latin, Japanese and Arabic) character sets are used simply to show the multi-language capabilities of Pandora FMS.
+
These are some examples of each of the three types of graphs that can be drawn with this tool: pie graphs, vertical bar graphs and horizontal bar graphs. In this example, several UTF (western latin, Japanese and Arabic) alphabet sets are used simply to show the multi-language capabilities of Pandora FMS.
  
{{warning|Due to security restrictions, there are some blocked words that cannot be used : *, DELETE, DROP, ALTER, MODIFY, password, pass, INSERT or UPDATE}}
+
{{warning|Due to security restrictions, there are some blocked words that cannot be used : *, DELETE, DROP, ALTER, MODIFY, password, pass, INSERT or UPDATE.}}
  
{{tip|This type of items must be handled with care, since they can overload Pandora FMS}}
+
{{tip|This type of items must be handled with care, since they can overload Pandora FMS.}}
  
 
====== SQL pie graph ======
 
====== SQL pie graph ======
  
Example of pie graph for reports based on SQL query
+
Example of pie graph for reports based on SQL query.
 
<center>
 
<center>
 
[[image:Report_piegraph.png]]
 
[[image:Report_piegraph.png]]
Line 203: Line 225:
 
====== SQL Vertical bar graph ======
 
====== SQL Vertical bar graph ======
  
Example of vertical bar graph for reports based on SQL query
+
Example of vertical bar graph for reports based on SQL query.
  
  
Line 213: Line 235:
 
====== SQL horizontal bar graph ======
 
====== SQL horizontal bar graph ======
  
Example of horizontal bar graph for reports based on SQL query
+
Example of horizontal bar graph for reports based on SQL query.
  
  
Line 227: Line 249:
 
It will indicate all the relevant information about the time that this module has been available.
 
It will indicate all the relevant information about the time that this module has been available.
  
We will be able to choose the time range of which we want the report (for example, the last month) and the ''working time'' if for example we need to indicate that we are only interested in the state of our module in a certain schedule (for example, 8x5, from 8:00 to 16:00 from Monday to Friday).
+
The time range you want the report about can be chosen (for example, the last month) and the ''working time'' if for example you need to indicate that you are only interested in the state of your module in a certain schedule (for example, 8x5, from 8:00 to 16:00 from Monday to Friday).
 +
 
 +
From Pandora FMS version 749, this kind of reports includes also the possibility of checking the box ''24x7'', which is under the ''working time''. This way, the information will be collected without taking into account the ''working time'' configuration and being able to compare both cases, since it will show us 2 independent graphs.
  
 
It is also possible to determine a prioritization mode. When choosing the OK prioritization mode, if data in the SLA compliance range overlap in time and some other state (such as a planned stop), it will paint that stretch green. If the unknown prioritization mode option is chosen, the color corresponding to the other state will always be displayed.
 
It is also possible to determine a prioritization mode. When choosing the OK prioritization mode, if data in the SLA compliance range overlap in time and some other state (such as a planned stop), it will paint that stretch green. If the unknown prioritization mode option is chosen, the color corresponding to the other state will always be displayed.
Line 234: Line 258:
  
  
After saving the report element data, we'll add the modules we want at the bottom:
+
After saving the report element data, add the desired modules at the bottom:
  
 
[[File:availability_builder_item.png]]
 
[[File:availability_builder_item.png]]
  
<b>Note:</b> you can use the SLA min. and max. (value) to indicate that the calculations are made in relation to the values reached by the module in that range. SLA limit % will indicate the acceptable minimum (within that range).
+
<b>Note:</b> You can use the SLA min. and max. (value) to indicate that the calculations are made in relation to the values reached by the module in that range. SLA limit % will indicate the acceptable minimum (within that range).
  
By default, if you do not specify a minimum or maximum for the value, the values of thresholds defined in the module (dynamic limits) will be used.
+
If you do not specify a minimum or maximum for the value, the values of thresholds defined in the module (dynamic limits) will be used by default.
  
  
Displaying the report we will see the availability graph of the chosen module in the selected time range:
+
Viewing the report, you will see the availability graph of the chosen module in the selected time range:
  
  
 
[[File:availability_graph.png]]
 
[[File:availability_graph.png]]
 +
 +
'''Failover mode'''
 +
 +
This feature is used to assign failover or backup modules to the main module on which the calculation of availability must be made. That is to say, if a module has one or several failover modules assigned, the calculation of availability for a determined period will be done considering these modules.
 +
 +
When the measured main module falls, if there are one or several operative backup modules, these will be taken into account for the SLA calculation. That way it shows only the real service failure where primary and backups do not work.
 +
<br>
 +
<br>
 +
<br>
 +
'''How to add failover or backup modules:'''
 +
 +
It is done in the edition of the module on which the calculation of availability must be made, in the '''Module relations''' section:
 +
 +
[[File:Failover1.png]]
 +
 +
Select the module that will work as failover and select the type of relation that in this case is failover type.
 +
 +
Once the modules are assigned in the report, activate the option "failover mode":
 +
 +
[[File:Failover2.png]]
 +
 +
There are two types of visual representation:
 +
 +
* Normal: It will show the graph of the main module, as well as all its failover or backup modules and the graph result.
 +
 +
[[File:Failover3.png]]
 +
 +
* Simple: It will only show a graph that will be the result of the availability calculation of these modules.
 +
 +
[[File:Failover4.png]]
 +
 +
In the '''simple''' type "availability graph" reports, add the possibility of adding a failover module directly to the report as a simulation, this will work exactly the same as the previous ones.
 +
 +
{{Warning|This is not applicable in the wizard or in the template reports.}}
 +
 +
[[File:Failover5.png]]
  
 
====== Module Histogram graph ======
 
====== Module Histogram graph ======
Line 256: Line 316:
 
[[File:histogram_build.png]]
 
[[File:histogram_build.png]]
  
Visualization example:
+
Display example:
  
 
[[File:histogram_sample.png]]
 
[[File:histogram_sample.png]]
 
<br>
 
<br>
  
===== SLA Items =====
+
===== SLA items=====
  
All SLA reports show information about the fulfillment of a metric, that is, they indicate us the percentage of time that the module has had a known valid value.
+
All SLA reports show information about the fulfillment of a metric, that is, they indicate the percentage of time that the module has had a known valid value.
  
All SLAs understand as valid the <b> unknown </b> periods, since Pandora cannot guarantee the module status if it does not have module data. Also all periods in <b> planned stop </b> are considered valid (since being in a planned stop situation we assume that the module situation is controlled and accepted) and periods in <b> warning status </b> (the ''service'' is still provided in a non-optimal state).
+
All SLAs understand as valid the <b> unknown </b> periods, since Pandora cannot guarantee the module status if it does not have module data. Also, all periods in <b> planned stop </b> are considered valid (since in a planned stop situation, it is assumed that the module situation is controlled and accepted) and periods in <b> warning status </b> (the ''service'' is still provided in a non-optimal state).
  
As will be seen later, some of the SLA reports present data grouped by time periods and the general status of these periods is calculated. When dealing with long periods, the module of which the report is being made may have gone through many states: go to unknown, go through a planned stop ... In these reports, there is a configuration parameter called <b>prioritization mode </b> that determines which states have preference when summarizing. You have two options:
+
As it will be seen later, some of the SLA reports present data grouped by time periods and the general status of these periods is calculated. When dealing with long periods, the module the report is being made on may have gone through many states: unknown, planned stop... In these reports, there is a configuration parameter called <b>prioritization mode </b> that determines which states have preference when summarizing. There are two options:
  
 
* '''OK prioritization mode''': The SLA compliance value prevails over the report non-run time, planned shutdowns, unknown time, and not started time.
 
* '''OK prioritization mode''': The SLA compliance value prevails over the report non-run time, planned shutdowns, unknown time, and not started time.
  
* '''Unknown prioritization mode''': Any value other than OK will prevail. In this way, you will see the non-operation times of the report, planned stops, unknown time and not started even if there is some data that makes the SLA comply.
+
* '''Unknown prioritization mode''': Any value other than OK will prevail. That way, you will see the non-operation times of the report, planned stops, unknown time and not started even if there is some data that makes the SLA comply.
  
 
Of course, if at any time the SLA compliance value is not reached, it will be painted red in any of the modes.
 
Of course, if at any time the SLA compliance value is not reached, it will be painted red in any of the modes.
Line 277: Line 337:
 
====== SLA ======
 
====== SLA ======
  
It allows you to measure the [http://en.wikipedia.org/wiki/Service-level_agreement '''SLA'''] (Service Level Agreement) of any monitor of Pandora FMS.
+
It allows you to measure the Service Level Agreement of any Pandora FMS monitor.
  
 
<center>
 
<center>
Line 283: Line 343:
 
</center>
 
</center>
  
The fields pertaining to this particular form are the following:
+
The fields belonging to this particular form are the following:
 +
* '''Name''': The following macros can be used:
 +
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : Name of the agent module selected in report item.
 +
** _moduledescription_ : Description of the agent module selected in report item.
 +
* '''Period:''' The time frame on which the report is generated (from the present time).
 +
* '''Working time''': The time frame during which the SLA will be working. The graph will be fully shown, but it will only be calculated with the data within said working time frame. The SLA will be unknown (N/A) if the interval to be shown is excluded from the work interval. From Pandora FMS version 749, this kind of reports includes also the possibility of checking the box ''24x7'', which is under the ''working time''. This way, the information will be collected without taking into account the ''working time'' configuration and being able to compare both cases, since it will show us 2 independent graphs.
 +
* '''Show graph, table or both''': Select whether a SLA graph, a status summary or both elements will be shown.
 +
* '''Order''': Order SLA items according to the chosen criteria.
 +
 
 +
Once these options have been selected, add each of the target modules based on which the SLA must be calculated:
  
* '''Period:''' The time frame it takes to get back to the temporary point within which the report is generated.
+
<center>
* '''Working time''': The time frame during which the SLA will be functioning. The graph will be shown as is, but will only be calculated with the data within said working time frame. The S.L.A will appear as unknown (N/A) if the interval to be shown is excluded from the work interval.
+
[[image:availability_builder_item.png]]
 +
</center>
 
* '''Agent:''' A combo box intended to select the agent to use in the SLA.
 
* '''Agent:''' A combo box intended to select the agent to use in the SLA.
 
* '''Module:''' A combo box intended to select the module to use in the SLA.
 
* '''Module:''' A combo box intended to select the module to use in the SLA.
* '''SLA min (value):''' A field intended to determine the SLA's minimum value. The minimum values are going to trigger the SLA.
+
* '''SLA min (value):''' A field intended to determine the SLA's minimum value. The minimum values will trigger the SLA. This field can be empty to use the acceptable minimum module normal values.
* '''SLA max (value):''' A field intended to determine the SLA's maximum value. The maximum values are also going to trigger the SLA.
+
* '''SLA max (value):''' An optional field intended to determine the SLA's maximum value. The maximum values will also trigger the SLA. It can be empty to use the acceptable maximum module normal values.
* '''SLA Limit (%):''' A field intended to set the time percentage which is going to trigger the SLA. If the module has been within the minimum and maximum limit values during this particular time percentage, the SLA will be shown as right and as wrong if not.
+
* '''SLA Limit (%):''' A field intended to set the correct time percentage for the SLA. If the module has been within the minimum and maximum limit values during this particular time percentage, the SLA will be shown as correct and as wrong if not.
 +
 
 +
It is also possible to add new modules to the SLA to create combined-module SLAs from the same or different systems.
 +
 
 +
 
 +
{{Warning|In case of combined SLAs, SLA compliance will depend '''heavily''' on the performance of all the SLAs configured so far.}}
 +
 
 +
The SLA value will take into account only the <b>critical status of the selected module</b> and they will be labeled as valid.
  
It's also possible to add new modules to the SLA to create combined module-SLAs from the same or different systems.
+
* Time in unknown.
 +
* Time in scheduled downtime
 +
* Time in warning status.
 +
* Time in OK status.
  
 +
''Why accept unknowns? ''
  
{{Warning|In case of combined SLAs, the SLA performance is going to depend '''heavily''' on the performance of all the SLAs configured so far.}}
+
Unknown status is reached when Pandora FMS does not receive information from a certain target. In this situation, Pandora FMS cannot guarantee whether the service was provided as usual or not, so in the face of an unknown it is accepted.
  
We can set planned downtimes (future or past) to be taken into consideration when the calculation of the SLA report, misestimating any falls that occur in this interval. It will OK value in all intervals affected by the planned shutdown, as if in this interval there were no critical situations.
+
 
 +
 
 +
When taking into account the SLA calculation shown in the report, you may configure scheduled downtimes (past or future) so that it does not take into account possible failures that could possibly take place during that interval of the scheduled downtimes. The value it will take in all the intervals where the scheduled downtimes is enabled is OK, as if during that intervals no incorrect data was received.  
  
 
<center>
 
<center>
Line 304: Line 391:
 
</center>
 
</center>
  
In this example we can see it better, In the first image we can see a module data history with two interval in critical status. Without scheduled downtime the SLA value is 93%.
+
In this example it can be seen better. In the first image, there is a module data history with two intervals in critical status. Without scheduled downtime the SLA value is 93%.
  
 
<center>
 
<center>
Line 310: Line 397:
 
</center>
 
</center>
  
If we add a scheduled downtime covering the first drop, because it was caused by external problems, the final estimation will be calculated as in all scheduled downtime  interval the value is OK
+
After seeing that the first module downfall was due to external problems, ta scheduled task that covers that interval is added. When adding the scheduled task, the final estimation will take it as if the module's status was correct all along.
  
 
<center>
 
<center>
 
[[image: SLA_consch.png]]
 
[[image: SLA_consch.png]]
 
</center>
 
</center>
 +
 +
 +
<b>Note:</b> If you forgot to create a scheduled downtime, you can create past scheduled downtimes given that''the console administrator has enabled it''.
 +
 +
<br>
  
 
====== Monthly SLA ======
 
====== Monthly SLA ======
  
This feature is only available to Enterprise Versions of Pandora FMS. It's a variation of the [http://en.wikipedia.org/wiki/Service-level_agreement '''SLA'''] feature. Instead of measuring the service level periodically, it's going to conduct it on every day of the months contained in this period.
+
This feature is only available for Pandora FMS Enterprise versions. It is a variation of the '''SLA''' feature. Instead of measuring the service level periodically, it does it every day during the months in this period.
  
 
Examples:  
 
Examples:  
* In a report of the May 5, it's going to calculate the SLA of every day in May.
+
* In a report of May 5th, it will calculate the SLA of every day in May.
* In a report between February 13 and April 4, it's going to calculate the SLA of every day in February, March and April.
+
* In a report between February 13th and April 4th, it will calculate the SLA of every day in February, March and April.
  
Each module on each month is going to contain the same data of a standard SLA, except that its compliance won't be the month's level. It will be the percentage of days that accomplish it. There is also a bar that's going to display all days of the month by the following color code:
+
Each module on each month will contain the same data of a standard SLA, except that its compliance will not be at month level. It will be the percentage of days that accomplish it. There is also a bar that will display all days of the month by the following color code:
  
* '''Green:''' The SLA was accomplished.
+
* '''Green:''' The SLA met.
* '''Red:''' The SLA wasn't accomplished.
+
* '''Red:''' The SLA met.
* '''Gray:''' Unknown. There is insufficient data on this day.
+
* '''Gray:''' Unknown. There is not enough data on that day.
 
<br>
 
<br>
{{tip|Days in unknown will be taken into account as valid data for the percentage of days that meet the SLA}}
+
{{tip|Days in unknown will be taken into account as valid data for the percentage of days that meet the SLA.}}
  
If there are days which don't accomplish the SLA they will be put in a summary table.
+
If there are days that do not meet the SLA, they will be detailed in a summary table.
  
 
<center>
 
<center>
 
[[image: S.L.A. Monthly - view.png|600px]]
 
[[image: S.L.A. Monthly - view.png|600px]]
 
</center>
 
</center>
 
On the picture above, we observe a monthly SLA for two modules. The first one passes 100% of the days with data, and the second one doesn't in 3 out of 22 days. That gives us an accomplishment of 86.36%. For day 23 there is no data, because it's the current date. These days are not going to affect the calculations.
 
 
<br>
 
{{tip|The periods in which a planned downtime affects the measured element aren't taken into account. If this happen, the planned downtimes will appear in a special table.}}
 
  
 
====== Weekly SLA ======
 
====== Weekly SLA ======
  
Displays the SLA of the modules chosen by weeks along the selected period (by default current month).
+
It displays the SLA of the modules chosen by weeks along the selected period (current month by default).
  
 
[[image: sla_weekly.png]]
 
[[image: sla_weekly.png]]
  
  
Allows us to edit the working time in case we have a custom service schedule (e.g. 8x5)
+
It allows to edit the working time in case you have a custom service schedule (e.g. 8x5)
  
At the bottom we can add multiple modules to this item.
+
At the bottom, you may add multiple modules to this item.
  
Example of visualization:
+
View example:
  
 
[[image: sla_weekly_sample.png]]
 
[[image: sla_weekly_sample.png]]
  
====== SLA Hourly ======
+
====== Hourly SLA ======
  
Displays the SLA of the modules chosen by hours along the selected period (by default current month).
+
It displays the SLA of the modules chosen by hour along the selected period (current month by default).
  
 
[[image: sla_hourly.png]]
 
[[image: sla_hourly.png]]
  
  
Allows us to edit the working time in case we have a custom service schedule (e.g. 8x5)
+
It allows to edit the working time in case you have a custom service schedule (e.g. 8x5)
  
At the bottom we can add multiple modules to this item.
+
At the bottom, you may add multiple modules to this item.
  
Example of visualization:
+
View example:
  
 
[[image: sla_hourly_sample.png]]
 
[[image: sla_hourly_sample.png]]
  
 
====== Service SLA ======
 
====== Service SLA ======
It allows you to measure the [http://en.wikipedia.org/wiki/Service-level_agreement '''SLA'''] (Service Level Agreement) of any service created in Pandora FMS
+
It allows to measure the Service Level Agreement of any service created in Pandora FMS
  
 
<center>
 
<center>
Line 380: Line 467:
 
</center>
 
</center>
  
The fields pertaining to this particular form are the following:
+
The fields found in this particular form are the following:
* Period: The time frame it takes to get back to the temporary point within which the report is generated.
+
* Name: The following macros can be used:
* Working Time: Time to be taken into account for the SLA calculation.
+
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : Name of the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* Period: Time frame based on which the the report will be evaluated from the present time backwards.
 +
* Working Time: Time to be taken into account for the SLA calculation (e.g. for working schedules like 8x5).
 +
 
 +
Since Pandora FMS services come with their own SLA readings, calculations for the report are different according to the standard performance.
  
This form is different from the calculation of normal SLA. In this case only we will allow us to choose the service they want to show in which there created. The SLA limit will be extracted directly from the service configuration.
+
In this case, you may only choose the service whose SLA you wish to receive from those services you have configured in your Pandora FMS console. The SLA validity limit values are recovered automatically from the definition of the service itself.
  
 
<center>
 
<center>
Line 390: Line 486:
 
</center>
 
</center>
  
We can set planned downtimes (future or past) to be taken into consideration when the calculation of the SLA report, misestimating any falls that occur in this interval. These scheduled downtimes may be assigned to the modules it depends on the service selected, or inferior services. In all intervals in which there is configured planned downtimes, states has been within that service will not be taken into account that period for the calculation of the SLA is ignored.
+
You can always set planned downtimes to adjust the compliance levels whenever you need so, so that possible downfalls are not taken into account.  
 +
 
 +
These scheduled downtimes may be assigned to the modules that make the service whose report you wish to obtain, or its sub-services. In all intervals affected by downtimes, the states that the service could have reached will be overlooked, and that period will not be taken into account for the the final SLA calculation.
  
In this example, we can see a schema of final En este ejemplo podemos observar an outline of the final calculation of the service depending on the planned stops (white) and the critical states (red) of the modules of which depends on the state of the final service for SLA calculation. Looking at the image when any of the modules have a downtime directly affects the final service and this interval is omitted for final calculation.
 
  
 
<center>
 
<center>
 
[[image: S.L.A_total.png|600px]]
 
[[image: S.L.A_total.png|600px]]
 
</center>
 
</center>
 +
 +
In this example, you can see an outline of the final calculation of the service, depending on the scheduled downtimes (orange) and the critical states (red) of the modules on which the state of the final service for SLA calculation depends.
 +
 +
Looking at the image, when any of the modules have a downtime that directly affects the final service and this interval is omitted for final calculation.
  
 
===== Prediction Items =====
 
===== Prediction Items =====
 
====== Prediction Date ======
 
====== Prediction Date ======
  
This type of item returns a date in the future in which a module reaches its interval. It utilizes the [http://en.wikipedia.org/wiki/Least_squares '''Least Squares Method'''] like the projection graph.
+
This type of item returns the date when module reaches its interval using a data projection of a module to the future.  
  
<center>
+
To do the calculations, the [http://en.wikipedia.org/wiki/Least_squares '''Least Squares Method'''] is used.
[[image: Projection_graph3.png|800px]]
 
</center>
 
  
 
In order to configure this item, you're required to provide the information shown below.
 
In order to configure this item, you're required to provide the information shown below.
 +
 +
To configure this type of item, the following data must be provided:
 +
* '''Name''': The following macros can be used:
 +
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : Name of the module name selected in report item.
 +
** _moduledescription_ : Description of the module that you selected in report item.
 +
* '''Period''': The time period that wors as basis for the estimation.
 +
* '''Data Range:''' The interval where module data must be to return the date.
 +
* '''Label''': Label the element can be assigned. The following macros can be used: ''_agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.''
 +
 +
For instance, to check the moment a disk usage value between 60 and 100% for the mounting point /var will be reached, the following definition is used.
  
 
<center>
 
<center>
[[image: Projection_graph5.png|800px]]
+
[[image: Projection_graph5.png|750px]]
 
</center>
 
</center>
 +
<br><br>
  
* '''Period''': The relevant time frame for estimation creation.
 
* '''Data Range:''' The interval the module requires to return the associated date.
 
  
Example: Just assume for a moment you would have taken the module named 'FreeDisk_SpoolDir', picked '15 days' as a time frame and searched for the date on which the module would reach its interval [3200-0]. The result would have been '03 Nov 2013 19:07:18'. Please take a look on the picture below to get a graphical explanation.
+
That will generate the following output in this case:
  
 
<center>
 
<center>
[[image: Prediction_date.png|800px]]
+
[[image: Projection_graph3.png]]
 
</center>
 
</center>
 +
 +
<br>
  
 
====== Projection Graph ======
 
====== Projection Graph ======
  
This type of graph is going to project a future estimation of the module's data. This estimation is based on [http://en.wikipedia.org/wiki/Linear_regression '''Linear Regression'''] and is implemented by means of the [http://en.wikipedia.org/wiki/Least_squares '''Least Squares Method'''].
+
This type of allows to asses the values a module will take in the future.
 +
 
 +
This estimation is based on [http://en.wikipedia.org/wiki/Linear_regression '''Linear Regression'''] and is implemented by means of the [http://en.wikipedia.org/wiki/Least_squares '''Least Squares Method'''].
 +
 
 +
Configure the following parameters accurately to get relevant results:
 +
The fields in this form are:
 +
* '''Name''': The following macros can be used:
 +
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : Module name that you selected in report item.
 +
** _moduledescription_ : Description of the agent module selected in report item.
 +
* '''Period:''' The time period taken as basis for the estimation.
 +
* '''Projection Period:''' The future time period where data will be projected.
 +
* '''Label:''' Label you can assign to an element. The following macros can be used: ''_agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.''
  
 
<center>
 
<center>
[[image: Projection_graphs.png|800px]]
+
[[image: Projection_graph_periods.png|800px]]
 
</center>
 
</center>
  
In order to configure this graph, you're required to provide the following information:
+
In the example image, the area name ''period'' represents the evolution of module data during the selected time interval.
 +
 
 +
On the other hand, ''projection period'' shows the possible evolution of the module along the selected time.
 +
 
 +
A definition example, complementary to the previous case is the evolution of the usage of the disk mounted on /var.
  
 
<center>
 
<center>
[[image: Projection_graph6.png|800px]]
+
[[image: Projection_graph6.png|750px]]
 
</center>
 
</center>
  
* '''Period:''' The relevant time frame for the estimation.
+
 
* '''Projection Period:''' The relevant time frame in the future for which the module data is going to be used to create the projection.
+
Obtaining the following results:
  
 
<center>
 
<center>
[[image: Projection_graph_periods.png|800px]]
+
[[image: Projection_graphs.png|750px]]
 
</center>
 
</center>
  
Line 446: Line 579:
 
====== Avg. Value ======
 
====== Avg. Value ======
  
It's the average value for a module within a predefined period. This period is calculated in the moment of visualizing the report. Within the configuration menu, the fields for the source agent are added, where the agent and modules are selected. Subsequently, the module's average value is shown.
+
It is the average value for a module within a predefined period. This period is calculated when viewing the report. Within the configuration menu, the fields for the Source Agent are added, where the agent and modules are selected. Eventually, the module's average value is shown.
  
 
<center>
 
<center>
Line 453: Line 586:
  
 
The fields pertaining to this particular form are the following:
 
The fields pertaining to this particular form are the following:
 +
* '''Name''': The following macros can be used:
 +
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : Name of the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* '''Period:''' The time period takes backwards from the time point when the report is generated.
 +
* '''Agent:''' The intelligent control to choose the appropriate agent for this item.
 +
* '''Module:''' A drop-down list which is dynamically loaded with the agent's modules selected in the previous control.
 +
* '''Calculate for custom intervals''': It shows the average data in custom intervals.
 +
* '''Table / Graph options''': Show table, graph or both.
 +
* '''Label:''' Label that can be assign to an element. The following macros can be used: ''_agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.''
  
* '''Period:''' The time frame it takes to get back to the temporary point within which the report is generated.
+
Within the HTML version of the report, an item of this type is generated as seen below.
* '''Agent:''' The intelligent control to select the appropriate agent for this item.
 
* '''Module:''' A list which is dynamically loaded by the agent's modules selected in the control above.
 
 
 
Within the HTML version of the report, an item of this type is generated as you can see below.
 
  
 
<center>
 
<center>
Line 466: Line 608:
 
====== Max. Value ======
 
====== Max. Value ======
  
It's the maximum value of a module within a predefined period. This period is calculated in the moment of the report's viewing.
+
It is the maximum value of a module within a predefined period. This period is calculated at the moment of the report's viewing.
 
 
 
<center>
 
<center>
Line 472: Line 614:
 
</center>
 
</center>
  
The fields pertaining to this particular form are the following:
+
The fields of this particular form are the following:
 
+
* '''Name''': The following macros can be used:
* '''Period:''' The time frame it takes to get back to the temporary point within which the report is generated.
+
** _agent_ : Name of the agent selected in report item.
* '''Agent:''' An intelligent control for selecting the appropriate agent for this item.
+
** _agentdescription_ : Description of the agent selected in report item.
* '''Module:''' A deployable list which is dynamically loaded by the agent's modules selected in the control above.
+
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent that you selected in report item.
 +
** _module_ : Name of the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* '''Period:''' The time frame taken backwards from the time point when the report is generated.
 +
* '''Agent:''' An intelligent control for selecting the appropriate agent for the item.
 +
* '''Module:''' A deployable list dynamically loaded with the agent's modules selected in the previous control.
 +
* '''Calculate for custom intervals''': It enables the possibility of showing the report in multiple sub-intervals.
 +
* '''Time lapse intervals''': Lifespan of each sub-interval.
 +
* '''Table | graph | both''': Show data of each value of each sub-interval on a graph or a table or both.
 +
* '''Label:''' Label an element can be assigned. The following macros can be used: ''_agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.''
  
Within the HTML version of the report, an item of this type is generated as you can see below.
+
Viewing example:
  
 
<center>
 
<center>
 
[[image:pre29.png|800px]]
 
[[image:pre29.png|800px]]
 
</center>
 
</center>
 +
 
====== Min. Value ======
 
====== Min. Value ======
  
It's the minimum value of a module within a predefined period. This period is calculated in the moment of the report's viewing.
+
The minimum value of a module within a predefined period. This period is calculated right when the report is seen.
  
 
<center>
 
<center>
Line 491: Line 644:
 
</center>
 
</center>
  
The fields pertaining to this particular form are the following:  
+
The fields belonging to this particular form are the following:  
 
+
* '''Name''': The following macros can be used:
* '''Period:''' The time frame it takes to get back to the temporary point within which the report is generated.
+
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in the report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : Name of the agent module selected in report item.
 +
** _moduledescription_ : Description of the agent module selected in report item.
 +
* '''Period:''' Time interval taken based on which the report is calculated (from the present moment).
 
* '''Agent:''' An intelligent control for selecting the appropriate agent for this item.
 
* '''Agent:''' An intelligent control for selecting the appropriate agent for this item.
* '''Module:''' A deployable list which is dynamically loaded by the agent's modules selected in the control above.
+
* '''Module:''' Drop-down list which is dynamically loaded by the agent's modules selected in the previous control.
* '''Calculate for custom intervals''': Habilita la posibilidad de mostrar el informe en múltiples sub intervalos.
+
* '''Calculate for custom intervals''': It enables the possibility of showing the report in multiple sub-intervals.
* '''Time lapse intervals''': Duración de cada sub intervalo.
+
* '''Time lapse intervals''': Lifespan of each sub-interval.
* '''Table | graph | both''': Mostrar los datos de cada valor de cada sub intervalo en una tabla o una gráfica o ambos elementos.
+
* '''Table | graph | both''': Show the data od each sub-interval on a table, a graph or both.
 +
* '''Label:''' Label an element can be assigned. The following macros can be used: ''_agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.''
  
Within the HTML version of the report, an item of this type is generated as you can see below.
+
Viewing example:
  
 
<center>
 
<center>
Line 508: Line 668:
 
====== Monitor Report ======
 
====== Monitor Report ======
  
It shows the percentage of time a module has been right or wrong within a predefined period.
+
It shows the time percentage a module has been correct or incorrect within a predefined period.
  
 
<center>
 
<center>
Line 515: Line 675:
  
 
The fields pertaining to this particular form are the following:
 
The fields pertaining to this particular form are the following:
 
+
* '''Name''': The following macros can be used:
* '''Period:''' The time frame it takes to get back to the temporary point within which the report is generated.
+
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in the report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : Name of the agent module selected in report item.
 +
** _moduledescription_ : Description of the agent module selected in report item.
 +
* '''Period:''' Time interval taken based on which the report is calculated (from the present moment).
 
* '''Agent:''' An intelligent control for selecting the appropriate agent for this item.
 
* '''Agent:''' An intelligent control for selecting the appropriate agent for this item.
* '''Module:''' A deployable list which is dynamically loaded by the agent's modules selected in the control above.
+
* '''Module:''' Drop-down list which is dynamically loaded by the agent's modules selected in the previous control.
 +
* '''Calculate for custom intervals''': It enables the possibility of showing the report in multiple sub-intervals.
 +
* '''Time lapse intervals''': Lifespan of each sub-interval.
 +
* '''Table | graph | both''': Show the data od each sub-interval on a table, a graph or both.
 +
* '''Label:''' Label an element can be assigned. The following macros can be used: ''_agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.''
  
 
Within the HTML version of the report, an item of this type is generated as you can see below.
 
Within the HTML version of the report, an item of this type is generated as you can see below.
Line 526: Line 696:
 
</center>
 
</center>
  
====== Serializing Data ======
+
====== Serialize Data ======
  
It displays an item in the table format report from the data stored within the table named 'tagente_datos_stringin' the Pandora FMS Database. For it, the agent should serialize the data separating them with a line-separating character and another which separates the fields. All lines should contain all fields. This type of item is e.g. used for the agent which is designed to extract management data from the [http://en.wikipedia.org/wiki/SAP_AG '''SAP Platform'''].
+
It displays an item in table format report from the data stored within the table named 'tagente_datos_stringin' the Pandora FMS Database. For it, the agent should serialize the data separating them with a line-separating character and another which separates the fields. All lines should contain all fields. This type of item is e.g. used for the agent which is designed to extract management data from the [http://en.wikipedia.org/wiki/SAP_AG '''SAP Platform'''].
  
 
<center>
 
<center>
Line 535: Line 705:
  
 
The fields pertaining to this particular form are the following:
 
The fields pertaining to this particular form are the following:
 
+
* '''Name''': The following macros can be used:
* '''Period:''' The time frame it takes to get back to the temporary point within which the report is generated.
+
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in the report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : Name of the agent module selected in report item.
 +
** _moduledescription_ : Description of the agent module selected in report item.
 +
* '''Period:''' Time interval taken based on which the report is calculated (from the present moment).
 
* '''Agent:''' An intelligent control for selecting the appropriate agent for this item.
 
* '''Agent:''' An intelligent control for selecting the appropriate agent for this item.
* '''Module:''' A drop-down list which is dynamically loaded by the agent's modules selected in the control above.
+
* '''Module:''' Drop-down list which is dynamically loaded by the agent's modules selected in the previous control.
* '''Serialized Header:''' A text field intended to define the table headers which are going to be shown in the report, separated by the '|' (pipe) character. Each column is going to be shown as a result within the SQL query.  
+
* '''Serialized Header:''' A text field where the table headers shown in the report are separated by the '|' (pipe) character. There is one for each column created when separating the assembled field.  
 
* '''Field Separator:''' A separator intended for different fields within the serialized text chain.
 
* '''Field Separator:''' A separator intended for different fields within the serialized text chain.
* '''Line Separator:''' A separator intended for different lines (composed by fields) of the serialized text chain.
+
* '''Line Separator:''' A separator intended for different lines (made up by different fields) of the serialized text strings.
 +
* '''Label:''' Label assigned to an element. The following macros can be used: ''_agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.''
 +
 
 +
 
 +
 
 +
The module that generates the following report returns lines with the following contento:
 +
 
 +
Some text sample|some value#this is a new row|and another value
 +
 
 +
When generating a report from that content, the output is the following:
 +
<center>
 +
[[image: serialize_sample.png|650px]]
 +
</center>
 +
<br>
  
 
====== Summatory ======
 
====== Summatory ======
  
It displays a '''summation''' of a single module's values within a specific time frame.
+
It displays the '''sum''' of a single module's values within a specific time frame.
  
 
<center>
 
<center>
Line 551: Line 740:
 
</center>
 
</center>
  
* '''Period:''' The time frame it takes to get back to the temporary point within which the report is generated.
+
The fields of this form are:
 +
* '''Name''': The following macros can be used:
 +
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in the report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : Name of the agent module selected in report item.
 +
** _moduledescription_ : Description of the agent module selected in report item.
 +
* '''Period:''' Time interval taken based on which the report is calculated (from the present moment).
 
* '''Agent:''' An intelligent control for selecting the appropriate agent for this item.
 
* '''Agent:''' An intelligent control for selecting the appropriate agent for this item.
* '''Module:''' A drop-down list which is dynamically loaded by the agent's modules selected in the control above.
+
* '''Module:''' Drop-down list which is dynamically loaded by the agent's modules selected in the previous control.
 +
* '''Label:''' Label an element can be assigned. The following macros can be used: ''_agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.''
 +
 
 +
This is a display example:
  
Within the HTML version of the report, an item of this type is generated as you can see below.
 
  
 
<center>
 
<center>
 
[[image:pre40.png|800px]]
 
[[image:pre40.png|800px]]
 
</center>
 
</center>
 
  
 
====== Historical Data ======
 
====== Historical Data ======
  
This type of element will serve to receive a dump of the stored data of the module that we indicate in the configuration of the report.
+
This type of element will serve to receive a dump of the stored data of the module indicated in the configuration of the report.
  
We will configure the following fields:
+
Configure the following fields:
 
+
* '''Name''': The following macros can be used:
* '''Period''': Interval of time on which the report will be calculated (from the current moment).
+
** _agent_ : Name of the agent selected in report item.
* '''Agent''': the intelligent control to choose the agent for this item.
+
** _agentdescription_ : Description of the agent selected in report item.
* '''Module''': drop-down list that is dynamically loaded with the modules of the agent selected in the previous control.
+
** _agentgroup_ : Group of the agent selected in the report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : Name of the agent module selected in report item.
 +
** _moduledescription_ : Description of the agent module selected in report item.
 +
* '''Period:''' Time interval taken based on which the report is calculated (from the present moment).
 +
* '''Agent:''' An intelligent control for selecting the appropriate agent for this item.
 +
* '''Module:''' Drop-down list which is dynamically loaded by the agent's modules selected in the previous control.
 +
* '''Label:''' Label an element can be assigned. The following macros can be used: ''_agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.''
  
 
<center>
 
<center>
Line 584: Line 789:
 
====== Increment ======
 
====== Increment ======
  
We will use this type of report element to show a brief analysis in which we will indicate the variation in value of the indicated module.
+
This type of report element is used to show a brief analysis where the value variation of the indicated module is detailed.
  
We will configure the following fields:
+
Configure the following fields:
 
+
* '''Name''': The following macros can be used:
* '''Period''': Interval of time on which the report will be calculated (from the current moment).
+
** _agent_ : Name of the agent selected in report item.
* '''Agent''': the intelligent control to choose the agent for this item.
+
** _agentdescription_ : Description of the agent selected in report item.
* '''Module''': drop-down list that is dynamically loaded with the modules of the agent selected in the previous control.
+
** _agentgroup_ : Group of the agent selected in the report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : Name of the agent module selected in report item.
 +
** _moduledescription_ : Description of the agent module selected in report item.
 +
* '''Period:''' Time interval taken based on which the report is calculated (from the present moment).
 +
* '''Agent:''' An intelligent control for selecting the appropriate agent for this item.
 +
* '''Module:''' Drop-down list which is dynamically loaded by the agent's modules selected in the previous control.
  
 
<center>
 
<center>
Line 600: Line 811:
 
<center>
 
<center>
 
[[image:increment_sample.png]]
 
[[image:increment_sample.png]]
 +
</center>
 +
 +
====== Last Value ======
 +
 +
It is the last value for a module within a predefined period. This period is calculated when viewing the report. Within the configuration menu, the fields for the Source Agent are added, where the agent and modules are selected. Eventually, the module's last value is shown.
 +
 +
The fields pertaining to this particular form are the following:
 +
* '''Name''': The following macros can be used:
 +
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : Name of the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* '''Agent:''' The intelligent control to choose the appropriate agent for this item.
 +
* '''Module:''' A drop-down list which is dynamically loaded with the agent's modules selected in the previous control.
 +
* '''Show item in landscape format {only PDF}''': allow to display the report in landscape format only in PDF.
 +
* '''Page break at the end of the item {only PDF}''': generate a page break at the end of the element in PDF only.
 +
 +
Within the HTML version of the report, an item of this type is generated as seen below.
 +
 +
<center>
 +
[[image:LastValueReport.png|800px]]
 
</center>
 
</center>
  
Line 608: Line 842:
  
 
We will configure the following fields:
 
We will configure the following fields:
 
+
* '''Name''': The following macros can be used:
 +
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in the report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : Name of the agent module selected in report item.
 +
** _moduledescription_ : Description of the agent module selected in report item.
 
* '''Time lapse''': Interval of time on which the report will be calculated (from the current moment).
 
* '''Time lapse''': Interval of time on which the report will be calculated (from the current moment).
 
* '''Last value''': Show only the last reading of the chosen modules.
 
* '''Last value''': Show only the last reading of the chosen modules.
* '''Agent''': the intelligent control to choose the agent for this item.
+
* '''Agent''': The intelligent control to choose the agent for this item.
 
* '''Module''': drop-down list that is dynamically loaded with the modules of the agent selected in the previous control.
 
* '''Module''': drop-down list that is dynamically loaded with the modules of the agent selected in the previous control.
 
* '''Group by agent''': Group report metrics by agent.
 
* '''Group by agent''': Group report metrics by agent.
* '''Order''': Order in which the metrics will show.  
+
* '''Order''': Order in which the metrics will be shown.  
 
* '''Show summary''': Display a final summary with the average, maximum and minimum values.
 
* '''Show summary''': Display a final summary with the average, maximum and minimum values.
* '''Show in the same row''': Show all operations (max,min, avg or sum) in the same row.
+
* '''Show in the same row''': Show all operations (max, min, avg or sum) in the same row.
  
 
<center>
 
<center>
Line 628: Line 868:
 
</center>
 
</center>
  
====== The Group Report ======
+
====== Group Report ======
  
 
It displays a table containing the below mentioned information of a predefined group:
 
It displays a table containing the below mentioned information of a predefined group:
  
 
* '''Agents'''
 
* '''Agents'''
** The total number of agents
+
** The total number of agents.
** The number of agents holding an 'unknown' status
+
** The number of agents holding 'unknown' status.
  
 
* '''Modules'''
 
* '''Modules'''
** The total number of modules
+
** The total number of modules.
** The number of modules holding a 'normal' status
+
** The number of modules holding 'normal' status.
** The number of modules holding a 'critical' status
+
** The number of modules holding 'critical' status.
** The number of modules holding a 'warning' status
+
** The number of modules holding 'warning' status.
** The number of modules holding an 'unknown' status
+
** The number of modules holding 'unknown' status.
** The number of modules holding a 'not initiated' status
+
** The number of modules holding 'not initiated' status.
  
 
* '''Alerts'''
 
* '''Alerts'''
** The number of defined alerts
+
** The number of defined alerts.
** The number of fired alerts
+
** The number of triggered alerts.
  
 
* '''Events'''
 
* '''Events'''
Line 655: Line 895:
 
</center>
 
</center>
  
The fields pertaining to this particular form are the following:
+
The fields belonging to this particular form are the following:
 
+
* '''Name''': The following macros can be used:
* '''Group:''' A combo intended to select the group.
+
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : NAme od the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* '''Group:''' Combo intended to select the group.
 
* '''Recurse''': Analyze recursively the child groups of the choosen group.
 
* '''Recurse''': Analyze recursively the child groups of the choosen group.
Within the HTML version of the report, an item of this type is generated as you can see below.
+
Report view example:
 
 
 
<center>
 
<center>
 
[[image:Group-report-result.png|800px]]
 
[[image:Group-report-result.png|800px]]
 
</center>
 
</center>
  
====== Exceptions ======
+
====== Exception ======
  
It shows values of several modules that comply with logical operations (greater or equal, smaller, OK or Not OK).
+
It shows values of several modules that comply with logical operations (higher or equal, lower, OK or Not OK).
  
 
<center>
 
<center>
Line 673: Line 918:
 
</center>
 
</center>
  
We can configure the following fields:
+
The following fields can be configured:
 
+
* '''Name''': The following macros can be used:
* '''Time lapse''': Interval of time on which the report will be calculated (from the current moment).
+
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : NAme od the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* '''Time lapse''': Interval of time based on which the report will be calculated (from the present moment).
 
* '''Last value''': Show only the last reading of the chosen modules.
 
* '''Last value''': Show only the last reading of the chosen modules.
* '''Order''': Order in which the metrics will show.  
+
* '''Order''': Order in which metrics will be show.  
* '''Value''': value that will be considered with the chosen condition.
+
* '''Value''': Value considered with the chosen condition.
* '''Condition''': Condition under which to filter the report data, ''everything'' ignores the filtering.
+
* '''Condition''': Condition under which to filter the report data. "Everything" ignores filtering.
 
* '''Show summary''': Display a final summary with the average, maximum and minimum values.
 
* '''Show summary''': Display a final summary with the average, maximum and minimum values.
 
* '''Show in the same row''': Show all operations (max, min, avg or sum) in the same row.
 
* '''Show in the same row''': Show all operations (max, min, avg or sum) in the same row.
  
In the lower part we will be able to add as many modules as we need once the report element is saved:
+
You may add at the bottom as many modules as you need once the report element is saved:
  
* '''Agent''': the intelligent control to choose the agent for this item.
+
* '''Agent''': Intelligent control to choose the agent for this item.
* '''Module''': drop-down list that is dynamically loaded with the modules of the agent selected in the previous control.
+
* '''Module''': Drop-down list that is dynamically loaded with the modules of the agent selected in the previous control.
  
 
Example of report display:
 
Example of report display:
Line 704: Line 955:
 
====== SQL queries ======
 
====== SQL queries ======
  
This item shows in the reports Pandora DB data in table to have in the report personalized data extracted directly from the DB.
+
This item shows in Pandora FMS DB data reports, a table to keep custom data retrieved directly from the DB.
  
{{warning|This type of items have to be used with care since they can overload Pandora FMS.}}
+
{{warning|This type of items must be carefully used, since they can overload Pandora FMS.}}
  
Los campos de este formulario son:
+
The fields of this form are:
* '''Query SQL''': text box where to write the SQL query to extract data from Pandora FMS DB.
+
* '''Name''': The following macros can be used:
* '''Serialized header''': text field where to put separated by '''|''' to define the headers of the table that will be shown in the report, for each column that came out of result in the SQL query.
+
** _agent_ : Name of the agent selected in report item.
* '''Custom SQL template''': A drop-down list containing SQL templates of saved queries for easy use. These can be managed through Administration, Manage reports in Custom SQL.
+
** _agentdescription_ : Description of the agent selected in report item.
* '''Query History Database''': Checkbox that when checked will make the edited sql query also collect data from the historical database.
+
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : NAme od the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* '''SQL Query''': Text box where to write the SQL query to retrieve data from Pandora FMS DB.
 +
* '''Serialized header''': Text field where to put separated by '''|''' the headers of the table that will be shown in the report, for each column that came out as a result in the SQL query.
 +
* '''Custom SQL template''': A drop-down list containing SQL templates of saved queries for easy use. These can be managed through ''Administration'' > ''Manage reports'' in Custom SQL.
 +
* '''Query History Database''': Checkbox that when checked will make the edited SQL query also collect data from the historical database.
  
We can customize the queries that will appear in the report by choosing one of the following options:
+
The queries that will appear in the report can be customized by choosing one of the following options:
  
* Type manually in the text field the query to perform.
+
* Type in manually the query to perform in the text field.
  
 
<b>Note:</b> Due to security restrictions, there are some reserved words that cannot be used:  DELETE, DROP, ALTER, MODIFY, password, pass, INSERT or UPDATE.
 
<b>Note:</b> Due to security restrictions, there are some reserved words that cannot be used:  DELETE, DROP, ALTER, MODIFY, password, pass, INSERT or UPDATE.
Line 727: Line 985:
  
  
* Or, we can select a query from the list using the ''Custom SQL template'' drop-down:
+
* Or, you may select a query from the list using the ''Custom SQL template'' drop-down:
  
 
<center>
 
<center>
Line 743: Line 1,001:
 
<br>
 
<br>
  
<b>Note:</b> You can define your own templates in the menu ''Reporting > Custom SQL''.
+
<b>Note:</b> You may define your own templates in the menu ''Reporting > Custom SQL''.
  
 
<center>
 
<center>
Line 756: Line 1,014:
 
</center>
 
</center>
  
 +
Define your query and a name to identiy it and press "Save" for it to appear on the list:
  
This item shows in the reports Pandora DB data in table to have in the report personalized data extracted directly from the DB.
 
 
<center>
 
<center>
 
[[image:custom_sql_new.png]]
 
[[image:custom_sql_new.png]]
Line 764: Line 1,022:
 
====== Top N ======
 
====== Top N ======
  
It displays N values discriminated by maximum, minimum or the average of the selected modules, ordered ascending, descending or by the agent's name.
+
It displays N values sorted out by maximum, minimum or average redarding the selected modules, ordered upward, downward or by name.
 
<center>
 
<center>
 
[[image: report_topn.png|815px]]
 
[[image: report_topn.png|815px]]
 
</center>
 
</center>
 +
 +
Report view example:
  
 
<center>
 
<center>
Line 782: Line 1,042:
  
  
We can indicate:
+
You may indicate:
 
+
* '''Name''': The following macros can be used:
* '''Time lapse''': Backward time range over which the report will be made (e.g. one month from the chosen date).
+
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : NAme od the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* '''Time lapse''': Time range taken backwards over which the report will be made (e.g. one month from the chosen date).
 
* '''Group''': Group where agents with interface traffic modules will be searched.
 
* '''Group''': Group where agents with interface traffic modules will be searched.
* '''Full resolution graph (TIP)''': Use the TIP real data painting system instead of the standard motor.
+
* '''Full resolution graph (TIP)''': Use the TIP real data drawing system instead of the standard motor.
  
  
Line 805: Line 1,071:
  
 
====== Availability ======
 
====== Availability ======
Se ha mejorado enormemente la funcionalidad de este tipo de informe, logrando que los datos representados en él ya no sean aproximaciones, sino reflejo exacto de la situación de los módulos a lo largo del período seleccionado.
+
The feature of this type of report has been widely improved, so that now the data it represents are not approximations but an accurate reflection of the module situation throughout the selected period.
  
Este ítem muestra un tabla con los datos de disponibilidad de una lista de agentes y módulos seleccionada.  
+
This item shows a table with the availability data of a selected list of agents and modules.  
  
También ofrece la posibilidad de mostrar un resumen en el que mostrarán aquellos módulos con mayor y  menor disponibilidad, así como un análisis del promedio.
+
It also offers the possibility of showing a summary including those modules with higher and lower availability as well as an average analysis.
  
 
<center>
 
<center>
Line 816: Line 1,082:
  
  
Puede personalizar los siguientes campos:
+
The following fields can be customized:
  
Los campos de este formulario son:
+
The fields of this form are:
* '''Period''': Intervalo de tiempo sobre el que se calculará el informe (desde el momento actual).
+
* '''Name''': The following macros can be used:
* '''Working time''': el periodo de tiempo en el que el módulo debería haber estado funcionando. La gráfica se mostrará completa, pero solo se calculará con los datos dentro del tiempo de trabajo. La disponibilidad será desconocida (N/A) si el intervalo a mostrar está fuera del intervalo de trabajo.
+
** _agent_ : Name of the agent selected in report item.
* '''Show address instead of module name.Show the agent's main address.''': Mostrará la IP principal del agente en vez del nombre.
+
** _agentdescription_ : Description of the agent selected in report item.
* '''Show summary''': Mostrar un resumen final.
+
** _agentgroup_ : Group of the agent selected in report item.
* '''Orden''': Ordenar los items disponibilidad según el criterio elegido.
+
** _address_ : Address of the agent selected in report item.
* '''Hide not init agents''': Ocultar de la vista aquellos agentes no iniciados.
+
** _module_ : NAme od the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* '''Period''': Time interval based on which the report will be calculated (from the present moment).
 +
* '''Working time''': Time period the module should have been working. The graph will be complete, but it will only be calculated based on the working time data. Availability will be unknown (N/A) if the interval to show is out of the working interval. From Pandora FMS version 749, this kind of reports includes also the possibility of checking the box ''24x7'', which is under the ''working time''. This way, the information will be collected without taking into account the ''working time'' configuration and being able to compare both cases, since it will show us 2 independent graphs.
 +
* '''Show address instead of module name.Show the agent's main address.''': It will show the agent's main IP instead of the name.
 +
* '''Show summary''': Show a final summary.
 +
* '''Orden''': Order the availability items according to the selected criteria.
 +
* '''Hide not init agents''': Hide from the view non-initiated agents.
  
  
Una vez hemos seleccionado estas opciones, agregaremos cada uno de los módulos objetivos sobre los que queramos calcular SLA:
+
Once these options have been selected, add each of the target modules over which the SLA must be calculated:
  
 
<center>
 
<center>
Line 833: Line 1,106:
 
</center>
 
</center>
  
* '''Agent''': Combo donde puede indicar el agente sobre el que aplicar el informe.
+
* '''Agent''': Combo where to indicate the agent to which the report must be applied.
* '''Module''': En un combo se elige el módulo del agente previamente fijado sobre el que calculará el SLA.
+
* '''Module''': In a combo, the module of the previously set agent over which the SLA will be calculated.
  
  
  
Ejemplo de visualización de informe:
+
Report view example:
  
 
<center>
 
<center>
Line 846: Line 1,119:
  
  
Muestra la siguiente información:
+
It shows the following information:
* '''Agente''': agente.
+
* '''Agente''': Agent.
* '''Module''' / '''Dirección IP''': al configurar el item puedes elegir que muestre la dirección ip primaria del agente en vez módulo, muy útil para informes que pongan una lista agentes e ips en vez de por agentes y módulos ping.
+
* '''Module''' / '''IP address''': When configuring the item, you may choose whether to see the agent's main IP instead of that of the module. Very useful for reports that contain a list of agents and IPs instead of agents and ping modules.
* '''Total time''': Tiempo total a analizar.
+
* '''Total time''': Total time to anaylize.
* '''Time failed''': Tiempo en estado crítico.
+
* '''Time failed''': Time in critical status.
* '''Time OK''': Tiempo en estado OK o advertencia.
+
* '''Time OK''': Time in OK or warning status.
* '''Time Unknown''': Tiempo en estado desconocido.
+
* '''Time Unknown''': Time in unknown status.
* '''Time Not init''': Tiempo no iniciado.
+
* '''Time Not init''': Non-initiated time.
* '''Time downtime''': Tiempo en parada planificada.
+
* '''Time downtime''': Time in scheduled downtime.
* '''%OK''': Porcentaje de tiempo en estado correcto.
+
* '''%OK''': Correct status time percentage.
  
* '''Total checks''': número de chequeos totales realizados durante el lapso de tiempo configurado para el informe.
+
* '''Total checks''': Total checks done during the time lapse configured in the report.
* '''Checks failed''': número de chequeos que han fallado (críticos).
+
* '''Checks failed''': Number of failed checks (critical).
* '''Checks OK''': número de chequeos correctos.
+
* '''Checks OK''': Number of correct checks.
* '''Checks Unknown''': Aproximación basada en eventos y la lógica de Pandora FMS que permite indicar el número de chequeos que <b>deberían</b> haberse realizado, pero de los que no consta una respuesta.
+
* '''Checks Unknown''': Approximation based on events and Pandora FMS logic that allows to point out the number of checks that <b>should</b> have been carried out, but from which there is no answer.
  
 
===== HTML and Text Items =====
 
===== HTML and Text Items =====
Line 871: Line 1,144:
 
</center>
 
</center>
  
The field pertaining to this particular form is the following:
+
The fields of this particular form are the following:
 +
* '''Name''': The following macros can be used:
 +
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : NAme od the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* '''Text:''' A text box intended to format the text and add links and images from a remote server.
  
* '''Text:''' A text box intended to format the text and to add links and images from a remote server.
+
An example of the window where the link is added is shown below.
 
 
An example of the window in which the link is added is shown below.
 
  
 
<center>
 
<center>
Line 881: Line 1,160:
 
</center>
 
</center>
  
An example of the window in which the image is added is shown below.
+
Screenshot example of the window where to add the image:
  
 
<center>
 
<center>
Line 887: Line 1,166:
 
</center>
 
</center>
  
====== Importing Text from an URL ======
+
You may add any html content to this element.
 +
 
 +
Report view example:
 +
 
 +
<center>
 +
[[image:html_text_sample.png]]
 +
</center>
 +
 
 +
<br>
 +
<br>
  
This item shows the text extracted from an external server to which the Pandora FMS Console has access to. In the HTML report format, it's important to keep in mind that it's going to display the text like it really is, but in the PDF version of the report, it's only going to show the text in a plain-text format.
+
====== Import text from an URL ======
 +
 
 +
This item shows the text retrieved from an external server to which the Pandora FMS Console has access to. In the HTML report format, it will be displayed as it is, but the PDF version of the report will show the text in plain-text format.
  
 
<center>
 
<center>
Line 895: Line 1,185:
 
</center>
 
</center>
  
The fields pertaining to this particular form are the following:
+
The fields belonging to this particular form are the following:
 
+
* '''Name''': The following macros can be used:
* '''URL:''' The text field intended to insert the external server address in order to extract the text.
+
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : NAme od the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* '''URL:''' The text field intended to enter the external server address in order to extract the text.
  
 
===== Alert Items =====
 
===== Alert Items =====
====== The Alert Report Agent ======
+
====== Alert Report Agent ======
  
It displays a list containing the agent's fired alerts of a specified report group within a predefined period.
+
It displays a list containing the alerts triggered by the report group agents within a predefined period.
  
 
<center>
 
<center>
Line 909: Line 1,205:
  
 
The fields within this form are the following:
 
The fields within this form are the following:
 +
* '''Name''': The following macros can be used:
 +
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : NAme od the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* '''Period:''' The time frame taken backwards based on which the report is generated (e.g. one month from the seleted date).
 +
* '''Agent:''' Intelligent control for selecting the appropriate agent for the item.
 +
* '''Label:''' Label assigned to an element. The following macros can be used: ''_agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.''
  
* '''Period:''' The time frame it takes to get back to the temporary point within which the report is generated.
+
Report example:
* '''Agent:''' An intelligent control for selecting the appropriate agent for this item.
 
 
 
Within the HTML version of the report, an item of this type is generated as you can see below.
 
  
 
<center>
 
<center>
Line 919: Line 1,222:
 
</center>
 
</center>
  
====== The Alert Report Module ======
+
====== Alert report module ======
  
It displays a list containing the module's fired alerts within a predefined period intended for the report.
+
It displays a list containing the module's triggered alerts within a predefined period intended for the report.
  
 
<center>
 
<center>
Line 927: Line 1,230:
 
</center>
 
</center>
  
The fields pertaining to this particular form are the following:
+
The fields contained in this particular form are the following:
 +
* '''Name''': The following macros can be used:
 +
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : NAme od the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* '''Period:''' The time frame taken backwards based on which the report is generated (e.g. one month from the selected date).
 +
* '''Agent:''' Intelligent control to select the appropriate agent for this item.
 +
* '''Module:''' A drop-down list which is dynamically loaded by the agent's modules selected in the previous control.
 +
* '''Label:''' Label the element can be assigned. The following macros can be used: ''_agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.''
  
* '''Period:''' The time frame it takes to get back to the temporary point within which the report is generated.
 
* '''Agent:''' The intelligent control to select the appropriate agent for this item.
 
* '''Module:''' A list which is dynamically loaded by the agent's modules selected in the control above.
 
 
====== Alert report group ======
 
====== Alert report group ======
Shows a list with the alerts launched in any element of the group defined in the report in the defined period.
+
It shows a list with the alerts launched in any element of the group defined in the report in the defined period.
  
 
<center>
 
<center>
Line 940: Line 1,251:
 
<br><br>
 
<br><br>
  
We will configure the following fields:
+
The following fields are to be configured:
 
+
* '''Name''': The following macros can be used:
* '''Time lapse''': the backward time range over which the report will be drawn up (e.g. one month from the chosen date).
+
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : NAme od the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* '''Time lapse''': Time range taken backwards based on which the report is generated (e.g. one month from the chosen date).
 
* '''Group''': Group on which the alert triggering information will be analysed.
 
* '''Group''': Group on which the alert triggering information will be analysed.
 
* '''Recursion''': Analyze the child groups of the recursively defined group.
 
* '''Recursion''': Analyze the child groups of the recursively defined group.
Line 951: Line 1,268:
  
 
===== Event Items =====
 
===== Event Items =====
====== The Event Report Agent ======
+
====== Event Report Agent ======
  
It displays a list containing the events which occurred within the agents in the predefined time frame.
+
It shows a list containing the events that took place within the agents in the predefined time frame.
  
 
<center>
 
<center>
Line 960: Line 1,277:
  
 
The fields pertaining to this particular form are the following:
 
The fields pertaining to this particular form are the following:
 
+
* '''Name''': The following macros can be used:
* '''Period:''' The time frame it takes to get back to the temporary point within which the report is generated.
+
** _agent_ : Name of the agent selected in report item.
* '''Agent:''' The intelligent control to select the appropriate agent for this item.
+
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : NAme od the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* '''Period:''' The time frame taken backwards based on which the report is generated (e.g. one month from the chosen date).
 +
* '''Agent:''' Intelligent control to select the appropriate agent for this item.
 
* '''Severity, event type, event status''': Selecct the types of events to see.
 
* '''Severity, event type, event status''': Selecct the types of events to see.
 
* '''Event graphs''': Show event summary graphs.
 
* '''Event graphs''': Show event summary graphs.
Within the HTML version of the report, an item of this type is generated as you can see below.
+
* '''Label:''' Label an element can be assigned. The following macros can be used: ''_agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.''
  
 +
Report view example:
 
<center>
 
<center>
 
[[image:pre27.png|800px]]
 
[[image:pre27.png|800px]]
 
</center>
 
</center>
  
====== The Event Report Module ======
+
====== Event Report Module ======
  
It displays a list containing the events occurred within an agent's module in the report of a predefined time frame.
+
It displays a list containing the events that took place within an agent's module in the report of a predefined time frame.
  
 
<center>
 
<center>
Line 980: Line 1,304:
  
 
The fields pertaining to this particular form are the following:
 
The fields pertaining to this particular form are the following:
 
+
* '''Name''': The following macros can be used:
* '''Period:''' The time frame it takes to get back to the temporary point within which the report is generated.
+
** _agent_ : Name of the agent selected in report item.
* '''Agent:''' An intelligent control to select the appropriate agent for this item.
+
** _agentdescription_ : Description of the agent selected in report item.
* '''Module:''' A deployable list that is dynamically loaded with the agent's modules selected in the control above.
+
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : NAme od the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* '''Period:''' The time frame taken backwards based on which the report is generated (e.g. one month from the selected date).
 +
* '''Agent:''' Intelligent control to select the appropriate agent for the item.
 +
* '''Module:''' Drop-down list that is dynamically loaded with the agent's modules selected in the control above.
 
* '''Severity, event type, event status''': Select the type of events to see.
 
* '''Severity, event type, event status''': Select the type of events to see.
 
* '''Event graphs''': Show event summary graphs.
 
* '''Event graphs''': Show event summary graphs.
 +
* '''Label:''' Label an element can be assigned. The following macros can be used: ''_agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.''
  
 +
Report view example:
 
<center>
 
<center>
 
[[image:report_module_events_sample.png]]
 
[[image:report_module_events_sample.png]]
 
</center>
 
</center>
  
====== The Event Report Group ======
+
====== Event Report Group ======
  
It displays a list containing the events which occurred in the report group's agents within a predefined time frame.
+
It displays a list containing the events which took place in the report group's agents within a predefined time frame.
  
 
<center>
 
<center>
Line 999: Line 1,331:
 
</center>
 
</center>
  
The fields pertaining to this particular form are the following:
+
The fields belonging to this particular form are the following:
 +
* '''Name''': The following macros can be used:
 +
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : NAme od the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* '''Period:''' The time frame taken backwards based on which the report is generated (e.g. one month from the selected date).
 +
* '''Group:''' Combo intended to select the group.
 +
* '''Severity, event type, event status''': Select the type of events to see.
 +
* '''Event graphs''': Show event summary graphs.ç
  
* '''Period:''' The time frame it takes to get back to the temporary point within which the report is generated.
+
Within the HTML version of the report, an this type of item is generated:
* '''Group:''' A combo intended to select the group.
 
* '''Severity, event type, event status''': Select the type of events to see.
 
* '''Event graphs''': Show event summary graphs.
 
Within the HTML version of the report, an item of this type is generated as you can see below.
 
  
 
<center>
 
<center>
Line 1,014: Line 1,353:
 
====== Inventory ======
 
====== Inventory ======
  
This item is contained in the Enterprise version of Pandora FMS. It displays the selected inventory of one or various hosts pertaining to a specific date or its last known data.
+
This item can be found in the Enterprise version of Pandora FMS. It displays the selected inventory from one or several hosts belonging to a specific date or its last known data.
  
 
<center>
 
<center>
Line 1,020: Line 1,359:
 
</center>
 
</center>
  
The fields pertaining to this particular form are the following:
+
The fields that belong to this particular form are the following:
 
+
* '''Name''': The following macros can be used:
* '''Description:''' A text field intended for the item's description.
+
** _agent_ : Name of the agent selected in report item.
* '''Group:''' A combo which filters the agents appearing within the next field. It doesn't appear in the report, it's only a form tool.
+
** _agentdescription_ : Description of the agent selected in report item.
* '''Agents:''' The agents of the hosts in which the inventory will be gathered. Only the agents which contain inventory modules are going to appear in this field.
+
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : NAme od the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* '''Description:''' Text field intended for the item's description.
 +
* '''Group:''' Combo that filters the agents that appear within the next field. It does not appear in the report, it is only a form tool.
 +
* '''Agents:''' The agents of the machines the inventory is taken from. Only the agents with inventory modules will appear in this field.
 
* '''Modules:''' The common inventory modules of the selected agents.
 
* '''Modules:''' The common inventory modules of the selected agents.
* '''Date:''' The date of the displayed data. If the youngest date is selected here, only the latest inventory data of the selected modules will be gathered.
+
* '''Date:''' The date of the displayed data. If the last date is selected here, only the latest inventory data of the selected modules will be gathered.
 
<center>
 
<center>
 
[[image:inventory_report_sample.png|750px]]
 
[[image:inventory_report_sample.png|750px]]
 
</center>
 
</center>
  
====== Inventory Changes ======
+
====== Inventory changes ======
  
This item displays the changes of the inventory registered in one of various hosts within a predefined time frame.
+
This item displays the changes of the inventory registered in one of several hosts within a predefined time frame.
  
 
<center>
 
<center>
Line 1,040: Line 1,385:
  
 
The fields pertaining to this particular form are the following:
 
The fields pertaining to this particular form are the following:
 
+
* '''Name''': The following macros can be used:
 +
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : NAme od the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 
* '''Description:''' A text field intended for the item's description.
 
* '''Description:''' A text field intended for the item's description.
 
* '''Period:''' A field to determine the interval for registering the changes.
 
* '''Period:''' A field to determine the interval for registering the changes.
* '''Group:''' A combo which filters the agents which appear within the next field. It doesn't appear in the report, it's only a form tool.
+
* '''Group:''' Combo that filters the agents that appear within the next field. It does not appear in the report, it is only a form tool.
* '''Agents:''' The agents of the hosts in which the inventory will be gathered. Only the agents containing inventory modules are going to appear within this field.
+
* '''Agents:''' Agents of the hosts where the inventory will be gathered. Only the agents containing inventory modules will appear within this field.
 
* '''Modules:''' The common inventory modules of the selected agents.
 
* '''Modules:''' The common inventory modules of the selected agents.
  
  
{{Tip|The data for this item is solely provided by inventory changing events. If they have a too large number of them, you may delete some of those events manually to reduce them.}}
+
{{Tip|The data for this item are solely provided by inventory changing events. If the item is too big, you may delete some of those events manually to reduce it.}}
 +
 
 +
Report view example:
 
<center>
 
<center>
 
[[image:inventory_changes_report_sample.png|750px]]
 
[[image:inventory_changes_report_sample.png|750px]]
Line 1,057: Line 1,410:
 
====== Agent Configuration ======
 
====== Agent Configuration ======
  
This type of report will show us a picture of the agent status:
+
This type of report will show a picture of the agent status:
  
 
<center>
 
<center>
 
[[image:agent_configuration_report.png]]
 
[[image:agent_configuration_report.png]]
 
</center>
 
</center>
 +
* '''Name''': The following macros can be used:
 +
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : NAme od the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* '''Label:''' Label an element can be assigned. The following macros can be used: ''_agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.''
  
  
 
+
Display example:
Example of report display:
 
  
 
<center>
 
<center>
Line 1,073: Line 1,433:
 
<br><br>
 
<br><br>
  
====== Group Options ======
+
====== Group options ======
This type of report will show us a picture of the status of the agents that belong to the selected group:
+
This type of report will show a picture of the status of the agents that belong to the selected group:
  
  
Line 1,083: Line 1,443:
  
  
Example of report display:
+
Display example:
 
<center>
 
<center>
 
[[image:group_configuration_report_sample.png|750px]]
 
[[image:group_configuration_report_sample.png|750px]]
Line 1,092: Line 1,452:
 
====== Netflow area chart ======
 
====== Netflow area chart ======
  
This report element will display a graph with the traffic analysis using filters already created in the Netflow view.
+
This report element will display a graph with the traffic analysis using filters already created in Netflow view.
  
  
Line 1,182: Line 1,542:
 
[[image:log_report_build.png|750px]]
 
[[image:log_report_build.png|750px]]
 
</center>
 
</center>
 
+
* '''Name''': The following macros can be used:
* '''Search''': text string to search.
+
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : NAme od the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* '''Search''': Text string to be searched.
 
* '''Log number''': Maximum number of log block entries to be shown when generating this report.
 
* '''Log number''': Maximum number of log block entries to be shown when generating this report.
* '''Time lapse''': the time range going backwards over which the report will be drawn up (e.g. one month from the chosen date).
+
* '''Time lapse''': The time range taken backwards based on which the report will be drawn up (e.g. one month from the chosen date).
* '''Source''': Origin of logs.
+
* '''Source''': Log source.
* '''Agents''': Filtration Agents.
+
* '''Agents''': Filtering agents.
  
  
Line 1,196: Line 1,562:
 
</center>
 
</center>
  
==== The Wizard Tab ====
+
===== Network items =====
 +
====== Network traffic Top N ======
  
This tab is a feature of the Enterprise Version of Pandora FMS. It allows you to automatically combine several items containing common configurations all at once and by a few clicks which are getting applied to several agents and modules for a report.
+
This report shows a top-N of network consumption in the last X days of all IP analyzed by Pandora NTA:
  
Once the type, the period, the agents and the modules have been selected, all you need to do is to click on the 'Add' button and it's going to generate as many items as agents or modules have been selected for the report.
+
 
 +
[[File: Network_traffic_topN.png]]
 +
* '''Name''': The following macros can be used:
 +
** _agent_ : Name of the agent selected in report item.
 +
** _agentdescription_ : Description of the agent selected in report item.
 +
** _agentgroup_ : Group of the agent selected in report item.
 +
** _address_ : Address of the agent selected in report item.
 +
** _module_ : NAme od the agent module selected in report item.
 +
** _moduledescription_ : Description of the module selected in report item.
 +
* '''Time lapse''': the time range taken backwards based on which the report will be drawn up (e.g. one month from the chosen date).
 +
* '''Quantity(n)''': Number of elements to be shown.
 +
 
 +
[[File: Pandora NTA sample report 1.png]]
 +
 
 +
==== General wizard ====
 +
 
 +
This tab allows to automatically create a complete report with just a few clicks. By applying common configurations you may generate alements applied to multiple agents and/or modiles. This is an Enterprise feature.
 +
 
 +
Once the type, the period, the agents and the modules have been selected, click on 'Add' and it will generate as many items as agents or modules have been selected for the report.
  
 
<center>
 
<center>
Line 1,206: Line 1,591:
 
</center>
 
</center>
  
The fields pertaining to this particular form are the following:  
+
The fields belonging to this particular form are the following:  
 
+
* '''Name''': The following macros can be used:
* '''Type:''' A deployable list in which you're able to select the type of item that's going to be massively generated. Not all item types are contained in here, because there are certain item types which require a more detailed configuration. The available item types within this form are the following: Alert Report Agent, Alert Report Module, AVG Module, Event Report Agent, Event Report Module, Monitor Report, Simple Graph and Availability  
+
** _agent_ : Name of the agent selected in report item.
* '''Period:''' An intelligent control to provide the time period or data-time segment to represent the report item from the moment it's generated. If the time frame is e.g. 'one month' and you're generating the report in the current moment, the items are going to provide data from today to one month in the past.
+
** _agentdescription_ : Description of the agent selected in report item.
* '''Agents:''' The list of agents you're allowed to access according your permission group. On this list, you may select one or several agents. The modules which are defined as common for the selected agents are shown within the module control for each selection.
+
** _agentgroup_ : Group of the agent selected in report item.
* '''Modules:''' This common module list of the selected agents is available for one or several agents.
+
** _address_ : Address of the agent selected in report item.
* '''Filter Group:''' A field intended to filter the agents by group.
+
** _module_ : NAme od the agent module selected in report item.
* '''Elements to apply''': The list intended for the selected modules to add.
+
** _moduledescription_ : Description of the module selected in report item.
 +
* '''Type:''' A drop-down list where you may select the mass-generated type of item. Certain item types that require more detailed configuration are excluded. The available item types within this form are: Alert Report Agent, Alert Report Module, AVG Module, Event Report Agent, Event Report Module, Monitor Report, Simple Graph and Availability  
 +
* '''Time interval:''' Time interval based on which the report is created (from the present moment).
 +
* '''Filter Group:''' A field intended to filter agents by group.
 +
* '''Agents:''' Multi selector with the list of available agents for the user.
 +
* '''Modules:''' Multi selector with the list of modules common to the selected ahents.
 +
* '''Elements to apply''': Selected module list. Report items will be added to the elements of this list.
 +
* '''Label''': Label an element can be assigned. The following macros can be used: ''_agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.''
 +
* '''Name''': Name an element can be assigned. The following macros can be used: ''_agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.''
 +
* '''Time lapse''': The time range taken backwards based on which the report will be drawn up (e.g. one month from the chosen date).
  
Example of visualization of report (availability):
+
Report view example (availability):
  
 
<center>
 
<center>
Line 1,224: Line 1,618:
  
 
==== The SLA Wizard Tab ====
 
==== The SLA Wizard Tab ====
This wizard allows us to create SLA report items automatically.
+
This wizard allows to create SLA report items automatically.
  
We can choose different SLA analyses:
+
You may choose different SLA analyses:
  
* '''SLA:''' Displays a standard SLA reporting element, indicating the % of compliance in the selected period.
+
* '''SLA:''' It displays a standard SLA reporting element, indicating the % of compliance in the selected period.
* '''Monthly SLA:''' will show a day by day analysis of the selected month, indicating the compliance %.
+
* '''Monthly SLA:''' It will show a day by day analysis of the selected month, indicating the compliance %.
* '''Weekly SLA:''' will show an analysis of the compliance % week by week, indicating at all times the daily value.
+
* '''Weekly SLA:''' It will show an analysis of the compliance % week by week, indicating at all times the daily value.
* '''Hourly SLA:''' will display an hourly analysis of the selected period.
+
* '''Hourly SLA:''' It will display an hourly analysis of the selected period.
* '''Availability graph:''' a graph will be generated with the availability data of the selected modules.
+
* '''Availability graph:''' A graph will be generated with the availability data of the selected modules.
* '''SLA services:''' a new reporting element representing the calculation of the SLAs of the selected services will be created.
+
* '''SLA services:''' A new reporting element representing the calculation of the SLAs of the selected services will be created.
  
  
Line 1,243: Line 1,637:
 
Other options can be found:
 
Other options can be found:
  
* ''Hide not init agents'': only basic SLA; it will hide the uninitiated elements of the report.
+
* ''Time lapse'': This is the range, or period of time over which the report renders the information for this report type. For example, a week means data from a week ago from now.  
  
* ''Show graph'': only basic SLA; allows you to choose whether to display a table with the data, a graph, or both.
+
* ''Show graph'': Only basic SLA. It allows to choose whether to display a table with the data, a graph, or both.
  
 
<center>
 
<center>
Line 1,259: Line 1,653:
 
<br><br>
 
<br><br>
  
==== The Global Tab ====
+
==== Global ====
 +
 
 +
This section is where ''Exception'', ''General'' or ''Top N'' elements can be easily created thanks to a wizard.
  
This tab is a feature of the Enterprise Version of Pandora FMS and allows us to create ''Exception'', ''General'' or ''Top N'' reports easily by a wizard.
+
* '''Exception''': This shows values of several modules that meet a logical operation.
  
With this section you can add different modules from different agents, while you can also choose the operation to do in each module: addition, media, min and max.
+
* '''General''': It shows values of several modules ordered (upward, downward, by agent name) or/and grouped by name.
 +
 
 +
* '''Top N''': It shows N values sorted out by maximun, minimun or average over the total of modules selected, ordered upward, downward or by agent name.
 +
 
 +
That way you may add different modules from different agents, while you can also choose the operation to be performed in each module: addition, average, min and max.
  
 
<center>
 
<center>
Line 1,270: Line 1,670:
  
  
Example of visualization of a report:
+
Example of report view:
  
 
<center>
 
<center>
Line 1,276: Line 1,676:
 
</center>
 
</center>
  
==== The Advanced Options Tab ====
+
==== Report advanced options ====
  
This tab is a feature of the Enterprise Version of Pandora FMS. This tab was designed to make the reports much more customizable. Among other things, you're now able to select the font the PDF report is going to be generated with, to select the logo which will be shown in the PDF header, to edit the header and the PDF footer and the report's front page.
+
This report advanced configuration tab allows to edit some of its visual aspects such as:
 +
*Customize font.
 +
*Select a logo to use in the headers of the PDF files.
 +
*Edit the header and footer of each page.
 +
*Edit the report's cover.
  
 
<center>
 
<center>
Line 1,284: Line 1,688:
 
</center>
 
</center>
  
The fields pertaining to this particular form are the following:
+
* '''Family font:''' The default font is Times New Roman. If you want to customize the font type, select the desired one from the drop-down list.
 +
 
 +
<b>Note:</b> This list is built on the basis of the 'ttf' files found in the directory:
 +
 
 +
/var/www/html/pandora_console/enterprise/include/mpdf50b/ttfonts
 +
 
 +
You may add font files in TTF format to that directory. They must have the correct permissions for the user that provides the web service to have access to thos files. By default apache:apache in CentOS based systems. Pandora FMS includes the "code" fotn that displays all existing characters in UTF8.
 +
 
 +
* '''Custom Logo:''' ''pandora_logo.jpg'' is used by default. You may select from the drop-down list any of the possible logos to decorate the header of each PDF page.
 +
 
 +
<b>Note:</b> This list is built based on the image files found at the following directory:
  
* '''Font Family:''' It's a deployable list, containing all the fonts you've installed within your Pandora Console in the directory '<pandoraconsole>/enterprise/include//mpdf50b/ttfonts'. The default font is 'Times New Roman'. If you want to make the font range bigger, it's important to consider that it's required to have read access to the apache group and the fonts are required to be in TTF format.
+
/var/www/html/pandora_console/images/custom_logo/
<br>
 
{{tip|If you intend to use Arabic, Chinese, Japanese or another UTF8 text within your PDF, you're required to utilize a supported TTF font for doing so. We're providing the 'code' font which actually contains all language characters.}}
 
  
* '''Custom Logo:''' It's a deployable list containing all possible logs which could be shown in the header of each PDF page. The logo images are stored under '<pandora_console>/images/custom_logo/'. The default image is 'pandora_logo.jpg'. You're able to see a preview in conjunction with your form by clicking on it.
+
You may add the image files to that directory. They must have the correct permissions for the user that provides the web service to have access tp those files. By default apache:apache in CentOS based systems.
  
* '''Header:''' It's a complete editor within which you're able to copy and paste the formatted text of an application into or to edit it by the 'box' button. This text is going to be the one shown in the header.
+
* '''Header:''' It is a rich text editor where to copy and paste formatted text from an office application or edit on site. This text will be displayed at each page's header.
  
* '''First Page:''' Like the header field, this is another complete text editor, intended to create and to edit the PDF's front cover page.
+
* '''First Page:''' Another rich text edit field, but in this case it allows to thedit the PDF cover page.
  
* '''Footer:''' It's the same like the two other fields, but for editing and creating each PDF page's footers.
+
* '''Footer:''' Rich text edit field where to edit the PDF footers.
  
 
====== Macros ======
 
====== Macros ======
  
It's also possible to use macros within the first page, the header and footer. The available implemented macros are the following:
+
To re-use edition templates, use the following macros:
  
* '''(_DATETIME_):''' In the data format configured within the Pandora Console options, this value is replaced by the date in the moment the report is generated.
+
* '''(_DATETIME_):''' It is replaced by the date when the report is generated. The format is that configures in Pandora FMS console general options.
* '''(_REPORT_NAME_)''': This value is going to be replaced by the report's name.
+
* '''(_REPORT_NAME_)''': It isreplaced by the report's name.
 +
* '''(_TIMEFROM_)''': It is replaced by the start date specified in the report.
  
 
==== The Preview Tab ====
 
==== The Preview Tab ====
  
This tab displays the report as if it's generated in HTML format to be able to easily review the results. It's going to display the report exactly as the one you're going to see if you click on 'Operation' and 'View Report' within the menu.
+
This tab displays the report as it is when generated in HTML format to be able to easily look at the results. It is displayed exactly as a user would see it in the report section.
  
=== Visualizing a Report ===
+
=== Viewing a report ===
  
In order to visualize an already created report, please click on ''Operation -> Reporting''.
+
Check the report list through ''Reporting > Custom Reporting''.
 
<center>
 
<center>
 
[[image:report_menu.png]]
 
[[image:report_menu.png]]
Line 1,322: Line 1,735:
 
</center>
 
</center>
  
Reports can be visualized in HTML, XML, CSV or PDF formats. Reports can be sent by email:
+
Reports can be displayed in HTML, XML, CSV or PDF formats.  
 +
 
 +
Through this view, you may also send by email. For that purpose, indicate the tardet address where to receive the report in PDF format. If you need to send it to several addresses, indicate the different addresses separated by commas:
  
 
<center>
 
<center>
Line 1,328: Line 1,743:
 
</center>
 
</center>
  
In order to see a report in the HTML format, please click on the [[image:pre46.png]] icon. Once the report is opened in HTML, it's possible to select the date and hour it was generated.
+
In order to see the report in the HTML format, click on the [[image:pre46.png]] icon.  
 +
 
 +
A programmed view will always be generated for the report. You may select other time frmase once the report is generated in HTML.
  
 
<center>
 
<center>
Line 1,334: Line 1,751:
 
</center>
 
</center>
  
In order to see a report in the XML format, please click on the [[image:pre48.png]]icon.
+
In order to see a report in the XML format, click on the [[image:pre48.png]]icon.
  
 
<center>
 
<center>
Line 1,341: Line 1,758:
 
<br><br>
 
<br><br>
  
In order to see a report in the PDF format, please click on the [[image:pre50.png]]icon.
+
In order to see a report in PDF format, click on the [[image:pre50.png]]icon.
  
 
<center>
 
<center>
Line 1,347: Line 1,764:
 
</center>
 
</center>
  
=== Automatic Report Scheduling ===
+
=== Automatic report scheduling ===
The Pandora FMS Enterprise version includes the CRON extension. This extension allows us to program different types of actions to be executed with a configurable periodicity.
+
The Pandora FMS Enterprise version includes the CRON extension. This extension allows to program different types of actions to be executed with a configurable periodicity.
  
Among the multiple options it offers, it allows us to configure the sending of reports in PDF format through e-mails.
+
Among the multiple options it offers, it allows to configure the sending of reports in PDF format through e-mails.
  
We will find this functionality in the menu entry ''Servers > Cron Jobs''.  
+
We will find this feature in the menu entry ''Servers > Cron Jobs''.  
  
  
Line 1,361: Line 1,778:
  
 
==== Automatic sending of a report by e-mail ====
 
==== Automatic sending of a report by e-mail ====
To send a report via email on a scheduled basis, use the console extension ''enterprise'' CRON with the following options:
+
To send a report via email on a scheduled basis, use the console extension ''Enterprise'' CRON with the following options:
  
;Task: Select ''send custom report by e-mail''. It will allow us to program the generation and sending of an already existing report.
+
;Task: Select ''send custom report by e-mail''. It will allow you to program the generation and sending of an already existing report.
;Scheduled: In this field we will specify the frequency with which the report will be sent.
+
;Scheduled: In this field specify the frequency with which the report will be sent.
;First Execution: In this field we will establish the date and time of the first execution.
+
;First Execution: In this field establish the date and time of the first execution.
;Report build: In this field we will select the report we want to send.
+
;Report build: In this field select the report you want to send.
 
;Send to mail: This field contains the e-mail address to which the report will be sent.
 
;Send to mail: This field contains the e-mail address to which the report will be sent.
  
Line 1,373: Line 1,790:
 
</center>
 
</center>
  
Once the data has been filled in, click on create and the task appears in the list of scheduled tasks.
+
Once the data has been filled in, click on create and the task will appear in the list of scheduled tasks.
 
<center>
 
<center>
 
[[image:pre53.png|650px]]
 
[[image:pre53.png|650px]]
Line 1,379: Line 1,796:
 
<br>
 
<br>
  
Once the task has been created, it is possible to force its execution by clicking on the circular icon to the left of the scheduled task. You can also edit or delete the scheduled task using the buttons on the right.
+
Once the task has been created, it is possible to force its execution by clicking on the circular icon to the left of the scheduled task. You may also edit or delete the scheduled task using the buttons on the right.
  
  
Line 1,386: Line 1,803:
 
==== Application and sending of report template by e-mail ====
 
==== Application and sending of report template by e-mail ====
  
To apply a template and send the result via email on a scheduled basis, we will use the console extension ''enterprise'' CRON with the following options:
+
To apply a template and send the result via email on a scheduled basis, use the console extension ''enterprise'' CRON with the following options:
  
;Task: Seleccionaremos ''Send custom report (from template) by e-mail'': Nos permitirá aplicar una plantilla de informe sobre agentes a nuestra elección, y programar su generación y envío.
+
;Task: Select ''Send custom report (from template) by e-mail'': It will allow to apply a report template about agents od your choosing and schedule their creation and sending.
 
;Scheduled: In this field we will specify the frequency with which the report will be sent.
 
;Scheduled: In this field we will specify the frequency with which the report will be sent.
;Next Execution: In this field we will establish the date and time of the next execution.
+
;Next Execution: In this field establish the date and time of the next execution.
;Template to build: In this field we will select the template of the report we want to generate.
+
;Template to build: In this field,, select the template of the report you want to generate.
;Agents: We will select the agents on which to apply the template.
+
;Agents: Select the agents on which to apply the template.
 
;Send to mail: This field contains the e-mail address to which the report will be sent.
 
;Send to mail: This field contains the e-mail address to which the report will be sent.
  
Line 1,403: Line 1,820:
 
For the email sending to work, it must be previously configured in Pandora FMS options.
 
For the email sending to work, it must be previously configured in Pandora FMS options.
  
To edit this configuration go to ''Configuration > Setup > Enterprise''.
+
To edit this configuration, go to ''Configuration > Setup > Enterprise''.
 
<center>
 
<center>
 
[[image:menu_config_enterprise.png]]
 
[[image:menu_config_enterprise.png]]
Line 1,415: Line 1,832:
  
 
== Report Templates ==
 
== Report Templates ==
 +
===Introduction===
 +
Report templates are components which allow to parametrize report creation. It also allows to apply them onto a set of agents and to easily create a lot of independent reports on different agent groups.
  
Report templates are components which allow you to parametrize the report's creation. It also allows you to apply them onto a set of agents and to easily create a lot of reports.
+
Each template element will look for matches with an agent and/or module through a regular expression or sub-string, making this system really trustworthy.
 
 
The report templates are components which allow you to parametrize the report creation that could be applied onto a group of agents and to quickly and easily create a big number of reports. Each element of the templates is going to match to an agent or module by a regular expression or substring, rendering this system very flexible.
 
  
 
<center>
 
<center>
Line 1,424: Line 1,841:
 
</center>
 
</center>
  
As you can see on the previous image, a report template will be created, containing elements or items. Each one of them is going to generate one or more report items. If they're applied, they fit to some agents or modules of the ones selected within that application.
+
As it can be seen on the previous image, a report template will be created, containing elements or items.  
 +
These defined elements are ''report items'' that could be defined for a report. The difference is that each of this ''template items'' will generate one or more ''report items'' as long as when applying the template, it matches some agent/module of those chosen in said application.
 +
 
 +
The following section describes a report template practical example, with three template item examples.
 +
 
 +
=== Examples ===
 +
 
 +
In order to access the report template go to 'Reporting' > 'Custom Reports' and click on the 'list templates' button:
  
 +
<center>
 +
[[image:report_menu.png]]
 +
</center>
  
The type of template items will be almost all the ones that are available within the reports, e.g. 'average value', 'SLA', 'agent events', etc.
+
Click on the ''Templates'' tab:
  
Now we're going to describe three examples of template items.
+
<center>
 +
[[image:list_templates.png]]
 +
</center>
  
=== Examples ===
 
  
In order to access the template's administration menu, please click on 'Operation' -> 'Reporting' -> 'Custom Reporting' and click on the 'list templates' button:
+
There you may see the complete list of templates defined in Pandora FMS console.
  
 +
<br><br>
 
<center>
 
<center>
[[image:template_main.png|800px]]
+
[[image:template_main.png|750px]]
 
</center>
 
</center>
 +
<br><br>
  
This template examples are containing three template items mentioned below:
+
In this example the template contains three template items:
  
* An automated combined graph which allows you to create graphs on the modules which coincide within the application.
+
* An automated combined graph which allows to create graphs on the modules that match within the application.
 
* A 'Top N' report.
 
* A 'Top N' report.
 
* An agent event report.
 
* An agent event report.
Line 1,449: Line 1,879:
 
</center>
 
</center>
  
=== Example 1: The Automated Combined Graph ===
+
=== Example 1: Automated Combined Graph ===
 +
 
 +
Creating combined graphs is an option within ''Reporting > Custom graphs'' which enables generating visual reports made of as many modules as needed.
 +
 
 +
This section allows defining a name for the graphic and other data such as frequency, graphic type or the weight of each of the modules.
 +
 
 +
<center>
 +
[[image:Combinedgraph1.png|750px]]
 +
</center>
 +
 
 +
<center>
 +
[[image:Combinedgraph2.png|750px]]
 +
</center>
  
This element is going to generate graphs to display the incoming network traffic of the selected agents. In order to do this, it's going to create combined graphs for each agent which holds a module name like "Network Traffic (Incoming)" and "Network Traffic (Outgoing)". Besides creating combined graphs, it's going to add them to the generated report.
+
<center>
 +
[[image:Combinedgraph3.png|750px]]
 +
</center>
 +
 
 +
Combined graphs enable establishing the order of each individual module by means of the “sort” option, featured in the option list.
 +
 
 +
<center>
 +
[[image:Combinedgraph5.png|750px]]
 +
</center>
 +
 
 +
The result of combined graphs clearly differences data from the selected different modules.
 +
 
 +
<center>
 +
[[image:Combinedgraph4.png|750px]]
 +
</center>
 +
 
 +
In the following example, combined graphs will be created for every agent whose module name is equal to "Disk Read Latency" and "Disk Write Latency".
 +
 
 +
Once the combined graphs are created, they will be added to the generated report.
  
 
<center>
 
<center>
Line 1,457: Line 1,917:
 
</center>
 
</center>
  
Within this example, we've decided to select a form to control the target modules. It's also possible to select the modules by using a regular expression, filling out the field 'Modules to match (Free text)'. For example, the regular expression .*cpu.* would be applied on modules like e.g. 'cpu_user', 'total_cpu_usage', 'cpu', etc.
+
Along this example, the target modules have been chosen, but the modules could also be selected through a regular expression, filling out the '''Modules to match (Free text)''' field. For example, the regular expression *cpu.* would be applied on modules such as: cpu_user, total_cpu_usage, cpu, etc.
  
Another important control for this type of template item is 'Create a graph for each agent' which allows the creation of a combined graph for each agent or to create a combined graph for all the agents an modules that coincide once it has been selected.
+
One of the available options is adding a dynamic '''label''' to the future report item. In this field, predefined macros will be able to be used to identify the item that will be generated. This is very useful when printing in PDF, since the report item that is searched in the menu can be certainly identified. Another important field of the form for this kind of model item is '''create a graph for each agent'''. Once activated, it will enable creating a combined graph for each agent. If disabled, the system will combine all data in a single combinated graph, where information about all matching agents and modules will be added.
  
 
=== Example 2: Top N ===
 
=== Example 2: Top N ===
  
This item is going to generate a report of the 'Top N' type, showing the most demanded 5 CPUs of the last day. This item applies to all agents with modules which contain the literal "CPU User" element.
+
This item will generate a report of the 'Top N' type, showing the highest 10 CPU usage values of the last day. This item applies to all agents with modules which contain the literal "CPU User" element.
  
 
<center>
 
<center>
Line 1,469: Line 1,929:
 
</center>
 
</center>
  
As you can see on the image, the modules are not going to be searched literally, but a regular expression is used here. This performance is selected by clicking on the box next to the agent's name ('exact match'). If you leave it blank, the agent's name is going to match on all agents selected during the application.
+
As shown in the image, the modules will not be searched literally, but a regular expression will be used here. This performance is selected by clicking on the verification checkbox next to the agent's name ('exact match').
 +
If left blank, the agent's name will match on all agents selected during template application.
  
 
=== Example 3: Agent Events ===
 
=== Example 3: Agent Events ===
  
This element is going to generate a report of the events generated on the last day for all selected agents.
+
This element will generate a report of the events generated on the last day for all selected agents.
  
 
<center>
 
<center>
Line 1,479: Line 1,940:
 
</center>
 
</center>
  
As you can see in the 'Agent' field, the regular expression '.*' has been used. It symbolizes any alphanumeric string, so it will be applied on any selected agent.
+
As you can see in the '''Agent''' field, the regular expression ".*" has been used. It symbolizes any alphanumeric string, so it will be applied on any selected agent.
  
=== Aplicando una plantilla ===
+
=== Applying a template ===
  
Una vez hayamos definido todos los ítems de plantilla que necesitemos podemos aplicar o ''instanciar'' esta plantilla a través de  dos métodos:
+
Once all the needed template items are defined, apply or ''instantiate'' this template through two methods:
  
==== Aplicación directa. ====
+
==== Direct application ====
Podremos aplicar y visualizar directamente un informe de plantilla haciendo clic en cualquiera de los iconos de formato que aparecen en la fila que ocupa nuestra plantilla:
+
A template report can be applied and viewed by clicking on any of the format icons that appear on the same row of the template:
  
 
<center>
 
<center>
Line 1,492: Line 1,953:
 
</center>
 
</center>
  
Se nos mostrará un pop-up donde podremos elegir los agentes sobre los que se aplicará esta plantilla de informe:
+
A pop-up will be shown, where the agents on which this report template will be applied may be chosen:
  
 
<center>
 
<center>
Line 1,498: Line 1,959:
 
</center>
 
</center>
  
==== Asistente de plantillas ====
+
==== Template wizard ====
Podemos hacer uso del asistente de plantillas - '''Template Wizard''' si necesitamos ''instanciar'' nuestra plantilla de informe en un informe real para tenerlo disponible en la lista de informes de Pandora FMS.
+
Use the Template Wizard if you need to ''instantiate'' your report template in a real report to have it available in the Pandora FMS report list.
  
  
Line 1,507: Line 1,968:
  
  
Podremos activar la casilla de verificación '''Create report per agent''' si queremos que se genere un informe por cada agente seleccionado. Si no lo activamos, se generará un informe general con toda la información.
+
Activate the checkbox '''Create report per agent''' if you want to generate a report for each selected agent. If you do not activate it, a general report will be generated with all the information.
  
* En caso de que se genere un informe por agente el título del informe será de la forma: [título de la plantilla] - [nombre agente] ([nombre agente])
+
* If a report is generated by an agent, the title of the report shall be as follows: [template title] - [agent name] ([agent name])
* En caso de que se genere un informe total el título será de la forma: [título del informe] - agents ([número de agentes]) - [fecha]
+
* In the event that a full report is generated, the title shall be as follows: [report title] - agents ([number of agentes]) - [date]
  
  
Line 1,517: Line 1,978:
 
</center>
 
</center>
  
 +
====Examples====
  
Para la gráfica combinada automática se creó un elemento de tipo "custom_graph". Esta gráfica tiene dos elementos para los módulos "Read Disk Latency" y "Write Disk Latency".
+
A "custom_graph" type element was created for the automatic combined graph. This graph has two elements for the modules "Read Disk Latency" and "Write Disk Latency".
  
 
<br><br>
 
<br><br>
Line 1,526: Line 1,988:
 
<br><br>
 
<br><br>
  
Editando la gráfica personalizada se ve que tiene los dos módulos:
+
Editing the custom graph, you can see that it has both modules:
  
 
<br><br>
 
<br><br>
Line 1,534: Line 1,996:
 
<br><br>
 
<br><br>
  
Para el informe Top N se creó un elemento con una expresión basada en el texto ''cpu''
+
For the Top N report, an element was created with an expression based on the ''cpu'' text.
  
 
<center>
 
<center>
Line 1,540: Line 2,002:
 
</center>
 
</center>
  
Visualizando el informe renderizado se ven las diez CPUs con mayor carga:
+
Displaying the rendered report shows the ten most loaded CPUs:
 +
 
  
 
<br><br>
 
<br><br>
Line 1,548: Line 2,011:
 
<br><br>
 
<br><br>
  
Para el informe de eventos del agente se crearán tres elementos (recordemos que se seleccionaron todos los agentes mediante .*):
+
Three elements will be created for the agent event report (remember that all agents were selected using .*):
  
 
<br><br>
 
<br><br>
Line 1,555: Line 2,018:
 
</center>
 
</center>
  
=== Editing the Template ===
+
=== Editing the template ===
  
Within the templates you're able to modify the general parameters of the template as shown on the picture below.
+
Within the template, you may modify the general parameters of the template as shown on the picture below.
  
 
<center>
 
<center>
Line 1,563: Line 2,026:
 
</center>
 
</center>
  
=== List of Templates ===
+
=== Template list ===
  
In order to access the template's list, please click on 'Administration' -> 'Manage Reports' -> 'Report Builder' and on the 'List Templates' button:
+
In order to access the template list, click on ''Reporting > Custom reports'':
  
 
<center>
 
<center>
[[image:template_main.png|800px]]
+
[[image:report_menu.png]]
 
</center>
 
</center>
  
In this section, you may create new templates, edit existing ones, copy and delete them.
+
Once there, click on ''Templates'':
  
=== The Items List ===
+
<center>
 +
[[image:list_templates.png]]
 +
</center>
  
In this section, you're able to review, edit, assort and delete items within a report template.
+
In that page you may see the full list of defined templates in Pandora FMS console.
 +
 
 +
<center>
 +
[[image:template_main.png|750px]]
 +
</center>
 +
 
 +
=== Item List ===
 +
 
 +
In this item list section, you may see and edit items created within a report template and modify their order besides deleting them.
  
 
<center>
 
<center>
Line 1,581: Line 2,054:
 
</center>
 
</center>
  
=== The Item Editor ===
+
=== Item Editor ===
 +
 
 +
This item editor section was designed to create new template items.
 +
 
 +
The item types are the same as in the report section, but with two differences: when applying it to an agent or module, this must be searched as a regular expression. For instance, ''oracle_agent[.]*'' can match agent names ''oracle_agent_1'', ''oracle_agent_2'', etc.
 +
 
 +
 
 +
If you left blank, this template item would be applied onto all selected agents when applying the report template.
 +
 
 +
[[#Applying_a_template | Applying a template]]
 +
 
 +
When a module is specified, this can be literally interpreted, activating the verification checkbox '''Module exact match'''. If disabled, it will use the regular expression standard match method.
  
This editor was designed to create new items. The item types are the same as in the report section, but with two differences: The agent's name is a regular expression, e.g.  'oracle_agent[.]*'. It's going to match to the agent's names 'oracle_agent_1', 'oracle_agent_2', etc. If you leave it blank, this item is going to be applied onto all selected agents within the [http://wiki.pandorafms.com/index.php?title=Pandora:Documentation_en:Data_Presentation#The_Template_Wizard '''The Template Wizard'''].
 
  
The module's name can be filled out by activating the check box named 'Module exact match' or by a regular expression without activating this particular check box.
 
 
<center>
 
<center>
 
[[image:template_agentevent.png|750px]]
 
[[image:template_agentevent.png|750px]]
Line 1,592: Line 2,074:
 
=== Advanced Options ===
 
=== Advanced Options ===
  
You may edit visual aspects for the results report like fonts, logos, headers, the first page or the report footer within this section.
+
Within this section, you may edit visual aspects for the resulting report like fonts, logos, headers, the first page or the report footer as done with a standard report.
  
 
<center>
 
<center>
Line 1,598: Line 2,080:
 
</center>
 
</center>
  
===The Template Wizard ===
+
=== Report Cleaning ===
You can do the instructions explained [[Pandora:Documentation_en:Data_Presentation/Reports#Application | here.]]
 
 
 
<center>
 
[[image:template_application.png|750px]]
 
</center>
 
<br><br>
 
 
 
=== Limpieza de informes ===
 
  
Para borrar los informes creados en aplicaciones anteriores de una plantilla desde el Wizard se puede seleccionar una plantilla y hacer clic en el botón para borrar (botón de la escoba).
+
To delete reports created in previous applications from a template from the Wizard, you can select a template and click on the delete button (broom button).
  
 
<center>
 
<center>
Line 1,615: Line 2,089:
 
<br><br>
 
<br><br>
  
Esta acción eliminará todos los informes creados basados en esta plantilla automáticamente.
+
This action will automatically delete all reports created based on this template.
  
 
[[Pandora:Documentation_en|Go back to Pandora FMS Documentation Index]]
 
[[Pandora:Documentation_en|Go back to Pandora FMS Documentation Index]]
  
 
[[Category: Pandora FMS]]
 
[[Category: Pandora FMS]]

Latest revision as of 09:31, 4 September 2020

Go back to Pandora FMS Documentation Index

Contents

1 Reports

Pandora FMS offers you the possibility of presenting the monitored data sorted out through reports.

Within a report, the information to be presented is organized in 'report elements. There are many different types of elements, which perform calculations and present the information in very different ways. For example, you may choose a "simple graph" type element that makes individual graphs or an "SLA" type element that shows the degree of compliance of a number of monitors.

Although they generally have a very similar configuration form, each type of element will be configured independently.

You may have as many elements as you want, of the type of your choosing.

1.1 Creating a Report

In order to add a report, click on Reporting > Custom reports.

Report menu.png

It will show a list containing all the reports. In order to create a report, click on "Create Report".

Pre18.png

There is a form where to enter the name of the report, select the group it belongs to, whether it is private or not and add its description.

Once the fields have been filled out, click on "Create".

Pre19.png

Once done, a blank report will appear, where you may edit it including new elements.

1.2 Editing a report

In order to edit a report, click on Reporting > Custom reports. It contains a list with all the created reports. In order to edit a report, click on the report's name.

Pre43.png

1.3 Deleting a report

In order to delete a report, click on Reporting > Custom reports. It contains a list where all the reports up to that moment are listed. In order to delete a report, click on the trash icon located at the right side of the report's name.

Pre44.png

1.4 Tabs

1.4.1 Main tab

The main tab is the only one available within a new report, since there one defines the report's basic data (name, access group and description). After saving it properly, you may access the rest of the tabs.

Main tab reporting builder.png

The fields belonging to this particular tab are the following:

  • Name: Intended to define the name of the form.
  • Group: Intended to define the access group displayed within the report.
  • Description: Intended for providing more report information to the users (which will be shown within the report's list). It will also be displayed on the report in XML and PDF formats.

1.4.2 The 'List Items' tab

In this tab, you have a global view of all items the report is made up by. The items contained in the list will be displayed in the same order as in the report later on. This tab provides the following options:

  • Modifying the item (by clicking on the wrench).
  • Modifying the order with the right side boxes and the drop-down "Sort items".
  • Modifying the order manually through the green arrows on the left.
  • Deleting the item by clicking on the red x-shaped icon.

If it is a long report that contains several items, it has a form at the top in order to filter the items by different criteria.

List items tab reporting builder.png

The columns belonging to this particular tab are the following:

  • P.: The items appear exactly in this column's order within the report.
  • Type: The column where the item's type appears.
  • Agent: The column that contains the agent's name. It can be empty for item types like SLA, custom graph, import texts from URL, SQL queries, simple graphs and texts.
  • Module: The column that contains the name of the module from which data will be obtained in order to generate the report. It may also be empty for item types like detailed agent view, alert report agent, custom graph, event report agent, import text from URL, SLA, SQL queries and text.
  • Period: The time period based on which the report is generated.
  • Description: The column displaying the description given to the item in order to make the work with it a little easier.
  • Options: The column that displays the buttons and icons to edit or to delete it.

1.4.3 Item Editor tab

Item Editor tab is more complex than the others, because there you will be able to create the form items or edit them. The form is dynamically designed, according to the type of item you intend to create. In the editing process, all fields except the type are editable. If you need to change the type, the way to do it is to delete the current one and generate a new one along with the same configuration.

The common fields for all types are the following:

  • Type: Drop-down list containing the types of items intended for the report, which determines the appropriate fields to configure this type of item by selecting the type: Agents, Modules, Agent Detailed View, Alert Report Agent, Alert Report Module, Avg. Value, Custom Graph, Event Report Agent, Event Report Module, Import text from URL, MTBF, MTTR, Max. Value, Min. Value, Monitor Report, SLA, SQL query, Serialized Data, Simple Graph, Summary, TTO, TTRT and Text
  • Description: Text box intended for a description of the report item.

1.4.4 Types of Items

You may add different items to the report, which can be:

1.4.4.1 Graph Items
1.4.4.1.1 Simple graph

It shows the simple graph of a module.

Simple graph - item editor tab - reporting builder.png



This form's fields are:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in the report item.
    • _agentgroup_ : Agent group selected in the report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : Name of the module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Period: Time interval over which the report will be calculated (from the current point in time).
  • Agent: Intelligent control to choose the agent for that item.
  • Module: Drop-down list that is dynamically loaded with the modules of the agent selected in the previous control.
  • Time comparison (overlapped): It shows the module graph overlapped in that time range, for example if the graph shows a 1 month span, the overlapped graph over it is the previous month.
  • Label: Label you can assign to an element. The following macros can be used: _agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.


Example of this type of report:

Pre39.png



1.4.4.1.2 Simple baseline graph

With this type of graph, you may see future estimation values for the selected module.Suppose you select a period of a week and today is Tuesday, this particular graph provides real data from Monday through Tuesday and estimation values for all other days within the selected week.

Baseline-form.png

The fields belonging to this particular form are the following:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in the report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : Name of the module selected in report item.
    • _moduledescription_ : Description of the agent module selected in report item.
  • Period: Time interval on which the report is calculated (from now onwards).
  • Agent: Intelligent control for selecting the appropriate agent for this item.
  • Module: A drop-down list which is dynamically loaded with the agent's modules selected in the control above.
  • Label: Label you can assign to an element. The following macros can be used: _agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.


Example view of this type of report:

Baseline-result.png


Template warning.png

This type of graph has the potential to overload Pandora FMS if you use too much data to generate future estimations.

 


1.4.4.1.3 Custom graph

It is a user-defined combined graph. A field is added with a combo to select the graph intended to add.

Custom graph - item editor tab - reporting builder.png

The fields within this form are the following:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : Name of the module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Period: The time interval on which the report is generated.
  • Custom Graph: A deployable list containing the user-defined graphs. In order to create theses graphs, click on Administration > Manage Reports > Graph Builder.

An example view of this type of report:

Pre26.png

1.4.4.1.4 Graphs defined from SQL

This type of report element allows custom graphs to be defined for use in reports. These graphs will be created using SQL code entered by the user. This SQL code should always return a variable called "label" for the text labels or name of the elements to be displayed and a field called "value" to store the numerical value to be represented. This is an example of SQL used to create graphs of this type:

SELECT a.name as `label`, count(st.id_agente_modulo) as `value`
FROM tagent_status st, tagent to
WHERE a.id_agent=st.id_agent AND (unix_timestamp(now()) - st.utimestamp) > st.current_interval * 2 group by 1;

For this example, there is this graph displayed where the number of modules in unknown status per agent is shown. It is quite similar to an SQL query, but it does not use headers, and it just needs the SQL code:

Sql graph pie.png




These are some examples of each of the three types of graphs that can be drawn with this tool: pie graphs, vertical bar graphs and horizontal bar graphs. In this example, several UTF (western latin, Japanese and Arabic) alphabet sets are used simply to show the multi-language capabilities of Pandora FMS.

Template warning.png

Due to security restrictions, there are some blocked words that cannot be used : *, DELETE, DROP, ALTER, MODIFY, password, pass, INSERT or UPDATE.

 


Info.png

This type of items must be handled with care, since they can overload Pandora FMS.

 


1.4.4.1.5 SQL pie graph

Example of pie graph for reports based on SQL query.

Report piegraph.png



1.4.4.1.6 SQL Vertical bar graph

Example of vertical bar graph for reports based on SQL query.


Report vgraph.png



1.4.4.1.7 SQL horizontal bar graph

Example of horizontal bar graph for reports based on SQL query.


Report hgraph.png


1.4.4.1.8 Availability graph

The availability report shows in detail the reached status of a module in a given time interval.

It will indicate all the relevant information about the time that this module has been available.

The time range you want the report about can be chosen (for example, the last month) and the working time if for example you need to indicate that you are only interested in the state of your module in a certain schedule (for example, 8x5, from 8:00 to 16:00 from Monday to Friday).

From Pandora FMS version 749, this kind of reports includes also the possibility of checking the box 24x7, which is under the working time. This way, the information will be collected without taking into account the working time configuration and being able to compare both cases, since it will show us 2 independent graphs.

It is also possible to determine a prioritization mode. When choosing the OK prioritization mode, if data in the SLA compliance range overlap in time and some other state (such as a planned stop), it will paint that stretch green. If the unknown prioritization mode option is chosen, the color corresponding to the other state will always be displayed.

Availability builder.png


After saving the report element data, add the desired modules at the bottom:

Availability builder item.png

Note: You can use the SLA min. and max. (value) to indicate that the calculations are made in relation to the values reached by the module in that range. SLA limit % will indicate the acceptable minimum (within that range).

If you do not specify a minimum or maximum for the value, the values of thresholds defined in the module (dynamic limits) will be used by default.


Viewing the report, you will see the availability graph of the chosen module in the selected time range:


Availability graph.png

Failover mode

This feature is used to assign failover or backup modules to the main module on which the calculation of availability must be made. That is to say, if a module has one or several failover modules assigned, the calculation of availability for a determined period will be done considering these modules.

When the measured main module falls, if there are one or several operative backup modules, these will be taken into account for the SLA calculation. That way it shows only the real service failure where primary and backups do not work.


How to add failover or backup modules:

It is done in the edition of the module on which the calculation of availability must be made, in the Module relations section:

Failover1.png

Select the module that will work as failover and select the type of relation that in this case is failover type.

Once the modules are assigned in the report, activate the option "failover mode":

Failover2.png

There are two types of visual representation:

  • Normal: It will show the graph of the main module, as well as all its failover or backup modules and the graph result.

Failover3.png

  • Simple: It will only show a graph that will be the result of the availability calculation of these modules.

Failover4.png

In the simple type "availability graph" reports, add the possibility of adding a failover module directly to the report as a simulation, this will work exactly the same as the previous ones.

Template warning.png

This is not applicable in the wizard or in the template reports.

 


Failover5.png

1.4.4.1.9 Module Histogram graph

It will show a graph with the status histogram of the chosen module.

Example of module definition:

Histogram build.png

Display example:

Histogram sample.png

1.4.4.2 SLA items

All SLA reports show information about the fulfillment of a metric, that is, they indicate the percentage of time that the module has had a known valid value.

All SLAs understand as valid the unknown periods, since Pandora cannot guarantee the module status if it does not have module data. Also, all periods in planned stop are considered valid (since in a planned stop situation, it is assumed that the module situation is controlled and accepted) and periods in warning status (the service is still provided in a non-optimal state).

As it will be seen later, some of the SLA reports present data grouped by time periods and the general status of these periods is calculated. When dealing with long periods, the module the report is being made on may have gone through many states: unknown, planned stop... In these reports, there is a configuration parameter called prioritization mode that determines which states have preference when summarizing. There are two options:

  • OK prioritization mode: The SLA compliance value prevails over the report non-run time, planned shutdowns, unknown time, and not started time.
  • Unknown prioritization mode: Any value other than OK will prevail. That way, you will see the non-operation times of the report, planned stops, unknown time and not started even if there is some data that makes the SLA comply.

Of course, if at any time the SLA compliance value is not reached, it will be painted red in any of the modes.

1.4.4.2.1 SLA

It allows you to measure the Service Level Agreement of any Pandora FMS monitor.

S.L.A. - item editor tab - reporting builder.png

The fields belonging to this particular form are the following:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : Name of the agent module selected in report item.
    • _moduledescription_ : Description of the agent module selected in report item.
  • Period: The time frame on which the report is generated (from the present time).
  • Working time: The time frame during which the SLA will be working. The graph will be fully shown, but it will only be calculated with the data within said working time frame. The SLA will be unknown (N/A) if the interval to be shown is excluded from the work interval. From Pandora FMS version 749, this kind of reports includes also the possibility of checking the box 24x7, which is under the working time. This way, the information will be collected without taking into account the working time configuration and being able to compare both cases, since it will show us 2 independent graphs.
  • Show graph, table or both: Select whether a SLA graph, a status summary or both elements will be shown.
  • Order: Order SLA items according to the chosen criteria.

Once these options have been selected, add each of the target modules based on which the SLA must be calculated:

Availability builder item.png

  • Agent: A combo box intended to select the agent to use in the SLA.
  • Module: A combo box intended to select the module to use in the SLA.
  • SLA min (value): A field intended to determine the SLA's minimum value. The minimum values will trigger the SLA. This field can be empty to use the acceptable minimum module normal values.
  • SLA max (value): An optional field intended to determine the SLA's maximum value. The maximum values will also trigger the SLA. It can be empty to use the acceptable maximum module normal values.
  • SLA Limit (%): A field intended to set the correct time percentage for the SLA. If the module has been within the minimum and maximum limit values during this particular time percentage, the SLA will be shown as correct and as wrong if not.

It is also possible to add new modules to the SLA to create combined-module SLAs from the same or different systems.


Template warning.png

In case of combined SLAs, SLA compliance will depend heavily on the performance of all the SLAs configured so far.

 


The SLA value will take into account only the critical status of the selected module and they will be labeled as valid.

  • Time in unknown.
  • Time in scheduled downtime
  • Time in warning status.
  • Time in OK status.

Why accept unknowns?

Unknown status is reached when Pandora FMS does not receive information from a certain target. In this situation, Pandora FMS cannot guarantee whether the service was provided as usual or not, so in the face of an unknown it is accepted.


When taking into account the SLA calculation shown in the report, you may configure scheduled downtimes (past or future) so that it does not take into account possible failures that could possibly take place during that interval of the scheduled downtimes. The value it will take in all the intervals where the scheduled downtimes is enabled is OK, as if during that intervals no incorrect data was received.

SLA 2.png

In this example it can be seen better. In the first image, there is a module data history with two intervals in critical status. Without scheduled downtime the SLA value is 93%.

SLA sinsch.png

After seeing that the first module downfall was due to external problems, ta scheduled task that covers that interval is added. When adding the scheduled task, the final estimation will take it as if the module's status was correct all along.

SLA consch.png


Note: If you forgot to create a scheduled downtime, you can create past scheduled downtimes given thatthe console administrator has enabled it.


1.4.4.2.2 Monthly SLA

This feature is only available for Pandora FMS Enterprise versions. It is a variation of the SLA feature. Instead of measuring the service level periodically, it does it every day during the months in this period.

Examples:

  • In a report of May 5th, it will calculate the SLA of every day in May.
  • In a report between February 13th and April 4th, it will calculate the SLA of every day in February, March and April.

Each module on each month will contain the same data of a standard SLA, except that its compliance will not be at month level. It will be the percentage of days that accomplish it. There is also a bar that will display all days of the month by the following color code:

  • Green: The SLA met.
  • Red: The SLA met.
  • Gray: Unknown. There is not enough data on that day.


Info.png

Days in unknown will be taken into account as valid data for the percentage of days that meet the SLA.

 


If there are days that do not meet the SLA, they will be detailed in a summary table.

S.L.A. Monthly - view.png

1.4.4.2.3 Weekly SLA

It displays the SLA of the modules chosen by weeks along the selected period (current month by default).

Sla weekly.png


It allows to edit the working time in case you have a custom service schedule (e.g. 8x5)

At the bottom, you may add multiple modules to this item.

View example:

Sla weekly sample.png

1.4.4.2.4 Hourly SLA

It displays the SLA of the modules chosen by hour along the selected period (current month by default).

Sla hourly.png


It allows to edit the working time in case you have a custom service schedule (e.g. 8x5)

At the bottom, you may add multiple modules to this item.

View example:

Sla hourly sample.png

1.4.4.2.5 Service SLA

It allows to measure the Service Level Agreement of any service created in Pandora FMS

S.L.A servicios.png

The fields found in this particular form are the following:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : Name of the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Period: Time frame based on which the the report will be evaluated from the present time backwards.
  • Working Time: Time to be taken into account for the SLA calculation (e.g. for working schedules like 8x5).

Since Pandora FMS services come with their own SLA readings, calculations for the report are different according to the standard performance.

In this case, you may only choose the service whose SLA you wish to receive from those services you have configured in your Pandora FMS console. The SLA validity limit values are recovered automatically from the definition of the service itself.

S.L.A servicios2.png

You can always set planned downtimes to adjust the compliance levels whenever you need so, so that possible downfalls are not taken into account.

These scheduled downtimes may be assigned to the modules that make the service whose report you wish to obtain, or its sub-services. In all intervals affected by downtimes, the states that the service could have reached will be overlooked, and that period will not be taken into account for the the final SLA calculation.


S.L.A total.png

In this example, you can see an outline of the final calculation of the service, depending on the scheduled downtimes (orange) and the critical states (red) of the modules on which the state of the final service for SLA calculation depends.

Looking at the image, when any of the modules have a downtime that directly affects the final service and this interval is omitted for final calculation.

1.4.4.3 Prediction Items
1.4.4.3.1 Prediction Date

This type of item returns the date when module reaches its interval using a data projection of a module to the future.

To do the calculations, the Least Squares Method is used.

In order to configure this item, you're required to provide the information shown below.

To configure this type of item, the following data must be provided:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : Name of the module name selected in report item.
    • _moduledescription_ : Description of the module that you selected in report item.
  • Period: The time period that wors as basis for the estimation.
  • Data Range: The interval where module data must be to return the date.
  • Label: Label the element can be assigned. The following macros can be used: _agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.

For instance, to check the moment a disk usage value between 60 and 100% for the mounting point /var will be reached, the following definition is used.

Projection graph5.png




That will generate the following output in this case:

Projection graph3.png


1.4.4.3.2 Projection Graph

This type of allows to asses the values a module will take in the future.

This estimation is based on Linear Regression and is implemented by means of the Least Squares Method.

Configure the following parameters accurately to get relevant results: The fields in this form are:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : Module name that you selected in report item.
    • _moduledescription_ : Description of the agent module selected in report item.
  • Period: The time period taken as basis for the estimation.
  • Projection Period: The future time period where data will be projected.
  • Label: Label you can assign to an element. The following macros can be used: _agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.

Projection graph periods.png

In the example image, the area name period represents the evolution of module data during the selected time interval.

On the other hand, projection period shows the possible evolution of the module along the selected time.

A definition example, complementary to the previous case is the evolution of the usage of the disk mounted on /var.

Projection graph6.png


Obtaining the following results:

Projection graphs.png

1.4.4.4 Module Items
1.4.4.4.1 Avg. Value

It is the average value for a module within a predefined period. This period is calculated when viewing the report. Within the configuration menu, the fields for the Source Agent are added, where the agent and modules are selected. Eventually, the module's average value is shown.

Avg value - item editor tab - reporting builder.png

The fields pertaining to this particular form are the following:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : Name of the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Period: The time period takes backwards from the time point when the report is generated.
  • Agent: The intelligent control to choose the appropriate agent for this item.
  • Module: A drop-down list which is dynamically loaded with the agent's modules selected in the previous control.
  • Calculate for custom intervals: It shows the average data in custom intervals.
  • Table / Graph options: Show table, graph or both.
  • Label: Label that can be assign to an element. The following macros can be used: _agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.

Within the HTML version of the report, an item of this type is generated as seen below.

Pre24.png

1.4.4.4.2 Max. Value

It is the maximum value of a module within a predefined period. This period is calculated at the moment of the report's viewing.

Max. Value - item editor tab - reporting builder.png

The fields of this particular form are the following:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent that you selected in report item.
    • _module_ : Name of the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Period: The time frame taken backwards from the time point when the report is generated.
  • Agent: An intelligent control for selecting the appropriate agent for the item.
  • Module: A deployable list dynamically loaded with the agent's modules selected in the previous control.
  • Calculate for custom intervals: It enables the possibility of showing the report in multiple sub-intervals.
  • Time lapse intervals: Lifespan of each sub-interval.
  • Table | graph | both: Show data of each value of each sub-interval on a graph or a table or both.
  • Label: Label an element can be assigned. The following macros can be used: _agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.

Viewing example:

Pre29.png

1.4.4.4.3 Min. Value

The minimum value of a module within a predefined period. This period is calculated right when the report is seen.

Min. Value - item editor tab - reporting builder.png

The fields belonging to this particular form are the following:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in the report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : Name of the agent module selected in report item.
    • _moduledescription_ : Description of the agent module selected in report item.
  • Period: Time interval taken based on which the report is calculated (from the present moment).
  • Agent: An intelligent control for selecting the appropriate agent for this item.
  • Module: Drop-down list which is dynamically loaded by the agent's modules selected in the previous control.
  • Calculate for custom intervals: It enables the possibility of showing the report in multiple sub-intervals.
  • Time lapse intervals: Lifespan of each sub-interval.
  • Table | graph | both: Show the data od each sub-interval on a table, a graph or both.
  • Label: Label an element can be assigned. The following macros can be used: _agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.

Viewing example:

Pre30.png

1.4.4.4.4 Monitor Report

It shows the time percentage a module has been correct or incorrect within a predefined period.

Monitor report - item editor tab - reporting builder.png

The fields pertaining to this particular form are the following:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in the report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : Name of the agent module selected in report item.
    • _moduledescription_ : Description of the agent module selected in report item.
  • Period: Time interval taken based on which the report is calculated (from the present moment).
  • Agent: An intelligent control for selecting the appropriate agent for this item.
  • Module: Drop-down list which is dynamically loaded by the agent's modules selected in the previous control.
  • Calculate for custom intervals: It enables the possibility of showing the report in multiple sub-intervals.
  • Time lapse intervals: Lifespan of each sub-interval.
  • Table | graph | both: Show the data od each sub-interval on a table, a graph or both.
  • Label: Label an element can be assigned. The following macros can be used: _agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.

Within the HTML version of the report, an item of this type is generated as you can see below.

Pre32.png

1.4.4.4.5 Serialize Data

It displays an item in table format report from the data stored within the table named 'tagente_datos_stringin' the Pandora FMS Database. For it, the agent should serialize the data separating them with a line-separating character and another which separates the fields. All lines should contain all fields. This type of item is e.g. used for the agent which is designed to extract management data from the SAP Platform.

Serialize data - item editor tab - reporting builder.png

The fields pertaining to this particular form are the following:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in the report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : Name of the agent module selected in report item.
    • _moduledescription_ : Description of the agent module selected in report item.
  • Period: Time interval taken based on which the report is calculated (from the present moment).
  • Agent: An intelligent control for selecting the appropriate agent for this item.
  • Module: Drop-down list which is dynamically loaded by the agent's modules selected in the previous control.
  • Serialized Header: A text field where the table headers shown in the report are separated by the '|' (pipe) character. There is one for each column created when separating the assembled field.
  • Field Separator: A separator intended for different fields within the serialized text chain.
  • Line Separator: A separator intended for different lines (made up by different fields) of the serialized text strings.
  • Label: Label assigned to an element. The following macros can be used: _agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.


The module that generates the following report returns lines with the following contento:

Some text sample|some value#this is a new row|and another value

When generating a report from that content, the output is the following:

Serialize sample.png


1.4.4.4.6 Summatory

It displays the sum of a single module's values within a specific time frame.

Sumatory - item editor tab - reporting builder.png

The fields of this form are:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in the report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : Name of the agent module selected in report item.
    • _moduledescription_ : Description of the agent module selected in report item.
  • Period: Time interval taken based on which the report is calculated (from the present moment).
  • Agent: An intelligent control for selecting the appropriate agent for this item.
  • Module: Drop-down list which is dynamically loaded by the agent's modules selected in the previous control.
  • Label: Label an element can be assigned. The following macros can be used: _agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.

This is a display example:


Pre40.png

1.4.4.4.7 Historical Data

This type of element will serve to receive a dump of the stored data of the module indicated in the configuration of the report.

Configure the following fields:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in the report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : Name of the agent module selected in report item.
    • _moduledescription_ : Description of the agent module selected in report item.
  • Period: Time interval taken based on which the report is calculated (from the present moment).
  • Agent: An intelligent control for selecting the appropriate agent for this item.
  • Module: Drop-down list which is dynamically loaded by the agent's modules selected in the previous control.
  • Label: Label an element can be assigned. The following macros can be used: _agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.

Historical.png

Example of report display:

Historical sample.png

1.4.4.4.8 Increment

This type of report element is used to show a brief analysis where the value variation of the indicated module is detailed.

Configure the following fields:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in the report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : Name of the agent module selected in report item.
    • _moduledescription_ : Description of the agent module selected in report item.
  • Period: Time interval taken based on which the report is calculated (from the present moment).
  • Agent: An intelligent control for selecting the appropriate agent for this item.
  • Module: Drop-down list which is dynamically loaded by the agent's modules selected in the previous control.

Increment.png

Example of report display:

Increment sample.png

1.4.4.4.9 Last Value

It is the last value for a module within a predefined period. This period is calculated when viewing the report. Within the configuration menu, the fields for the Source Agent are added, where the agent and modules are selected. Eventually, the module's last value is shown.

The fields pertaining to this particular form are the following:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : Name of the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Agent: The intelligent control to choose the appropriate agent for this item.
  • Module: A drop-down list which is dynamically loaded with the agent's modules selected in the previous control.
  • Show item in landscape format {only PDF}: allow to display the report in landscape format only in PDF.
  • Page break at the end of the item {only PDF}: generate a page break at the end of the element in PDF only.

Within the HTML version of the report, an item of this type is generated as seen below.

LastValueReport.png

1.4.4.5 Grouped Items
1.4.4.5.1 General

Shows values from different modules sorted (ascendingly, descendingly or by agent name) or/and grouped by agent.

We will configure the following fields:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in the report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : Name of the agent module selected in report item.
    • _moduledescription_ : Description of the agent module selected in report item.
  • Time lapse: Interval of time on which the report will be calculated (from the current moment).
  • Last value: Show only the last reading of the chosen modules.
  • Agent: The intelligent control to choose the agent for this item.
  • Module: drop-down list that is dynamically loaded with the modules of the agent selected in the previous control.
  • Group by agent: Group report metrics by agent.
  • Order: Order in which the metrics will be shown.
  • Show summary: Display a final summary with the average, maximum and minimum values.
  • Show in the same row: Show all operations (max, min, avg or sum) in the same row.

Grouped general.png

Example of report display:

Grouped general sample.png

1.4.4.5.2 Group Report

It displays a table containing the below mentioned information of a predefined group:

  • Agents
    • The total number of agents.
    • The number of agents holding 'unknown' status.
  • Modules
    • The total number of modules.
    • The number of modules holding 'normal' status.
    • The number of modules holding 'critical' status.
    • The number of modules holding 'warning' status.
    • The number of modules holding 'unknown' status.
    • The number of modules holding 'not initiated' status.
  • Alerts
    • The number of defined alerts.
    • The number of triggered alerts.
  • Events
    • The number of this group's events within the last 8 hours.

Group-report-from.png

The fields belonging to this particular form are the following:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : NAme od the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Group: Combo intended to select the group.
  • Recurse: Analyze recursively the child groups of the choosen group.

Report view example:

Group-report-result.png

1.4.4.5.3 Exception

It shows values of several modules that comply with logical operations (higher or equal, lower, OK or Not OK).

Report last value exc.png

The following fields can be configured:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : NAme od the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Time lapse: Interval of time based on which the report will be calculated (from the present moment).
  • Last value: Show only the last reading of the chosen modules.
  • Order: Order in which metrics will be show.
  • Value: Value considered with the chosen condition.
  • Condition: Condition under which to filter the report data. "Everything" ignores filtering.
  • Show summary: Display a final summary with the average, maximum and minimum values.
  • Show in the same row: Show all operations (max, min, avg or sum) in the same row.

You may add at the bottom as many modules as you need once the report element is saved:

  • Agent: Intelligent control to choose the agent for this item.
  • Module: Drop-down list that is dynamically loaded with the modules of the agent selected in the previous control.

Example of report display:

Exception - item editor tab - reporting builder.png

1.4.4.5.4 Agents / Modules

It displays a matrix of agents and modules of a specific module group along with its associated states.

Agents-modules - item editor tab - reporting builder.png

1.4.4.5.5 SQL queries

This item shows in Pandora FMS DB data reports, a table to keep custom data retrieved directly from the DB.

Template warning.png

This type of items must be carefully used, since they can overload Pandora FMS.

 


The fields of this form are:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : NAme od the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • SQL Query: Text box where to write the SQL query to retrieve data from Pandora FMS DB.
  • Serialized header: Text field where to put separated by | the headers of the table that will be shown in the report, for each column that came out as a result in the SQL query.
  • Custom SQL template: A drop-down list containing SQL templates of saved queries for easy use. These can be managed through Administration > Manage reports in Custom SQL.
  • Query History Database: Checkbox that when checked will make the edited SQL query also collect data from the historical database.

The queries that will appear in the report can be customized by choosing one of the following options:

  • Type in manually the query to perform in the text field.

Note: Due to security restrictions, there are some reserved words that cannot be used: DELETE, DROP, ALTER, MODIFY, password, pass, INSERT or UPDATE.


Custom sql report.png


  • Or, you may select a query from the list using the Custom SQL template drop-down:

Custom sql template report.png


Example of report display:

Custom sql report sample.png



Note: You may define your own templates in the menu Reporting > Custom SQL.

Custom sql menu.png


In the query list view, you can create your new stored query by pressing the button Create custom SQL:

Custom sql list.png

Define your query and a name to identiy it and press "Save" for it to appear on the list:

Custom sql new.png

1.4.4.5.6 Top N

It displays N values sorted out by maximum, minimum or average redarding the selected modules, ordered upward, downward or by name.

Report topn.png

Report view example:

Report topn sample.png

1.4.4.5.7 Network interfaces

This type of report element will generate the interface graphs of all those devices that belong to the selected group.

Report net interfaces.png


You may indicate:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : NAme od the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Time lapse: Time range taken backwards over which the report will be made (e.g. one month from the chosen date).
  • Group: Group where agents with interface traffic modules will be searched.
  • Full resolution graph (TIP): Use the TIP real data drawing system instead of the standard motor.


Note: An agent shall be considered to have interface traffic data when it has modules with the following format:

  • Name of interface_ifInOctects
  • Name of interface_ifOutOctects
  • Name of interface_ifOperStatus

Note: Input/output octet counters can also be collected from HC counters (hcOctets).


Example of report display:

Report net interfaces sample.png

1.4.4.5.8 Availability

The feature of this type of report has been widely improved, so that now the data it represents are not approximations but an accurate reflection of the module situation throughout the selected period.

This item shows a table with the availability data of a selected list of agents and modules.

It also offers the possibility of showing a summary including those modules with higher and lower availability as well as an average analysis.

Report availability.png


The following fields can be customized:

The fields of this form are:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : NAme od the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Period: Time interval based on which the report will be calculated (from the present moment).
  • Working time: Time period the module should have been working. The graph will be complete, but it will only be calculated based on the working time data. Availability will be unknown (N/A) if the interval to show is out of the working interval. From Pandora FMS version 749, this kind of reports includes also the possibility of checking the box 24x7, which is under the working time. This way, the information will be collected without taking into account the working time configuration and being able to compare both cases, since it will show us 2 independent graphs.
  • Show address instead of module name.Show the agent's main address.: It will show the agent's main IP instead of the name.
  • Show summary: Show a final summary.
  • Orden: Order the availability items according to the selected criteria.
  • Hide not init agents: Hide from the view non-initiated agents.


Once these options have been selected, add each of the target modules over which the SLA must be calculated:

Report availability add module.png

  • Agent: Combo where to indicate the agent to which the report must be applied.
  • Module: In a combo, the module of the previously set agent over which the SLA will be calculated.


Report view example:

Report availability sample.png


It shows the following information:

  • Agente: Agent.
  • Module / IP address: When configuring the item, you may choose whether to see the agent's main IP instead of that of the module. Very useful for reports that contain a list of agents and IPs instead of agents and ping modules.
  • Total time: Total time to anaylize.
  • Time failed: Time in critical status.
  • Time OK: Time in OK or warning status.
  • Time Unknown: Time in unknown status.
  • Time Not init: Non-initiated time.
  • Time downtime: Time in scheduled downtime.
  • %OK: Correct status time percentage.
  • Total checks: Total checks done during the time lapse configured in the report.
  • Checks failed: Number of failed checks (critical).
  • Checks OK: Number of correct checks.
  • Checks Unknown: Approximation based on events and Pandora FMS logic that allows to point out the number of checks that should have been carried out, but from which there is no answer.
1.4.4.6 HTML and Text Items
1.4.4.6.1 Text

This item displays a formatted text within the reports to add e.g. more information of the company to the report.

Text report module - item editor tab - reporting builder.png

The fields of this particular form are the following:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : NAme od the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Text: A text box intended to format the text and add links and images from a remote server.

An example of the window where the link is added is shown below.

Edit link - report builder.png

Screenshot example of the window where to add the image:

Edit image - report builder.png

You may add any html content to this element.

Report view example:

Html text sample.png



1.4.4.6.2 Import text from an URL

This item shows the text retrieved from an external server to which the Pandora FMS Console has access to. In the HTML report format, it will be displayed as it is, but the PDF version of the report will show the text in plain-text format.

Import text from URL - item editor tab - reporting builder.png

The fields belonging to this particular form are the following:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : NAme od the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • URL: The text field intended to enter the external server address in order to extract the text.
1.4.4.7 Alert Items
1.4.4.7.1 Alert Report Agent

It displays a list containing the alerts triggered by the report group agents within a predefined period.

Alert report agent - item editor tab - reporting builder.png

The fields within this form are the following:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : NAme od the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Period: The time frame taken backwards based on which the report is generated (e.g. one month from the seleted date).
  • Agent: Intelligent control for selecting the appropriate agent for the item.
  • Label: Label assigned to an element. The following macros can be used: _agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.

Report example:

Pre23.png

1.4.4.7.2 Alert report module

It displays a list containing the module's triggered alerts within a predefined period intended for the report.

Alert report module - item editor tab - reporting builder.png

The fields contained in this particular form are the following:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : NAme od the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Period: The time frame taken backwards based on which the report is generated (e.g. one month from the selected date).
  • Agent: Intelligent control to select the appropriate agent for this item.
  • Module: A drop-down list which is dynamically loaded by the agent's modules selected in the previous control.
  • Label: Label the element can be assigned. The following macros can be used: _agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.
1.4.4.7.3 Alert report group

It shows a list with the alerts launched in any element of the group defined in the report in the defined period.

ReportGroupAlert.png



The following fields are to be configured:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : NAme od the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Time lapse: Time range taken backwards based on which the report is generated (e.g. one month from the chosen date).
  • Group: Group on which the alert triggering information will be analysed.
  • Recursion: Analyze the child groups of the recursively defined group.

ReportGroupAlertExample.png

1.4.4.8 Event Items
1.4.4.8.1 Event Report Agent

It shows a list containing the events that took place within the agents in the predefined time frame.

Event report agent - item editor tab - reporting builder.png

The fields pertaining to this particular form are the following:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : NAme od the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Period: The time frame taken backwards based on which the report is generated (e.g. one month from the chosen date).
  • Agent: Intelligent control to select the appropriate agent for this item.
  • Severity, event type, event status: Selecct the types of events to see.
  • Event graphs: Show event summary graphs.
  • Label: Label an element can be assigned. The following macros can be used: _agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.

Report view example:

Pre27.png

1.4.4.8.2 Event Report Module

It displays a list containing the events that took place within an agent's module in the report of a predefined time frame.

Event report module - item editor tab - reporting builder.png

The fields pertaining to this particular form are the following:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : NAme od the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Period: The time frame taken backwards based on which the report is generated (e.g. one month from the selected date).
  • Agent: Intelligent control to select the appropriate agent for the item.
  • Module: Drop-down list that is dynamically loaded with the agent's modules selected in the control above.
  • Severity, event type, event status: Select the type of events to see.
  • Event graphs: Show event summary graphs.
  • Label: Label an element can be assigned. The following macros can be used: _agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.

Report view example:

Report module events sample.png

1.4.4.8.3 Event Report Group

It displays a list containing the events which took place in the report group's agents within a predefined time frame.

Event-report-group-from.png

The fields belonging to this particular form are the following:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : NAme od the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Period: The time frame taken backwards based on which the report is generated (e.g. one month from the selected date).
  • Group: Combo intended to select the group.
  • Severity, event type, event status: Select the type of events to see.
  • Event graphs: Show event summary graphs.ç

Within the HTML version of the report, an this type of item is generated:

Event-report-group-result.png

1.4.4.9 Inventory Items
1.4.4.9.1 Inventory

This item can be found in the Enterprise version of Pandora FMS. It displays the selected inventory from one or several hosts belonging to a specific date or its last known data.

Inventory item form.png

The fields that belong to this particular form are the following:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : NAme od the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Description: Text field intended for the item's description.
  • Group: Combo that filters the agents that appear within the next field. It does not appear in the report, it is only a form tool.
  • Agents: The agents of the machines the inventory is taken from. Only the agents with inventory modules will appear in this field.
  • Modules: The common inventory modules of the selected agents.
  • Date: The date of the displayed data. If the last date is selected here, only the latest inventory data of the selected modules will be gathered.

Inventory report sample.png

1.4.4.9.2 Inventory changes

This item displays the changes of the inventory registered in one of several hosts within a predefined time frame.

Inventory changes form.png

The fields pertaining to this particular form are the following:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : NAme od the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Description: A text field intended for the item's description.
  • Period: A field to determine the interval for registering the changes.
  • Group: Combo that filters the agents that appear within the next field. It does not appear in the report, it is only a form tool.
  • Agents: Agents of the hosts where the inventory will be gathered. Only the agents containing inventory modules will appear within this field.
  • Modules: The common inventory modules of the selected agents.


Info.png

The data for this item are solely provided by inventory changing events. If the item is too big, you may delete some of those events manually to reduce it.

 


Report view example:

Inventory changes report sample.png

1.4.4.10 Configuration Items
1.4.4.10.1 Agent Configuration

This type of report will show a picture of the agent status:

Agent configuration report.png

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : NAme od the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Label: Label an element can be assigned. The following macros can be used: _agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.


Display example:

Agent configuration report sample.png



1.4.4.10.2 Group options

This type of report will show a picture of the status of the agents that belong to the selected group:


Group configuration report.png


Display example:

Group configuration report sample.png

1.4.4.11 Netflow Items
1.4.4.11.1 Netflow area chart

This report element will display a graph with the traffic analysis using filters already created in Netflow view.


Netflow area.png


Example of report display:

Netflow area sample.png



1.4.4.11.2 Netflow pie chart

This element shows a pie chart with the results of applying the filter indicated by the user.

Netflow pie.png


Example of report display:

Netflow pie sample.png



1.4.4.11.3 Netflow data chart

This element shows the data obtained by applying the filter indicated by the user in a table sorted by date and origin.

Netflow datachart.png


Example of report display:

Netflow datachart sample.png



1.4.4.11.4 Netflow statistics chart

This report item will display a table with the grouped value of the traffic, using filters already created in the Netflow view.

Netflow statistics.png


Example of report display:

Netflow statistics sample.png



1.4.4.11.5 Netflow summary chart

This report item will display a table with summarized traffic information that matches the Netflow filter specified in the Filter parameter.

Netflow summary.png


Example of report display:

Netflow summary sample.png

1.4.4.12 Log Items
1.4.4.12.1 Log Report

This report type displays the log entries in the selected period.

Log report build.png

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : NAme od the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Search: Text string to be searched.
  • Log number: Maximum number of log block entries to be shown when generating this report.
  • Time lapse: The time range taken backwards based on which the report will be drawn up (e.g. one month from the chosen date).
  • Source: Log source.
  • Agents: Filtering agents.


Example of report display:

Log report.png

1.4.4.13 Network items
1.4.4.13.1 Network traffic Top N

This report shows a top-N of network consumption in the last X days of all IP analyzed by Pandora NTA:


Network traffic topN.png

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : NAme od the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Time lapse: the time range taken backwards based on which the report will be drawn up (e.g. one month from the chosen date).
  • Quantity(n): Number of elements to be shown.

Pandora NTA sample report 1.png

1.4.5 General wizard

This tab allows to automatically create a complete report with just a few clicks. By applying common configurations you may generate alements applied to multiple agents and/or modiles. This is an Enterprise feature.

Once the type, the period, the agents and the modules have been selected, click on 'Add' and it will generate as many items as agents or modules have been selected for the report.

Wizard-tab-reporting builder.png

The fields belonging to this particular form are the following:

  • Name: The following macros can be used:
    • _agent_ : Name of the agent selected in report item.
    • _agentdescription_ : Description of the agent selected in report item.
    • _agentgroup_ : Group of the agent selected in report item.
    • _address_ : Address of the agent selected in report item.
    • _module_ : NAme od the agent module selected in report item.
    • _moduledescription_ : Description of the module selected in report item.
  • Type: A drop-down list where you may select the mass-generated type of item. Certain item types that require more detailed configuration are excluded. The available item types within this form are: Alert Report Agent, Alert Report Module, AVG Module, Event Report Agent, Event Report Module, Monitor Report, Simple Graph and Availability
  • Time interval: Time interval based on which the report is created (from the present moment).
  • Filter Group: A field intended to filter agents by group.
  • Agents: Multi selector with the list of available agents for the user.
  • Modules: Multi selector with the list of modules common to the selected ahents.
  • Elements to apply: Selected module list. Report items will be added to the elements of this list.
  • Label: Label an element can be assigned. The following macros can be used: _agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.
  • Name: Name an element can be assigned. The following macros can be used: _agent_, _agentdescription_, _agentgroup_, _address_, _module_, _moduledescription_.
  • Time lapse: The time range taken backwards based on which the report will be drawn up (e.g. one month from the chosen date).

Report view example (availability):

Wizard report availability sample.png



1.4.6 The SLA Wizard Tab

This wizard allows to create SLA report items automatically.

You may choose different SLA analyses:

  • SLA: It displays a standard SLA reporting element, indicating the % of compliance in the selected period.
  • Monthly SLA: It will show a day by day analysis of the selected month, indicating the compliance %.
  • Weekly SLA: It will show an analysis of the compliance % week by week, indicating at all times the daily value.
  • Hourly SLA: It will display an hourly analysis of the selected period.
  • Availability graph: A graph will be generated with the availability data of the selected modules.
  • SLA services: A new reporting element representing the calculation of the SLAs of the selected services will be created.


You will be able to choose the validity value ranges of the modules to be selected. This feature will allow you to check the % of time that a module has maintained values within specific ranges.

If you do not define thresholds, they will be dynamically adjusted to the criticality thresholds of each module.


Other options can be found:

  • Time lapse: This is the range, or period of time over which the report renders the information for this report type. For example, a week means data from a week ago from now.
  • Show graph: Only basic SLA. It allows to choose whether to display a table with the data, a graph, or both.

Wizard sla skel.png


Example of report display:

Report avail1.png



1.4.7 Global

This section is where Exception, General or Top N elements can be easily created thanks to a wizard.

  • Exception: This shows values of several modules that meet a logical operation.
  • General: It shows values of several modules ordered (upward, downward, by agent name) or/and grouped by name.
  • Top N: It shows N values sorted out by maximun, minimun or average over the total of modules selected, ordered upward, downward or by agent name.

That way you may add different modules from different agents, while you can also choose the operation to be performed in each module: addition, average, min and max.

Global2.jpg


Example of report view:

Wizard global sample.png

1.4.8 Report advanced options

This report advanced configuration tab allows to edit some of its visual aspects such as:

  • Customize font.
  • Select a logo to use in the headers of the PDF files.
  • Edit the header and footer of each page.
  • Edit the report's cover.

Advance options-tab-reporting builder.png

  • Family font: The default font is Times New Roman. If you want to customize the font type, select the desired one from the drop-down list.

Note: This list is built on the basis of the 'ttf' files found in the directory:

/var/www/html/pandora_console/enterprise/include/mpdf50b/ttfonts

You may add font files in TTF format to that directory. They must have the correct permissions for the user that provides the web service to have access to thos files. By default apache:apache in CentOS based systems. Pandora FMS includes the "code" fotn that displays all existing characters in UTF8.

  • Custom Logo: pandora_logo.jpg is used by default. You may select from the drop-down list any of the possible logos to decorate the header of each PDF page.

Note: This list is built based on the image files found at the following directory:

/var/www/html/pandora_console/images/custom_logo/

You may add the image files to that directory. They must have the correct permissions for the user that provides the web service to have access tp those files. By default apache:apache in CentOS based systems.

  • Header: It is a rich text editor where to copy and paste formatted text from an office application or edit on site. This text will be displayed at each page's header.
  • First Page: Another rich text edit field, but in this case it allows to thedit the PDF cover page.
  • Footer: Rich text edit field where to edit the PDF footers.
1.4.8.1 Macros

To re-use edition templates, use the following macros:

  • (_DATETIME_): It is replaced by the date when the report is generated. The format is that configures in Pandora FMS console general options.
  • (_REPORT_NAME_): It isreplaced by the report's name.
  • (_TIMEFROM_): It is replaced by the start date specified in the report.

1.4.9 The Preview Tab

This tab displays the report as it is when generated in HTML format to be able to easily look at the results. It is displayed exactly as a user would see it in the report section.

1.5 Viewing a report

Check the report list through Reporting > Custom Reporting.

Report menu.png

In this section you can see the created reports or create new.

Report list.png

Reports can be displayed in HTML, XML, CSV or PDF formats.

Through this view, you may also send by email. For that purpose, indicate the tardet address where to receive the report in PDF format. If you need to send it to several addresses, indicate the different addresses separated by commas:

Send email.png

In order to see the report in the HTML format, click on the Pre46.png icon.

A programmed view will always be generated for the report. You may select other time frmase once the report is generated in HTML.

Pre47.png

In order to see a report in the XML format, click on the Pre48.pngicon.

Pre49.png



In order to see a report in PDF format, click on the Pre50.pngicon.

Pre51.png

1.6 Automatic report scheduling

The Pandora FMS Enterprise version includes the CRON extension. This extension allows to program different types of actions to be executed with a configurable periodicity.

Among the multiple options it offers, it allows to configure the sending of reports in PDF format through e-mails.

We will find this feature in the menu entry Servers > Cron Jobs.


Cron menu.png


1.6.1 Automatic sending of a report by e-mail

To send a report via email on a scheduled basis, use the console extension Enterprise CRON with the following options:

Task
Select send custom report by e-mail. It will allow you to program the generation and sending of an already existing report.
Scheduled
In this field specify the frequency with which the report will be sent.
First Execution
In this field establish the date and time of the first execution.
Report build
In this field select the report you want to send.
Send to mail
This field contains the e-mail address to which the report will be sent.

Pre52.png

Once the data has been filled in, click on create and the task will appear in the list of scheduled tasks.

Pre53.png


Once the task has been created, it is possible to force its execution by clicking on the circular icon to the left of the scheduled task. You may also edit or delete the scheduled task using the buttons on the right.




1.6.2 Application and sending of report template by e-mail

To apply a template and send the result via email on a scheduled basis, use the console extension enterprise CRON with the following options:

Task
Select Send custom report (from template) by e-mail: It will allow to apply a report template about agents od your choosing and schedule their creation and sending.
Scheduled
In this field we will specify the frequency with which the report will be sent.
Next Execution
In this field establish the date and time of the next execution.
Template to build
In this field,, select the template of the report you want to generate.
Agents
Select the agents on which to apply the template.
Send to mail
This field contains the e-mail address to which the report will be sent.

Cron report template.png



1.6.3 Configuration

For the email sending to work, it must be previously configured in Pandora FMS options.

To edit this configuration, go to Configuration > Setup > Enterprise.

Menu config enterprise.png

You will need to configure the email section at the bottom of the page correctly:

Menu config enterprise mail.png

2 Report Templates

2.1 Introduction

Report templates are components which allow to parametrize report creation. It also allows to apply them onto a set of agents and to easily create a lot of independent reports on different agent groups.

Each template element will look for matches with an agent and/or module through a regular expression or sub-string, making this system really trustworthy.

Templates1.png

As it can be seen on the previous image, a report template will be created, containing elements or items. These defined elements are report items that could be defined for a report. The difference is that each of this template items will generate one or more report items as long as when applying the template, it matches some agent/module of those chosen in said application.

The following section describes a report template practical example, with three template item examples.

2.2 Examples

In order to access the report template go to 'Reporting' > 'Custom Reports' and click on the 'list templates' button:

Report menu.png

Click on the Templates tab:

List templates.png


There you may see the complete list of templates defined in Pandora FMS console.



Template main.png



In this example the template contains three template items:

  • An automated combined graph which allows to create graphs on the modules that match within the application.
  • A 'Top N' report.
  • An agent event report.

Templates list items1.jpeg

2.3 Example 1: Automated Combined Graph

Creating combined graphs is an option within Reporting > Custom graphs which enables generating visual reports made of as many modules as needed.

This section allows defining a name for the graphic and other data such as frequency, graphic type or the weight of each of the modules.

Combinedgraph1.png

Combinedgraph2.png

Combinedgraph3.png

Combined graphs enable establishing the order of each individual module by means of the “sort” option, featured in the option list.

Combinedgraph5.png

The result of combined graphs clearly differences data from the selected different modules.

Combinedgraph4.png

In the following example, combined graphs will be created for every agent whose module name is equal to "Disk Read Latency" and "Disk Write Latency".

Once the combined graphs are created, they will be added to the generated report.

Template automatic graph.png

Along this example, the target modules have been chosen, but the modules could also be selected through a regular expression, filling out the Modules to match (Free text) field. For example, the regular expression *cpu.* would be applied on modules such as: cpu_user, total_cpu_usage, cpu, etc.

One of the available options is adding a dynamic label to the future report item. In this field, predefined macros will be able to be used to identify the item that will be generated. This is very useful when printing in PDF, since the report item that is searched in the menu can be certainly identified. Another important field of the form for this kind of model item is create a graph for each agent. Once activated, it will enable creating a combined graph for each agent. If disabled, the system will combine all data in a single combinated graph, where information about all matching agents and modules will be added.

2.4 Example 2: Top N

This item will generate a report of the 'Top N' type, showing the highest 10 CPU usage values of the last day. This item applies to all agents with modules which contain the literal "CPU User" element.

Template topn.png

As shown in the image, the modules will not be searched literally, but a regular expression will be used here. This performance is selected by clicking on the verification checkbox next to the agent's name ('exact match'). If left blank, the agent's name will match on all agents selected during template application.

2.5 Example 3: Agent Events

This element will generate a report of the events generated on the last day for all selected agents.

Template agentevent.png

As you can see in the Agent field, the regular expression ".*" has been used. It symbolizes any alphanumeric string, so it will be applied on any selected agent.

2.6 Applying a template

Once all the needed template items are defined, apply or instantiate this template through two methods:

2.6.1 Direct application

A template report can be applied and viewed by clicking on any of the format icons that appear on the same row of the template:

Template direct.png

A pop-up will be shown, where the agents on which this report template will be applied may be chosen:

Template direct2.png

2.6.2 Template wizard

Use the Template Wizard if you need to instantiate your report template in a real report to have it available in the Pandora FMS report list.


Template application.png


Activate the checkbox Create report per agent if you want to generate a report for each selected agent. If you do not activate it, a general report will be generated with all the information.

  • If a report is generated by an agent, the title of the report shall be as follows: [template title] - [agent name] ([agent name])
  • In the event that a full report is generated, the title shall be as follows: [report title] - agents ([number of agentes]) - [date]


Template application1.png

2.6.3 Examples

A "custom_graph" type element was created for the automatic combined graph. This graph has two elements for the modules "Read Disk Latency" and "Write Disk Latency".



Template application custom graph1.png



Editing the custom graph, you can see that it has both modules:



Template application custom graph.png



For the Top N report, an element was created with an expression based on the cpu text.

Template topn.png

Displaying the rendered report shows the ten most loaded CPUs:




Template application top n1.png



Three elements will be created for the agent event report (remember that all agents were selected using .*):



Template application eventagent.png

2.7 Editing the template

Within the template, you may modify the general parameters of the template as shown on the picture below.

Template general.png

2.8 Template list

In order to access the template list, click on Reporting > Custom reports:

Report menu.png

Once there, click on Templates:

List templates.png

In that page you may see the full list of defined templates in Pandora FMS console.

Template main.png

2.9 Item List

In this item list section, you may see and edit items created within a report template and modify their order besides deleting them.

Template list item.png

2.10 Item Editor

This item editor section was designed to create new template items.

The item types are the same as in the report section, but with two differences: when applying it to an agent or module, this must be searched as a regular expression. For instance, oracle_agent[.]* can match agent names oracle_agent_1, oracle_agent_2, etc.


If you left blank, this template item would be applied onto all selected agents when applying the report template.

Applying a template

When a module is specified, this can be literally interpreted, activating the verification checkbox Module exact match. If disabled, it will use the regular expression standard match method.


Template agentevent.png

2.11 Advanced Options

Within this section, you may edit visual aspects for the resulting report like fonts, logos, headers, the first page or the report footer as done with a standard report.

Template advance.png

2.12 Report Cleaning

To delete reports created in previous applications from a template from the Wizard, you can select a template and click on the delete button (broom button).

Template wizard cleanup.png



This action will automatically delete all reports created based on this template.

Go back to Pandora FMS Documentation Index