Configuring a report batch is one of the steps in creating a custom report. You typically configure it after creating report configuration files. This configuration file determines what reports get executed by the reporter, how often the reports get executed and where the reports get saved. If a single report can be used with different parameters, these parameters are also configured in the report batch.
Reference
| Element |
Required/Optional |
Description |
| <report-group> |
Required |
Contains the Report list, the Frequency, the report parameters and the output directory for the batch. |
| <frequency> |
Required |
A string containing the number of seconds, minutes between each execution of the report batch. 10s will run the report ever 10 seconds. 5m will run the report every 5 minutes. Selecting an appropriate frequency is critical. If the frequency is too short, the reporter can generate a large amount of data and consume significant disk space. If the frequency is too long, the information will not be useful. It is recommended that a process for purging and archiving historical information is in place PRIOR to configuring the reporter. |
| <output-directory> |
Optional |
The directory path to prepend to the output file names from the report configuration files. The username which the node is executing MUST have read write access to this path. |
| <report-list> |
Required |
The list of reports to execute. |
System Properties
| Property |
Default |
Description |
| tangosol.coherence.management.report.configuration |
reports/report-group.xml |
The XML file containing the Reporter configuration settings. (list of reports, the report frequency, etc) |
| tangosol.coherence.management.report.autostart |
false |
Flag to automatically start the reporter when the node is started. |
| tangosol.coherence.management.report.distributed |
false |
Determines if the reporter is running in a central model (false) or on every node in the cluster (true). |
