Pandora: Documentation en: Data Presentation/Reports

From Pandora FMS Wiki
Jump to: navigation, search

Contents

Typography

Pandora FMS includes a collection of fonts which could be used within graphics, maps and reports. Among the included fonts ('code.ttf' is used by default), characters such as Latin, Arabic, hiragana, katakana and many others are supported.

The fonts are located in the directory named '/include/fonts' in which you're able to paste new fonts into if you need them.

Graphs

Graphs are designed to show the data collected by Pandora FMS in a temporary scale defined by the user. Pandora FMS Graphs display data in real time. They are generated every time the operator requires any of them and display the up-to-date state. There are two types of graphs: The agent's automated graphs and the graphs the user customizes by using one or more modules to do so.

Agent Graphs

Agent Graphs are the module's graphs which can be viewed from the Agent's Operation menu. In order to access these graphs, you're required to pick an agent by clicking on 'Monitoring' -> 'Views' and 'Agents Detail'.



Pre1.png



After the filtering is completed, please click on the agent's name, e.g. 'vanessa-HP-630-Notebook-PC', to gain access to the agent's operations menu.

Pre2.png



This view is going to display a list which contains all the agent's modules. One of the columns of this list is called 'Graph'. It provides a link to access the graph within each module.



Pre3.png



If you click on the 'Graph' icon, you're going to gain access to a new window in which the module graph is contained. You're also able to personalize the graph shown there.



Quick graph.png



The graphs are displayed in Flash or in a PNG format (if Flash has been deactivated). The Flash graphics are interactive, so hovering the mouse over any point of the graph's back side leads to a display of this point's specific data. The graphs come with a configuration menu which allows you to reconfigure the graph by hovering the mouse over the flap on the left of the graph's window. For each series, some statistical data are displayed within the legend (e.g. 'last value', 'average', 'minimum' and 'maximum').



Pre4.png



Now we're going explain the fields you're encountering there:

  • Refresh Time: The field in which the graph's refresh time is defined.
  • Avg. Only: If you select it, it's going to show the medium data without minimum and maximum only (This feature is not available for boolean modules).
  • Begin Date: By a calendar, it's possible to define the moment from which the data is going to be shown.
  • Zoom Factor: You may enlarge or reduce the graph by this combo.
  • Time Range: You may choose the graph's time frame by this combo.
  • Show Events: If you click on it, it's going to show the module's events.
  • Show Alerts: If you click on it, it's going to show the module's alerts.
  • Show Event Graph: If you click on it, it's going to show a bar graph along with received events within the graph's interval below it (Pandora FMS versions 5 and above only).
  • Time Compare (Overlapped): If you click on it, it's going to show a second overlapping graph along with the module's data within the previous interval, e.g. if the module represents one week, the previous week is also going to be shown. This option is available for the numerical and boolean modules only (Pandora FMS versions 5 and above only).
  • Time Compare (Separated): The same as the overlapped version but with separated graphs.

Once you have changed the values, please click on 'GO' to apply the changes.

It's also possible to change the graph's resolution to display a more detailed view, as you can see on the next picture. The values for the resolution are between '1' (lower) and '5' (higher).



Comparativa resolucion graficas.jpg
Comparativa resolucion graficas2.jpg



If you intend to edit or review the configuration parameters related to graphs, please click on 'Setup' -> 'Setup' and 'Custom Graphs'.

Combined Graphs

Combined graphs allow the user to augment graphs with a variable size which hold values of different modules which themselves own one or more agents. You may visually compare information which originates from several sources in this way.

Creating Combined Graphs

In order to add a combined graph, please click on 'Reporting' and 'Custom Graphs'.



Pre6.png



Now we're going to describe the fields you're going to encounter there:

Width: The field intended for the graph's 'width' value.

Render Now: A combo which determines whether the graph is re-rendered or not.

Height: The field intended for the graph's 'height' value.

Period: It's the combo by which you're able to define the temporary period used to create the graph.

View Events: By this combo, you may select whether the events which have taken place on the module are going to be shown or not.

Stacked: By this combo, you may select the type of graph. You're able to choose between 'Area', 'Line', 'Stacked Area' and 'Stacked Line'.

