• What Report Modules Do
• Module Types
• Module Data
• Adding Custom Modules

Report Modules process history records on demand in order to provide trend analysis or other similar operations.

Report Modules may be compiled or scripted.

Modules are provided an XML document containing a SurvivorReportRequest element, which may include configuration information obtained from instance.cf.

Modules generate output suitable to their purpose and the style requested according to the requesting interface (eg: the Command Line or Web interface).

All Report Modules must conform to the Report Module Specification, otherwise they may not interact correctly with the package components.

Routines useful for building Report Modules in Perl are provided in Survivor.pm and Survivor::Report.pm. As a starting point, see the existing modules in src/modules/report.

For information on these modules, run

     % perldoc src/modules/common/Survivor.pm
     % perldoc src/modules/common/Survivor/Report.pm
 

For assistance in testing Report Modules, the XML Maker utility may be useful.

Important: Please see the license for this package to see if custom modules are subject to the same license.