Pandora: Documentation en: Data Presentation/Reports

From Pandora FMS Wiki
Jump to: navigation, search

Contents

1 Reports

Pandora FMS offers you the possibility of presenting the monitored data in an orderly way in the form of 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.


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


You can have as many elements as you want, of the type you want.

1.1 Creating a Report

In order to add a report, please click on Reporting -> Custom reporting.

Report menu.png

It's going to show you a list which contains all the reports. In order to create a report, please click on "Create Report".

Pre18.png

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.

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

Pre19.png

Once done, it will appear a blank report, where we will continue its edition including new elements.

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

Pre43.png

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

Pre44.png

1.4 Tabs

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

Main tab reporting builder.png

The fields pertaining to this particular tab are the following:

  • Name: Intended to define the name of the form.
  • Group: Intended to define the access group that is visualized 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.

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

  • To modify the item (by clicking on the adjustable spanner).
  • To modify the order with the right side boxes "sort" and the pannel below "Sort items".
  • To modify the order manually by the green arrows on the left.
  • To delete 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.

List items tab reporting builder.png

The columns pertaining to this particular tab are the following:

  • P.: The items appear exactly in this column's order within the report.
  • Type: The column in which the item's type is displayed.
  • Agent: The column in which the agent's name is mentioned. It's also allowed to leave it blank for item types like SLAs, custom graphs, import texts from URLs, 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.
  • Period: The time period that it's going to receive in the specific moment 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.
  • Options: The column which displays the buttons and icons to edit or to delete it.

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

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
  • Description: The text box intended for a description of the reported item.

1.4.4 Types of Items

We can include different elements into out 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:

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

Excample of this type of report:

Pre39.png



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

Baseline-form.png

The fields pertaining to 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.
  • 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.

Baseline-result.png


Template warning.png

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

 


1.4.4.1.3 The Custom Graph

It's a user-defined combined graph. A field is added with a combo to select the graph we intend to add.

Custom graph - item editor tab - reporting builder.png

The fields within this form are the following:

  • Period: The time frame it takes to get back to the temporary point within which the report is generated.
  • Custom Graph: A deployable list containing the user-defined graphs. In order to create theses graphs, please click on 'Administration' -> 'Manage Reports'
    and 'Graph Builder'.

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

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.nombre as `label`, count(st.id_agente_modulo) as `value`
FROM tagente_estado st, tagente a
WHERE a.id_agente=st.id_agente 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:

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) character 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.

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

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, we'll add the modules we want 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).

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.


Displaying the report we will see the availability graph of the chosen module in the selected time range:


Availability graph.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