Factor: Please click on 'Preview' to display a preview of the graph.



Pre7.png



This is the graph. You may change the parameters and click on 'Update'.



Pre7.png



In order to add new modules, please click on the 'Graph Editor' button. It's going to open a form which allows you to add new modules from any agent.

The defined graph is shown below, along with one menu and the options to add more modules and to store the newly created graph.



Pre8.png



The 'factor' option allows you to select the value of the data standardization factor in case you intend to use it. The standardization was designed to compare graphs of different levels and to multiply the data by the defined factor. If we e.g. intend to insert the CPU graph along with values between '0' and '100' and the number of connections between '1000' and '10000' into the same graph, it's recommended to multiply the CPU value by '10'.

There is no limit in the number of elements to visualize - but from five values and above, the shown quantity of information makes it pretty difficult to interpret, unless you use big-sized graphs, e.g. '800x600' and above.

Due to the simplicity the combined graph creation possesses, the graphs can't be edited, except in the moment you're creating them. In the moment of their creation, the only thing you can do is to delete the inserted module and to reinsert it once again along with other properties.

Once the graph has been created, it's important to store it for being able to review it later or to utilize it within a report. Before storing the graph, we strongly recommend to name it, to write a small but detailed description, to determine whether it's considered to be of a private nature or not and to click on the 'Store' button when you're done.

On the picture below you can see a combined graph, consisting of two modules: 'cpu_user' of the 'farscape' agent and 'cpu_user' from 'ARTK_galaga'. In our example, the graph has been saved as 'Example cpu_user'.



Pre7.png



Displaying Stored Combined Graphs

In order to see a stored combined graph, please click on 'Reporting' and 'Custom Graph'. It's the location in which all the graphs are stored. Please click on the graph's name to review it.



Pre12.png



On the picture below, you can see a graph which is recalculated by means of the available values in this moment.



Pre13.png



On this page, it's possible to modify any display parameters such as the time frame, the graph's type (e.g. 'line', 'area' and 'horizontal bars') and the zoom factor, e.g. 'defined by graph', 'zoom x1', 'zoom x2' and 'zoom x3'.

Now we're going to provide an example along with the different types of graphs. The area type was shown on the previous image.

  • Area type



Area.png



  • Horizontal bars type



Horbars.png



  • Vertical bars type



Vertbars.png



  • Bullet chart type

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

Bullchart.png



  • Gauge type



Gauge.png



  • Pie type



Pie.png



  • Line type



Pre14.png



  • Stacked area type



Pre15.png



  • Stacked line type



Pre16.png



Deleting Stored Combined Graphs

To delete a stored combined graph, please click on 'Reporting' and 'Custom Graph'. It's the location in which all stored graphs are listed. Please click on the trash icon on the graph's right side to delete it.



Pre17.png



Agents / Modules View

By clicking on 'Monitoring' > 'Views' and 'Agent/Module View', a matrix containing modules, agents and the state of every single module is displayed.

In order to invoke the extensions, please click on 'Operation' -> 'Extensions' and the 'Agents/Modules' view.



Ex4c.png



Module Groups

This section allows to have a precise overview in a module table by its state, regarding the module's group and the module itself. In order to access the extensions, please click on 'Monitoring' > 'Views' and 'Module Groups'.



Ex4.png



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

The Tree View

The tree view allows to visualize the agent's monitors in a tree-shaped structure. Please click on 'Monitoring' -> 'Views' and 'Tree View' to invoke it.

Tree.jpg

It's also possible to classify the agents by modules, policies, module group, group and operating system. They're assorted by group by default. Within this level, the number of agents in 'ok' (green), 'critical' (red), 'warning' (yellow) and 'unknown' (gray) states is displayed. Information about it is going to be displayed by clicking on the agent's name, address, operating system, event and access graph. They can be filtered by the module's states ('normal', 'critical', 'warning' or 'unknown'). A search by agent's name is also supported here.

The Mobile Console

Pandora FMS comes with a new mobile console. This console a reduced version of the default console and allows any user with a mobile device with at least 600x280 pixels of screen resolution to browse all information provided by Pandora FMS like agents, monitor view, alerts, agent detail (graphs included), group view and last events.

