動的レポート

Pandora FMS ドキュメント一覧に戻る

Pandora FMS dynamic reports allow designing fully customised documents to represent environment monitoring data in a simple and comfortable way.

These reports are mainly based on 2 elements:

• Designs: They define the shape and content of the report, with its different elements, amount of pages, cover, index, etc.
• Data sources: They define sets of agents and agent groups that will be combined with the Designs to establish the information sources to be represented in a report.

These reports are always generated in the background, and can notify the user when they have finished.

Designs are the main elements of Pandora FMS dynamic reports. It is not possible to create a new report if there is not at least one Design available previously.

Designs allow defining the shape and content of a report, giving the user the possibility to establish how many pages a report should have and the content that must be represented in each one of them.

This section is accessible from the side menu in Operation → Reporting → Dynamic reports → Designs.

When creating a Design, it is first necessary to indicate at least:

• Name.
• Group.
• Description (Optional).

The group is very important to limit other users' access to said Design:

• If the Design belongs to the “All” group:
  • It can be used by all other environment users with RR, RW or RM permission on any group.
  • It can only be edited, duplicated or deleted by administrator users or with explicit RW permission on the “All” group.
• If the design belongs to another group:
  • It can be used by users with RR, RW or RM permission on said group.
  • It can only be edited, duplicated or deleted by administrator users or with RW permission on said group.

Besides that basic information, other general configuration options can be indicated in the Design:

• New pages orientation:
• Generate index: It will be automatically generated as the first page of the report, or the second one in case the cover is generated.
• Generate cover: It will be automatically generated as the first page of the report, with the indicated content.
• Generate page header: It will occupy the first 4 cells of each page, except for the cover. If a Design already has content in its pages and those 4 cells are being occupied in any of them, it will not be possible to enable the page header.
• Generate page footer: It will occupy the last 3 cells of each page, except for the cover. If a Design already has content in its pages and those 3 cells are being occupied in any of them, it will not be possible to enable the page footer.

In the cover, header and footer, the following macros can be used as text to be replaced by information from the report:

• (_REPORT_NAME_): Name of the Generated report.
• (_DATETIME_): Report generation date and time. The date format will be the one indicated in the configuration, menu Management → Settings → System Settings → Visual styles → Other → Date format string or in its equivalent configuration option of group visual styles.
• (_PAGE_NUMBER_): Page number.

Once the main configuration is indicated, the Builder menu for that Design will be available.

In the left panel, the pages for the report will be found. New pages can be added, their order can be changed and their orientation can be rotated as long as they do not have elements inside.

The buttons at the top of that panel allow:

• Adding a new page.
• Orienting all empty pages vertically.
• Orienting all empty pages horizontally.

In the right panel, the available elements to add to the reports will be found, organized in categories to locate them more easily.

These elements (Widgets) can be added by dragging them to the page in the central panel or by double-clicking on them. In the latter case, they will be added in the first available slot of the page or in a new page if necessary.

The current page (selected in the left panel) will be displayed in the central panel.

The buttons at the top of this panel allow:

• Undoing the last change.
• Redoing the last change.
• Hiding/Showing the grid.
• Switching between preview mode and edit mode.
• Changing pages.
• Changing the zoom.

Widgets are the elements that can be added in the Designs to display report data. Each Widget, according to its operation, has its own configuration.

Widgets can be placed in any position within a page. They can also be resized, but depending on the Widget they have minimum and maximum dimensions to be displayed correctly.

When a Widget is added to a page it must be configured, which can be done from the drop-down menu in its upper right corner or by double-clicking on it.

Some Widgets, such as module graphs, can be configured in two different ways:

• Static configuration: The Widget configuration uses specific elements as a Data source.

For example, in a module graph, it is a specific module of an agent.

• Dynamic configuration: The Widget configuration uses a Data source external to the Design. The configuration is generally done with regular expressions, generating an element in the report for each match it has in the Data source.

For example, for module graphs, the Widget could be configured so that a graph is generated in the report for all agents (.*) with modules that include “CPU” in their name (.*CPU.*).

Widgets with dynamic configuration can therefore generate as many new elements and pages in the final report as necessary, but they will always occupy at least their assigned space.

Some Widgets, due to their own operation, despite not being dynamic elements depend on Data sources to be able to display information. For example, the Top N of agent modules Widget.

The report generation will try to calculate the best positions for the additional elements it has to add due to dynamic configurations, always respecting the defined Design as much as possible.

In the Design Builder, dynamic elements will be displayed differently, representing that they can expand to the right and/or downwards whenever they can.

The Builder uses a Draft system for each user in each Design. At the moment a user starts making changes to a Design, those changes are stored in a new Draft.

These Drafts allow the user to leave the application and return at any time to resume the editing work. It is not until changes are saved with the Save button that the changes are effective and usable for new reports that are generated.

In case of concurrency when editing a Design, users will be notified at the moment of entering the Builder. This way, users will have to decide whether to discard their Draft (in case they already have it in progress) or if they save the changes they have.

The undo and redo actions will only work with changes made in a Draft. That is, the moment a configuration is saved or discarded, it will not be possible to undo or redo with the action buttons.