Visualization 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 us 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 being in a planned stop situation we assume that the module situation is controlled and accepted) and periods in warning status (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 prioritization mode that determines which states have preference when summarizing. You have 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. 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.

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 SLA (Service Level Agreement) of any monitor of Pandora FMS.

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

The fields pertaining to 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.
  • 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.
  • 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 are going to trigger the SLA.
  • SLA max (value): A field intended to determine the SLA's maximum value. The maximum values are also going to trigger the SLA.
  • 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.

It's 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, the SLA performance is going to depend heavily on the performance of all the SLAs configured so far.

 


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.

SLA 2.png

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

SLA sinsch.png

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

SLA consch.png

1.4.4.2.2 Monthly SLA

This feature is only available to Enterprise Versions of Pandora FMS. It's a variation of the 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.

Examples:

  • In a report of the May 5, it's going to 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.

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:

  • Green: The SLA was accomplished.
  • Red: The SLA wasn't accomplished.
  • Gray: Unknown. There is insufficient data on this 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 which don't accomplish the SLA they will be put in a summary table.

S.L.A. Monthly - view.png

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.


Info.png

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.

 


1.4.4.2.3 Weekly SLA

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

Sla weekly.png


Allows us to edit the working time in case we have a custom service schedule (e.g. 8x5)

At the bottom we can add multiple modules to this item.

Example of visualization:

Sla weekly sample.png

1.4.4.2.4 SLA Hourly

Displays the SLA of the modules chosen by hours along the selected period (by default current month).

Sla hourly.png


Allows us to edit the working time in case we have a custom service schedule (e.g. 8x5)

At the bottom we can add multiple modules to this item.

Example of visualization:

Sla hourly sample.png

1.4.4.2.5 Service SLA

It allows you to measure the SLA (Service Level Agreement) of any service created in Pandora FMS

S.L.A servicios.png

The fields pertaining to 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.
  • Working Time: Time to be taken into account for the SLA calculation.

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.

S.L.A servicios2.png

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.

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.

S.L.A total.png

1.4.4.3 Prediction Items
1.4.4.3.1 Prediction Date

This type of item returns a date in the future in which a module reaches its interval. It utilizes the Least Squares Method like the projection graph.

Projection graph3.png

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

Projection graph5.png

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

Prediction date.png

1.4.4.3.2 Projection Graph

This type of graph is going to project a future estimation of the module's data. This estimation is based on Linear Regression and is implemented by means of the Least Squares Method.

Projection graphs.png

In order to configure this graph, you're required to provide the following information:

Projection graph6.png

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

Projection graph periods.png

1.4.4.4 Module Items
1.4.4.4.1 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.

Avg value - item editor tab - reporting builder.png

The fields pertaining to 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.
  • 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.

Pre24.png

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

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

The fields pertaining to 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.
  • 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.

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

Pre29.png

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

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

The fields pertaining to 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.
  • 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.
  • Calculate for custom intervals: Habilita la posibilidad de mostrar el informe en múltiples sub intervalos.
  • Time lapse intervals: Duración de cada sub intervalo.
  • Table | graph | both: Mostrar los datos de cada valor de cada sub intervalo en una tabla o una gráfica o ambos elementos.

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

Pre30.png

1.4.4.4.4 Monitor Report

It shows the percentage of time a module has been right or wrong within a predefined period.

Monitor report - item editor tab - reporting builder.png

The fields pertaining to 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.
  • 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.

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 Serializing 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 SAP Platform.

Serialize data - item editor tab - reporting builder.png

The fields pertaining to 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.
  • 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.
  • 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.
  • 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.
1.4.4.4.6 Summatory

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

Sumatory - item editor tab - reporting builder.png

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

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 that we indicate in the configuration of the report.

We will configure the following fields:

  • Period: Interval of time on which the report will be calculated (from the current moment).
  • 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.

Historical.png

Example of report display:

Historical sample.png

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

We will configure the following fields:

  • Period: Interval of time on which the report will be calculated (from the current moment).
  • 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.

Increment.png

Example of report display:

Increment sample.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:

  • 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 show.
  • 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 The 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 an 'unknown' status
  • Modules
    • The total number of modules
    • The number of modules holding a 'normal' status
    • The number of modules holding a 'critical' status
    • The number of modules holding a 'warning' status
    • The number of modules holding an 'unknown' status
    • The number of modules holding a 'not initiated' status
  • Alerts
    • The number of defined alerts
    • The number of fired alerts
  • Events
    • The number of this group's events within the last 8 hours.

Group-report-from.png

The fields pertaining to this particular form are the following:

  • Group: A combo intended to select the 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.

Group-report-result.png

1.4.4.5.3 Exceptions

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

Report last value exc.png

We can configure the following fields:

  • 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.
  • Order: Order in which the metrics will show.
  • Value: value that will be considered with the chosen condition.
  • Condition: Condition under which to filter the report data, everything ignores the 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.

In the lower part we will be able to add as many modules as we need once the report element is saved:

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

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 the reports Pandora DB data in table to have in the report personalized data extracted directly from the DB.

Template warning.png

This type of items have to be used with care since they can overload Pandora FMS.

 


Los campos de este formulario son:

  • Query SQL: text box where to write the SQL query to extract data from Pandora FMS DB.
  • 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.
  • 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:

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

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, we can 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 can 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


This item shows in the reports Pandora DB data in table to have in the report personalized data extracted directly from the DB.

Custom sql new.png

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

Report topn.png

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


We can indicate:

  • Time lapse: Backward time range 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 painting 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

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.

Este ítem muestra un tabla con los datos de disponibilidad de una lista de agentes y módulos seleccionada.

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.

Report availability.png


Puede personalizar los siguientes campos:

Los campos de este formulario son:

  • Period: Intervalo de tiempo sobre el que se calculará el informe (desde el momento actual).
  • 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.
  • Show address instead of module name.Show the agent's main address.: Mostrará la IP principal del agente en vez del nombre.
  • Show summary: Mostrar un resumen final.
  • Orden: Ordenar los items disponibilidad según el criterio elegido.
  • Hide not init agents: Ocultar de la vista aquellos agentes no iniciados.


Una vez hemos seleccionado estas opciones, agregaremos cada uno de los módulos objetivos sobre los que queramos calcular SLA:

Report availability add module.png

  • Agent: Combo donde puede indicar el agente sobre el que aplicar el informe.
  • Module: En un combo se elige el módulo del agente previamente fijado sobre el que calculará el SLA.


Ejemplo de visualización de informe:

Report availability sample.png


Muestra la siguiente información:

  • Agente: agente.
  • 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.
  • Total time: Tiempo total a analizar.
  • Time failed: Tiempo en estado crítico.
  • Time OK: Tiempo en estado OK o advertencia.
  • Time Unknown: Tiempo en estado desconocido.
  • Time Not init: Tiempo no iniciado.
  • Time downtime: Tiempo en parada planificada.
  • %OK: Porcentaje de tiempo en estado correcto.
  • Total checks: número de chequeos totales realizados durante el lapso de tiempo configurado para el informe.
  • Checks failed: número de chequeos que han fallado (críticos).
  • Checks OK: número de chequeos correctos.
  • Checks Unknown: Aproximación basada en eventos y la lógica de Pandora FMS que permite indicar el número de chequeos que deberían haberse realizado, pero de los que no consta una respuesta.
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 field pertaining to this particular form is the following:

  • Text: A text box intended to format the text and to add links and images from a remote server.

An example of the window in which the link is added is shown below.

Edit link - report builder.png

An example of the window in which the image is added is shown below.

Edit image - report builder.png

1.4.4.6.2 Importing Text from an URL

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 URL - item editor tab - reporting builder.png

The fields pertaining to this particular form are the following:

  • URL: The text field intended to insert the external server address in order to extract the text.
1.4.4.7 Alert Items
1.4.4.7.1 The Alert Report Agent

It displays a list containing the agent's fired alerts of a specified report group within a predefined period.

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

The fields within this form are the following:

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

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

Pre23.png

1.4.4.7.2 The Alert Report Module

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

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

The fields pertaining to 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.
  • 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.
1.4.4.7.3 Alert report group

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

ReportGroupAlert.png



We will configure the following fields:

  • Time lapse: the backward time range over which the report will be drawn up (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 The Event Report Agent

It displays a list containing the events which occurred 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:

  • 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.
  • Severity, event type, event status: Selecct the types 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.

Pre27.png

1.4.4.8.2 The Event Report Module

It displays a list containing the events occurred 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:

  • Period: The time frame it takes to get back to the temporary point within which the report is generated.
  • Agent: An intelligent control to select the appropriate agent for this item.
  • Module: A deployable 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.

Report module events sample.png

1.4.4.8.3 The Event Report Group

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

Event-report-group-from.png

The fields pertaining to 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.
  • 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.

Event-report-group-result.png

1.4.4.9 Inventory Items
1.4.4.9.1 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.

Inventory item form.png

The fields pertaining to this particular form are the following:

  • Description: A text field intended for the item's description.
  • 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.
  • 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.
  • 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.

Inventory report sample.png

1.4.4.9.2 Inventory Changes

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

Inventory changes form.png

The fields pertaining to this particular form are the following:

  • Description: A text field intended for the item's description.
  • 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.
  • 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.
  • Modules: The common inventory modules of the selected agents.


Info.png

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.

 


Inventory changes report sample.png

1.4.4.10 Configuration Items
1.4.4.10.1 Agent Configuration

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

Agent configuration report.png


Example of report display:

Agent configuration report sample.png



1.4.4.10.2 Group Options

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


Group configuration report.png


Example of report display:

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

  • Search: text string to search.
  • 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).
  • Source: Origin of logs.
  • Agents: Filtration Agents.


Example of report display:

Log report.png

1.4.5 The Wizard Tab

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.

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.

Wizard-tab-reporting builder.png

The fields pertaining to this particular form are the following:

  • 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
  • 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.
  • 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.
  • Modules: This common module list of the selected agents is available for one or several agents.
  • Filter Group: A field intended to filter the agents by group.
  • Elements to apply: The list intended for the selected modules to add.

Example of visualization of report (availability):

Wizard report availability sample.png



1.4.6 The SLA Wizard Tab

This wizard allows us to create SLA report items automatically.

We can choose different SLA analyses:

  • SLA: 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 %.
  • Weekly SLA: 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.
  • 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:

  • Hide not init agents: only basic SLA; it will hide the uninitiated elements of the report.
  • Show graph: only basic SLA; allows you 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 The Global Tab

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.

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.

Global2.jpg


Example of visualization of a report:

Wizard global sample.png

1.4.8 The Advanced Options Tab

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.

Advance options-tab-reporting builder.png

The fields pertaining to this particular form are the following:

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


Info.png

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.
  • 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.
  • First Page: Like the header field, this is another complete text editor, intended to create and to edit the PDF's front cover page.
  • Footer: It's the same like the two other fields, but for editing and creating each PDF page's footers.
1.4.8.1 Macros

It's also possible to use macros within the first page, the header and footer. The available implemented macros are the following:

  • (_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.
  • (_REPORT_NAME_): This value is going to be replaced by the report's name.

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

1.5 Visualizing a Report

In order to visualize an already created report, please click on Operation -> Reporting.

Report menu.png

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

Report list.png

Reports can be visualized in HTML, XML, CSV or PDF formats. Reports can be sent by email:

Send email.png

In order to see a report in the HTML format, please click on the Pre46.png icon. Once the report is opened in HTML, it's possible to select the date and hour it was generated.

Pre47.png

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

Pre49.png



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

Pre51.png

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

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

We will find this functionality 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 us 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.
First Execution
In this field we will establish the date and time of the first execution.
Report build
In this field we will select the report we 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 appears 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 can 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, we will 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.
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.
Template to build
In this field we will select the template of the report we want to generate.
Agents
We will 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

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.

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.

Templates1.png

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.


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.

Now we're going to describe three examples of template items.

2.1 Examples

In order to access the template's administration menu, please click on 'Operation' -> 'Reporting' -> 'Custom Reporting' and click on the 'list templates' button:

Template main.png

This template examples are containing three template items mentioned below:

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

Templates list items1.jpeg

2.2 Example 1: The Automated Combined Graph

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.

Template automatic graph.png

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.

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.

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

Template topn.png

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.

2.4 Example 3: Agent Events

This element is going to 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.5 Applying a template

Once we have defined all the template items we need we can apply or instantiate this template through two methods:

2.5.1 Direct application

You can directly apply and view a template report by clicking on any of the format icons that appear in the row our template occupies:

Template direct.png

We will be shown a pop-up where we will be able to choose the agents on which this report template will be applied:

Template direct2.png

2.5.2 Template Wizard

We can make use of the Template Wizard if we need to si necesitamos instantiate our report template in a real report to have it available in the Pandora FMS report list.


Template application.png


We can activate the checkbox Create report per agent if we want to generate a report for each agent selected. If we don't 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


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

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 events report (remember that all agents were selected using .*):



Template application eventagent.png

2.6 Editing the Template

Within the templates you're able to modify the general parameters of the template as shown on the picture below.

Template general.png

2.7 List of Templates

In order to access the template's list, please click on 'Administration' -> 'Manage Reports' -> 'Report Builder' and on the 'List Templates' button:

Template main.png

In this section, you may create new templates, edit existing ones, copy and delete them.

2.8 The Items List

In this section, you're able to review, edit, assort and delete items within a report template.

Template list item.png

2.9 The Item Editor

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

Template agentevent.png

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

Template advance.png

2.11 The Template Wizard

You can do the instructions explained here.

Template application.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 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