The ReportGenerator component runs the Report Generator, which processes Log Server files into HTML-based reports that you can view in your Web browser and XML reports that you can view in Workbench.
Every Application Controller component contains the following attributes:
|
Attribute |
Description |
|---|---|
|
component-id |
Required. The name of this instance of the component. |
|
host-id |
Required. The alias of the host upon which the component is running. |
|
properties |
An optional list of properties, consisting of a required name and an optional value. |
The ReportGenerator component contains the following sub-elements:
|
Sub-element |
Description |
|---|---|
|
working-dir |
Working directory for the process that is
launched. If it is specified, it must be an absolute path. If any of the other
properties of this component contain relative paths, they are interpreted as
relative to the working directory. If working-dir is not specified, it defaults
to
|
|
input-dir-or-file |
Required. Path to the file or directory containing the logs to report on. If it is a directory, then all log files in that directory are read. If it is a file, then just that file is read. |
|
output-file |
Required. Name the generated report file and path to where it is stored. For example:
|
|
stylesheet-file |
Required. Filename and path of the XSL stylesheet used to format the generated report. For example:
|
|
settings-file |
Path to the report_settings.xml file. For example:
|
|
timerange |
Sets the time span of interest (or report window). Allowed keywords: These keywords assume that days end at midnight, and weeks end on the midnight between Saturday and Sunday. |
|
start-date <date> stop-date <date> |
These set the report window to the given
date and time. The date format should be either
|
|
time-series |
Turns on the generation of time-series data and specifies the frequency, Hourly or Daily. |
|
charts |
Turns on the generation of report charts. Disabled by default. |
|
log-file |
The path to the ReportGenerator log file. If the log-file is not specified, the default is component working directory plus component name plus “.log”. |
|
java_binary |
Should indicate a JDK 1.6.x or later. Defaults to the JDK that Endeca installs. |
|
java_options |
Command-line options for the java_binary setting. This command is primarily used to adjust the ReportGenerator memory, which defaults to 1GB. To set the memory, use the following: java_options = -Xmx[MemoryInMb]m -Xms[MemoryInMb]m
|
|
args |
Command-line flags to pass to the ReportGenerator, expressed as a set of arg sub-elements. |
Example 17. Example
The following example provisions a ReportGenerator component based on the sample wine data.
<reportgenerator component-id="wine_gen_html_report" host-id="wine_indexer"> <working-dir> C:\Endeca\PlatformServices\reference\sample_wine_data </working-dir> <input-dir-or-file>.\logs\logserver_output</input-dir-or-file> <output-file>.\reports\daily\daily_report.html</output-file> <stylesheet-file>.\etc\report_stylesheet.xsl</stylesheet-file> <settings-file>.\etc\report_settings.xml</settings-file> <timerange>day-so-far</timerange> <charts>true</charts> <log-file>.\logs\wine_gen_html_report.log</log-file> </reportgenerator>