Data sources allow defining sets of agents and agent groups that will be used in report generation for dynamically configured elements.

This section is accessible from the side menu in Operation > Reporting > Dynamic reports > Data sources

When creating a Data source, it is first necessary to indicate at least:

• Name.
• Group.
• Description (Optional).

The group is very important to limit other users' access to said Data source:

• If the Data source belongs to the “All” group:
  • It can be used by all other environment users with RR, RW or RM permission on any group.
  • It can only be edited, duplicated or deleted by administrator users or with explicit RW permission on the “All” group.
• If the Data source belongs to another group:
  • It can be used by users with RR, RW or RM permission on said group.
  • It can only be edited, duplicated or deleted by administrator users or with RW permission on said group.

Besides that basic information, the elements that are part of the Data source must be indicated:

• Agents.
• Groups.
• Agent Wildcards: They are regular expressions that are evaluated for agents at the time of generating a report based on the permissions of the user generating the report.
• Group Wildcards: They are regular expressions that are evaluated for groups at the time of generating a report based on the permissions of the user generating the report.

Data sources are optional for report generation, since a Design could exclusively have statically configured Widgets.

Report's Definitions are reusable and programmable configurations for effective report generation.

This section is accessible from the side menu in Operation > Reporting > Dynamic reports > Definitions.

When creating a Definition, it is first necessary to indicate at least:

• Name.
• Description (Optional).
• Group.
• Design.
• Data source (Optional).
• Use custom time period: In case it is enabled, a specific time period different from the one configured in each Widgets of the design can be used to use it in all Widgets when generating the report.
• Notify: If enabled, the user will receive a notification in the console when the report has finished generating.

The group is very important to limit other users' access to said Definition:

• If the Definition belongs to the “All” group:
  • It can be used by all other environment users with RR, RW or RM permission on any group.
  • It can only be edited, duplicated or deleted by administrator users or with explicit RW or RM permission on the “All” group, and the Definition owner.
• If the Definition belongs to another group:
  • It can be used by users with RR, RW or RM permission on said group.
  • It can only be edited, duplicated or deleted by administrator users or with RW or RM permission on said group, and the Definition owner.

A Definition can also be scheduled to generate a report periodically.

It can also be configured to send the reports it generates by mail (besides being accessible from the console itself).

Generated reports are files stored in the Pandora FMS console that display environment information with a predefined Design and specific Data sources.

These files are generated in the background, because they may require a lot of time to complete depending on the amount of data to show.

This section is accessible from the side menu in Operation → Reporting → Dynamic reports → Generated reports.

When creating a report, it is first necessary to indicate at least:

• Name.
• Description (Optional).
• Group.
• Design.
• Report type: There are 4 possible report types:
  • HTML: They can only be viewed from the Pandora FMS console, and allow interacting with the report elements.
  • PDF: They generate a single file that can be viewed or downloaded from the console.
  • CSV: They generate a .zip file of multiple CSV files (one for each report element). They can only be downloaded, but not viewed from the console.
  • JSON: They generate a single file that can be viewed or downloaded from the console.
• Data source (Optional).
• Use custom time period: In case it is enabled, a specific time period different from the one configured in each Widget of the design can be used to use it in all Widgets when generating the report.
• Notify: If enabled, the user will receive a notification in the console when the report has finished generating.

The group is very important to limit other users' access to said Definition:

• If the report belongs to the “All” group:
  • It can be viewed and downloaded by all other environment users with RR, RW or RM permission on any group.
  • It can only be regenerated or deleted by administrator users or with explicit RW or RM permission on the “All” group, and the report owner.
• If the report belongs to another group:
  • It can be viewed and downloaded by users with RR, RW or RM permission on said group.
  • It can only be regenerated or deleted by administrator users or with RW or RM permission on said group, and the report owner.

It can also be configured to send the Generated report by mail (besides being accessible from the console itself).

In general, report permission bits grant these accesses:

• RR:
  • List Generated reports of their group and their own.
  • Create new reports.
  • View reports of their group and their own.
  • Regenerate/Delete their own reports.
  • List report Definitions of their group and their own.
  • Create new Definitions.
  • Use Definitions of their group and their own.
  • Edit/Delete their own Definitions.
• RW:
  • List Generated reports of their group and their own.
  • Create new reports.
  • View reports of their group and their own.
  • Regenerate/Delete reports of their group and their own.
  • List report Definitions of their group and their own.
  • Create new Definitions.
  • Use Definitions of their group and their own.
  • Edit/Delete Definitions of their group and their own.
  • List Data sources of their group.
  • Create Data sources.
  • Edit/Delete Data sources of their group.
  • List Designs of their group.
  • Create Designs.
  • Edit/Delete Designs of their group.
• RM:
  • List Generated reports of their group and their own.
  • Create new reports.
  • View reports of their group and their own.
  • Regenerate/Delete reports of their group and their own.
  • List report Definitions of their group and their own.
  • Create new Definitions.
  • Use Definitions of their group and their own.
  • Edit/Delete Definitions of their group and their own.

←Back to Pandora FMS documentation index