The mobile interface is located at '/mobile' [url], so if your regular console is located at 'http://firefly.artica.es/pandora_demo/' your mobile console is located at 'http://firefly.artica.es/pandora_demo/mobile'.

This URL is compatible to any device which is able to access native websites. It has been thoroughly tested with iPhone and android-based cellphones and tablets and adapts automatically to the width of your device's screen.



Mobile1.png
The login screen within the mobile web interface.





Mobile2.png
The tactical view of the mobile web interface.





Mobile3.png
The detailed event view.





Mobile4.png
The detailed module graph.





Mobile5.png
The general options menu.





Mobile6.png
The agent's detailed view.



Mobile7.png
The module's detailed view.



Reports

Pandora FMS was designed to create customized reports containing information about agents such as calculus, derived from them or even to import data or tables intended for other places by using URL import or similar methods. It's possible to select different modules from different agents. The data is visualized in different ways, depending on the type of report element which we intend to add.

Creating a Report

In order to add a report, please click on 'Reporting' -> 'Custom reporting' and 'Report Builder'. 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



Editing a Report

In order to edit 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 edit a report, please click on the report's name.



Pre43.png



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



Tabs

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.

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.

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.

The available types pertaining to this particular tab are the following:

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



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



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



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



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.

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



Pre27.png



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.

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



Event-report-group-result.png



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

The picture below shows values of several modules which meet the conditions of a logical operator (e.g. 'greater than', 'less', 'OK' or 'Not OK'). They're able to be arranged in an ascending or descending way or by the agent's name within a predefined time frame.



Exception - item editor tab - reporting builder.png



This item allow reporting on current value data. For this, you should select the option 'Last value'.



Report last value exc.png



Availability

This feature is for Pandora FMS version (5.1SP3 and uppers).


The item of availability shows a table with the availability data with a list a agents and modules, also it shows a summary with the agent and module with maximun availability, the average availability of all agents and modules and the minimum avaliability.Make a rough estimate by dividing the time the module has been no normal state, between the module interval, for calculating the number of checks that failed. It is a rough estimate and does not take into account possible unknown states so it can vary quite the result obtained by an SLA report.

The columns of the table are:

  • Agent: name of agent.
  • Module / Dirección IP: when you configure this report item, you can choose between to show the name of module or show the main ip address of agent. This is useful for report show a list a agents availability with ip address instead the agent list with a "ping" name module repeatedly.
  • # Checks: the count of checks or samples of data stored by the module in the report period.
  • # Fails: the count of checks that had failed (with a 0 value) in the report period.
  • % Fail: the percent of fails in the report period.
  • Poling time: the time that the data is stored, because sometimes the module started (or become accesible) in the middle of report period.
  • Time unavailable: the time that the module was in fail state.
  • % OK: the percent of correct status of module in the report period.

Avaliability html view.png

The form editor is similar a form editors of report items as General or SLA.

Avaliability editor.png

General

It displays the values of several modules, arranged in an ascending or descending way, by the agent's name and / or grouped by agent.



General - item editor tab - reporting builder.png



Info.png

Please keep in mind that if a module extends its range over its lifetime, the accounts might display an incorrect sum.

 


This item allow reporting on current value data. For this, you should select the option 'Last value'.



Report last value.png



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.

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



Group-report-result.png



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

 


MTBF

MTBF = Mean Time Between Failures

  • It's calculated in the following way: MTBF = TTO / #F
  • where:
TTO = The total time for operation within the period
#F = The total number of failures
  • It provides the average time of regular operation between failures.
  • It's reliability indicator.



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

MTTR is the mean time to restore the performance of one system, machine, line or process after a functional failure.

  • It includes time to analyze and diagnose the failure, the time to get refurbished, the time for planning, etc.
  • It's a measuring of a system's performance.
  • It's the time interval divided by the total time of reparations and the total number of failures within a system.



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



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.

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



Pre30.png



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



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 S.L.A. 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



Service S.L.A.

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



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

The unknown days aren't going to be taken into account for the percentage of days which accomplished 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.

 


Services S.L.A.

This feature is only available on Enterprise Versions of Pandora FMS. It measures the service level of many services in a determined period.

It has a wizard on the S.L.A. wizards section and create an item of this type with some services is a piece of cake.


