ReportBase:Services

From CustosecWiki
Jump to navigation Jump to search

ReportBase consists of four main services.

  • Data Collection,
  • Reporting,
  • Administration Interface and
  • Data Export.

The Data Collection service is responsible for adding data from ARANSEC or CustoSec and the Reporting service is responsible for generating reports from the revolving templates. The Administration Interface maintains the templates and cockpit documents..


Data Collection

The Data Collection Service in ReportBase is a "listening" service, that will be provided with data from an enabled ARANSEC or CustoSec System (considered as the "Source").

It is not actively asking for data, but receiving it. The Source will try to send data in certain time intervals (default 5 Minutes) and ReportBase will check the data and accept it. In a Multi-location implementation ReportBase will accept data from all valid sources.


The following data files are transferred (NAGIOS Files):

  • Host Report
  • Host Performance Data
  • Service Report
  • Service Performance Data Cockpit or Dashboard


After Installation of the ReportBase Plugin into ARANSEC or CustoSec and enabling the source in "ReportBase the systems start to communicate with each other.

Upon handshake, the Data Collection Service of ReportBase will tell ARANSEC or CustoSec, which information it needs (time range); within ARANSEC / CustoSec the data then is retrieved and exported. This means, in case, a data transfer fails, all the missing data will be collected during the next working connection.


Note: No configuration data will be transferred. This means, information not available in the files mentioned above, will not be known to ReportBase. This is the reason, why in all Service and Host Checks in ARANSEC/CustoSec the parameter "Process Perf(ormance) Data" should be set to "Yes" to make sure check results will be written into the performance data files (this is the Default setting anyway).


Reporting

The reporting module automatically calls all revolving templates and generates the image and optional export file. The minimum interval is 5 minutes and can be increased. Manual templates are ignored.


Administration Interface or Client

ReportBase provides a powerful tool to assist in the creation of templates and cockpit documents. The user interface is easy to use and provides many tools to assist in creating and maintaining templates and cockpit documents. This is a Java Application running on a local machine. Before using for the first time, the application has to be downloaded from ARANSEC / CustoSec (see Downloading the local client).


Templates and Reports

A template contains all the necessary information required to generate a report. A report is generated using the data stored in the template and consists of an image file and an optional export file. The image file can be a png or jpg image and the optional export file can be a csv, xml or text format. Templates can be revolving or manual.


Cockpit or Dashboard

This allows the generated graphic images to be displayed by any web browser. In addition to the generated images text can also be included. The generated html pages can be customized to suit corporate and personal tastes.




Back to Basic Concept —————— Forward to Data Export