Using Actuate logging and monitoring APIs : About BIRT iHub usage and error log consolidator
 
About BIRT iHub usage and error log consolidator
The log consolidator application is a Java application that reads data from an BIRT iHub usage or error log file and uses JDBC to add the information to a database. In an BIRT iHub cluster, you must install and run the log consolidator application on each BIRT iHub node to consolidate the cluster’s usage and error log information in a database. Before running the log consolidator application, you must install the following components:
*BIRT iHub
*Log consolidator application files
*Log consolidator configuration file
*Database used by the log consolidator application
BIRT iHub installs the required JAR files for the log consolidator application in $ACTUATE_HOME/Jar/UsageAndErrorConsolidator. These files include:
*usageanderrorconsolidator.jar
The com.actuate.consolidator application class and properties files.
*Java Architecture for XML Binding (JAXB) JAR files
JAXB provides a framework that supports run-time mapping between XML and Java objects.
*ojdbc14.jar
The supported Oracle JDBC Driver. The reference implementation uses Oracle as the example database.
*naming-java.jar
Contains the handler for the Java namespace.
The log consolidator application also uses the following Microsoft Windows Registry key or UNIX environment variable set by BIRT iHub installation process:
*On Windows, make sure the following registry key exists:
HKEY_LOCAL_MACHINE\SOFTWARE\Actuate\Common\9.0\AC_JRE_HOME
The log consolidator application uses java.exe from:
AC_JRE_HOME\bin
*On UNIX, make sure the following environment variable exists:
AC_JRE_HOME
The log consolidator application uses java.exe from:
$AC_JRE_HOME/bin
In BIRT iHub Integration Technology, the UsageAndErrorConsolidator directory contains additional files that you must use to complete the installation of the log consolidator application:
*/DBScripts contains the SQL script, CreateActuateLogTables.sql, which creates the tables in the Oracle database used by the Actuate log consolidator sample application. A readme.txt file describes this SQL script file.
*/jar contains the JAR files required by the log consolidator application.
*/Setup contains the following files that startup and shutdown the log consolidator application:
*consolidatorconfig.xml is the sample consolidator configuration file that specifies settings such as the following items:
*Database driver, URL, encoding, schema, user name, and password
*Usage and error log details, such as the file names, refresh interval, number of logs, and whether a log file is enabled
*The UNIX version uses the scripts, start_consolidator.sh and stop_consolidator.sh, to start up and shut down the log consolidator application.
*The Windows version uses a setup application, consolidatorwin.exe, that installs the log consolidator application as a Windows service and starts and stops the application.
*A readme.txt file describes how to use these components.
*/src contains the following items:
*usageanderrorconsolidator.jar, the JAR file for the log consolidator application
*consolidatormake.xml, an Ant build file
*com.actuate.consolidator, the log application source code