S.L.A. Services - view.png



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.

 


SQL Query

This item displays the report's data from the Pandora FMS Database in form of tables. It's a customized data report, containing data extracted directly from the DB.

There are two ways of describing the SQL query:

  • One handwritten within the text box:



SQL query custom SQL template - item editor tab - reporting builder.png



  • The other selected by the Custom SQL template drop down, which can only be easily edited by the Enterprise Version of Pandora FMS.



SQL query custom SQL sql editor - item editor tab - reporting builder.png



The fields pertaining to this particular form are the following:

  • Query SQL: A text box intended to insert the SQL query to extract the data from the Pandora FMS Database.
  • 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.
  • Custom SQL Template: A drop-down list which contains the SQL templates of stored queries for its management. These could be managed by clicking on 'Administration' -> 'Custom SQL' and 'Manage Reports'.


Template warning.png

Due to certain security restrictions, you're not allowed to use the following words and tokens: '*', 'delete', 'drop', 'alter', 'modify', 'union', 'password', 'pass', 'insert' and 'update'.

 


SQL Graphs

This type of reporting allows you to define your own graphs to be used in reports. That graphs will be created by using your own SQL code. This code should always return a variable called 'label' and another one called 'value'. This is an SQL example used to create graphs:

SELECT tagente.nombre AS label, datos AS value FROM tagente, tagente_estado, tagente_modulo 
WHERE tagente_estado.id_agente_modulo = tagente_modulo.id_agente_modulo AND tagente_modulo.nombre = "module_1" AND
tagente_modulo.id_agente = tagente.id_agente

This is a sample on how to define the graph. It's pretty similar to the SQL query report but it doesn't use headers and requires the SQL code only.



Sql graph pie.png



These are a few samples of the three different graphs you're able to draw by Pandora FMS: Pie charts, vertical bars and horizontal bars. They're utilizing different UTF encodings within their description (e.g. western Latin, Japanese and Arabic) just to demonstrate the powerful true multi-language UTF support of Pandora FMS (which is also used for creating the PDF reports).



Report vgraph.png





Report hgraph.png





Report piegraph.png



Template warning.png

Due to certain security restrictions, you're not allowed to use the following words and tokens: '*', 'delete', 'drop', 'alter', 'modify', 'union', 'password', 'pass', 'insert' and 'update'.

 


Info.png

These types of items are required to be used with caution because they have the potential to overload Pandora FMS.

 


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.

 


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

It displays one simple module graph.



Simple graph - 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.
  • Time comparison (overlapped): if it is setted, the report content show a overlapped chart over of the original chart. For example if the chart shows data from one month, the overlapped chart show data from the previous month.

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



Pre39.png



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



TTO

It's the Total Time of Operation, which is defined as the overall time in which the monitor has been within the 'OK' range.



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

Is the the overall time in which the monitor has not been within the 'OK' range.



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



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.



Top n - item editor tab - reporting builder.png



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



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



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
  • Availability (since 5.1SP3)
  • 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.
Availability report

This report is only accesible via Wizard tab, is a special report used to detail the availability cross time on selected modules, showing up time, %, down time and %.



Report avail1.png



Using the wizard you can select agents and modules and adding to the report. Optionally you can choose to show only the IP address, instead the name of the module (useful to hide pandora terminology -modules- to the final user).



Report avail2.png



The SLA Wizard Tab

This tab is a feature of the Pandora FMS Enterprise Version and was designed to create an SLA report by a wizard. It's possible to add modules from different agents easily by it.



Wizard-sla-tab-reporting builder.png



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. You're also able to easily add different modules from different agents by it.



Global-wizard-tab-reporting builder.png



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

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.

Visualizing a Report

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



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



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



Pre51.png



Automatic Report Sending by Email

In the Pandora FMS Enterprise Version, this is the extension which allows you to send the reports generated by email in a scheduled way. The reports are going to be sent in PDF format.

In order to gain access to the extension, please click on 'Operation' -> 'Extensions' and 'Cron Jobs'.

In order to add the task of report sending by email, you're required to fill out he following fields:

  • Task: Intended to select the option of 'send custom report by email'.
  • Scheduled: Intended to select how often the report is going to be sent.
  • First Execution: Intended to select the date and hour of the first execution.
  • Report Build: Intended to select the report you intend to send.
  • Send to Mail: Intended to insert the mail address to send the report to.



