動的レポート

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

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

Pandora FMS の動的レポート機能を使用すると、環境監視データをシンプルかつ快適に表示するための、完全にカスタマイズされたドキュメントを作成できます。

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.

これらのレポートは、主に以下の 2つの要素に基づいています。

• デザイン: レポートの形状や内容を定義するもので、各種要素、ページ数、表紙、目次などが含まれます。
• データソース: レポートに表示する情報の元となるもので、デザインと組み合わされるエージェントやエージェントグループのセットを定義します。

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.

デザインは、Pandora FMS の動的レポートにおける主要な要素です。事前に少なくとも 1つのデザインが用意されていなければ、新しいレポートを作成することはできません。

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.

このセクションには、サイドメニューの 操作(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.

• デザインが「すべて」グループに属している場合：
  • いずれかのグループにおいて RR 、RW、または RM の権限を持つすべての環境ユーザが、そのデザインを使用できます。
  • 管理者ユーザ、または「すべて」グループに対する明示的な RW 権限を持つユーザのみが、そのデザインの編集、複製、または削除を行えます。
• デザインが別のグループに属している場合：
  • そのグループにおいて RR、RW、または RM の権限を持つユーザが、そのデザインを使用できます。
  • 管理者ユーザ、またはそのグループに対する RW 権限を持つユーザのみが、そのデザインの編集、複製、または削除を行えます。

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.

• 新規ページの構成設定:
• 目次の生成: レポートの最初のページとして自動生成されます（表紙が生成される場合は 2ページ目となります）。
• 表紙の生成: 指定した内容を含む表紙が、レポートの最初のページとして自動生成されます。
• ページヘッダの生成: 表紙を除く各ページの最初の4つのセルが使用されます。デザインのページ内に既にコンテンツが存在し、そのいずれかで該当する4つのセルが使用されている場合、ページヘッダを有効にすることはできません。
• ページフッタの生成: 表紙を除く各ページの最後の3つのセルが使用されます。デザインのページ内に既にコンテンツが存在し、そのいずれかで該当する3つのセルが使用されている場合、ページフッタを有効にすることはできません。

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.

• (_REPORT_NAME_): 生成されたレポートの名称。
• (_DATETIME_): レポート生成日時。日付の形式は、メニュー 管理(Management) → セットアップ(Settings) → システム設定(System Settings) → 画面設定(Visual styles) → その他(Other) → データフォーマット文字列(Date format string) または グループの表示スタイル 設定で指定された形式に従います。
• (_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:

モジュールグラフなどの一部のウィジェットは、2通りの方法で設定できます。

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

• 静的設定(Static configuration): ウィジェットの設定において、特定の要素をデータソースとして使用します。

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.

• 動的設定(Dynamic configuration): ウィジェットの設定には、デザインの外部にあるデータソースが使用されます。設定は一般的に正規表現を用いて行われ、データソース内で一致する項目が見つかるたびに、レポート内に要素が生成されます。

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

例えばモジュールグラフの場合、名前に「CPU」を含むモジュール（.*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.

一部のウィジェットは、動的な要素ではないにもかかわらず、その動作の仕組み上、情報を表示するためにデータソースを必要とします。例えば、「エージェントモジュールのトップ N (Top N of agent modules)」ウィジェットなどがこれに該当します。

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.

この「下書き」機能により、ユーザはアプリケーションを一旦離れても、いつでも作業を再開して編集を続けることができます。「保存(Save)」ボタンで変更内容を保存して初めて、その変更が有効となり、新たに生成されるレポートに反映されるようになります。

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

このセクションには、サイドメニューの「操作(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.

• データソースが「すべて」グループに属している場合：
  • いずれかのグループに対して RR、RW、または RM の権限を持つすべての環境ユーザが、そのデータソースを使用できます。
  • 管理者ユーザー、または「すべて」グループに対する明示的な RW 権限を持つユーザのみが、そのデータソースの編集、複製、または削除を行えます。
• データソースが別のグループに属している場合：
  • そのグループに対して RR、RW、または RM の権限を持つユーザーが、そのデータソースを使用できます。
  • 管理者ユーザ、またはそのグループに対する RW 権限を持つユーザーのみが、そのデータソースの編集、複製、または削除を行えます。

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.

このセクションには、サイドメニューの「操作(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.

• 名前(Name)
• 説明(Description)（任意）
• グループ(Group)
• デザイン(Design)
• データソース(Data source)（任意）
• カスタム期間を使用(Use custom time period)：これを有効にすると、レポート生成時に、デザイン内の各ウィジェットで設定された期間とは異なる特定の期間を、すべてのウィジェットに対して適用できます。
• 通知(Notify)：これを有効にすると、レポートの生成完了時にコンソールで通知を受け取ります。

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.

• 定義が「すべて」グループに属している場合：
  • 任意のグループに対して RR、RW、または RM の権限を持つすべての環境ユーザが、その定義を使用できます。
  • 管理者ユーザ、または「すべて」グループに対する明示的な RW もしくは RM 権限を持つユーザー、および定義の所有者のみが、その定義の編集、複製、または削除を行えます。
• 定義が別のグループに属している場合：
  • そのグループに対して RR、RW、または RM の権限を持つユーザが、その定義を使用できます。
  • 管理者ユーザ、またはそのグループに対する RW もしくは RM 権限を持つユーザ、および定義の所有者のみが、その定義の編集、複製、または削除を行えます。

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.

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