Incubator/Metrics: Adding Report

From Globus

Concepts

In general, the usage statistics reports are standalone programs that query the database and generate the report data in some custom-defined XML format. Then XSL transformations are applied on the XML data which generate gnuplot instructions and data files. Finally, the gnuplot program is used to generate the graphs using the generated instructions and data files.

Writing reports

The base directory used for reports is usage/java/reports/source.

Each component should define its own Java namespace. For example, Java WS Core report uses the org/globus/usage/report/jwscore namespace.

Each component report should have its own main Java class through which the report is executed. The component report implementation should use the org.globus.usage.report.common.DatabaseRetriever class to execute the queries. That will also ensure that the report uses the same database configuration file as other reports. A command line script should also be generated for the main report Java class (update the etc/post-deploy.xml file). The command line script should be named <component>-report.

Configuration

The reports use the $GLOBUS_LOCATION/etc/globus_usage_reports/db.properties file for the database information. Make sure the db.driver and db.url properties are configured properly.