Pre52.png



Once you have filled out the appropriate data, please click on 'Create' and the task is going to be shown within the scheduled tasks.



Pre53.png



Once you have created the scheduled task, it's also possible to force its execution by clicking on the green circle on the right side of the task or to delete it by clicking on the red 'x' on the left.

Configuration

This functionality requires an appropriate configuration before it can be put to use. The configuration is located in the file named '/enterprise/extensions/cron/email_config.php' in the Pandora console's host and it's empty by default.

<?php
//Please setup your config to send emails in cron job

$cron_email_from = array([email protected]' => 'Pandora FMS');
$cron_email_smtpServer = 'mail.artica.es';
$cron_email_smtpPort = 25;
$cron_email_username = [email protected]';
$cron_email_password = ;
?>

The fields pertaining to this particular form are the following:

  • From: Intended for the contact's email account. You may mention the name between the quotes of 'acount.contacto'.
  • SMTP Server: It's the field intended to insert the SMTP server's URL.
  • Username: It's the filed intended for the connection's user name.
  • Password: It's the field intended for the connection's password.

This is an example configuration file:

<?php
//Please setup your config to send emails in cron job

$cron_email_from = array([email protected]' => 'Bot report');
$cron_email_smtpServer = 'mail.company.cat';
$cron_email_smtpPort = 25;
$cron_email_username = [email protected]';
$cron_email_password = 'opensesamo';
?>


Info.png

Please keep in mind that anybody who has access to a host with a Pandora FMS Console on it is able to view this file's content. It's recommended not to mention your personal email account, but to create an additional one, intended for use in conjunction with this task instead.

 



Report Templates

(Available to all Pandora FMS Enterprise Version 5 and above.)

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.

Introduction

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

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



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.

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.

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.

Application

Once the different elements of one template have been created, they should be applied to generate the report(s) within the 'Template Wizard' tab.



Template application.png



During the application, the report can be selected from the box named 'Create report per agent' in order to create one report for each agent selected in the application or in case a report containing all the results would be selected:

  • In case one report by agent is generated, the report's title is going to look like this: [template title] - [agent name] ([agent name])
  • In case one report by agent is generated, the title is going to look like this: [report title] - agents ([number of agents]) - [date]

Once it has been applied on the agents you can see on the image, this template is going generate the report by the following title: 'Sample template report - agents (3) - October 14, 2013, 04:21 pm'. This report is shown on the picture below.




Template application1.png



For the automated combined graph, one item of the 'custom_graph' type was created. This graph contains two elements for the modules named 'Cache mem free' and 'proctotal'.



Template application custom graph1.png



By editing the customized graph, you can see that it contains the two following modules:




Template application custom graph.png




For the 'Top N' report, one item is created, containing two sub items (because one of the agents didn't have a module to select).




Template application top n.png



By reviewing the render report, you're able to see the top 5 CPUs which carry the biggest load:




Template application top n1.png



For the agent's event report, three elements are going to be created (please keep in mind that all elements were selected by the regular expression of '.*'):



Template application eventagent.png



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



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.

The Items List

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



Template list item.png



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 create item.png



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



The Template Wizard

In order to apply templates, you're required to pick a template, pick the target agents (by clicking in the 'tick' icon, you may select all of them), to click on the arrow pointing to the left and clicking on the 'Apply Template' button. The default approach is to create one report which contains all the template's items. If you click on the 'Create report per agent' check box, the template application is going to create one report for any selected agent.



Template wizard.png



If an item already contains an agent's name (a regular expression in this case), the template is only going to be applied over agents whose names match to this regular expression, e.g. if an item has been filled with the agent's name of 'Contador 1[.]*' the template is only going to be applied onto the agents 'Contador 1' and 'Contador 10' but not onto the 'Contador 2' agent.



Template wizard1.png



The results can be seen in the list of reports as shown below.



Template wizard2.png



In order to delete all reports created by previous template applications, you may select a template and click on the broom-shaped button as shown below.



Template wizard cleanup.png




Go back to Pandora FMS Documentation Index