Appendix II: Stand-alone Generic Log Adapter package contents

This appendix describes the contents of the stand-alone Generic Log Adapter package that is available in Test and Performance Tools Platform.

The stand-alone Generic Log Adapter package consists of the following components organized by directories:

The following sections describe the content of each directory in more detail

bin

This directory contains script files for executing Generic Log Adapter as a stand-alone application. gla.bat is used for executing Generic Log Adapter on Windows systems and gla.sh is used for executing Generic Log Adpater on non-Windows systems. The script files require one parameter, the name of the adapter configuration file that specifies the log file to parse and how it is to be parsed. The script files set the required classpath and execute the Generic Log Adapter main java class with the adapter configuration file name that is specifed as a command-line parameter.

To use gla.bat and gla.sh they must be modified by replacing the value of GLA_HOME with the Generic Log Adapter install directory. Also, for any custom java classes that Generic Log Adapter is to execute the appropriate jar file or class file directory must be added to the classpath in the script file. Because Generic Log Adapter is a java application, a 1.4 or 1.5 java runtime environment (JRE) or java development kit (JDK) must be in the PATH environment in order to execute the script file. Alternatively, the script file can be modified to add the JRE or JDK to the PATH environment.

The following is an example of how to run stand-alone Generic Log Adapter from a Windows Command prompt:

 gla.bat c:\myadapter.adapter

lib

The Generic Log Adapter java libraries and required libraries included in the lib directory are described below:

Library Description
com.ibm.icu_version.jar International Components for Unicode - used for internationalization support.
emf.common_2.2.0.version.jar and emf.ecore_2.2.0.version.jar EMF libraries required by Common Base Event implementation
hexr.jar Remote agent execution framework required by logging agent outputters
hgla.jar Generic Log Adapter run-time library
hlcbe101.jar TPTP CommonBaseEvent implementation
hlcore.jar TPTP Logging Core library required by logging agent outputters
hparse.jar Generic Log Adapter static parser support library

schema

The stand-alone Generic Log Adapter package includes the XML schema files that describe the adapter configuration file structure. These files are used by Generic Log Adapter to validate the adapter configuration file. In order to validate the adapter configuration file, the GLA_HOME variable must be defined to the java process. To do this, ensure that the JVM argument -DGLA_HOME=GLA Installation directory is included in the java command to execute Generic Log Adapter. The bin\gla.bat and bin\gla.sh files contain this JVM variable. If GLA_HOME is not defined to the java process an error message will be written to the Generic Log Adapter log file hgla.log. The individual schema files are described below:

XML Schema File Description
Adapter.xsd Root schema for the adapter configuration
ComponentConfiguration.xsd Schema for the context instance
Context.xsd Schema for the context and component types
Extractor.xsd Schema for the Extractor component
Filter.xsd Schema for the internal Filter component. Note this is an internal schema and is subject to change.
Formatter.xsd Schema for the Formatter component
Outputter.xsd Schema for the Outputter component
Parser.xsd Schema for the Parser component
ProcessUnit.xsd Schema for a generic Process Unit component. Note this is used as a base schema for most of the other component schemas.
Sensor.xsd Schema for the Sensor component
commonbaseevent1_0_1.xsd Schema for Common Base Event v1.0.1

config

The config directory of the stand-alone Generic Log Adapter contains adapter configuration files for parsing various application log types. It also contains, for each log type, a sample log file and script files to execute Generic Log Adapter with the adapter configuration file to parse the sample log file. The config directory contains sub-directories for the supported log types. The following describes the files included in the config directory for each log type:

example.log
This is a sample log file that can be parsed by Generic Log Adapter with the adapter configuration file located in the same directory.
regex.adapter
This is a rules-based adapter configuration file. It is configured for use in a log import scenario with Log and Trace Analyzer component of Test and Performance Tools Platform. It is configured with a special outputter that can only be used with log import. Note, this file is only present for log types that have a rules-based parser implementation.
regex_example.adapter
This is a rules-based adapter configuration file. It is configured to parse the sample example.log file and write the resulting CommonBaseEvent XML records to a file called example.out. Note, this file is only present for log types that have a rules-based parser implementation.
runregex_example.bat
This is a script file for executing Generic Log Adapter with the regex_example.adapter file on a Windows system. The result of running this script is that the log records in example.log are parsed into CommonBaseEvents which are then written to the file example.out.
runregex_example.sh
This is a script file for executing Generic Log Adapter with the regex_example.adapter file on a non-Windows system. The result of running this script is that the log records in example.log are parsed into CommonBaseEvents which are then written to the file example.out.
run_example.bat
This is a script file for executing Generic Log Adapter with the static_example.adapter file on a Windows system. The result of running this script is that the log records in example.log are parsed into CommonBaseEvents which are then written to the file example.out. Note, this file is only present for log types that do not have a rules-based parser implementation.
run_example.sh
This is a script file for executing Generic Log Adapter with the static_example.adapter file on a non-Windows system. The result of running this script is that the log records in example.log are parsed into CommonBaseEvents which are then written to the file example.out. Note, this file is only present for log types that do not have a rules-based parser implementation.
static.adapter
This is a static parser adapter configuration file. It is configured for use in a log import scenario with Log and Trace Analyzer component of Test and Performance Tools Platform. It is configured with a special outputter that can only be used with log import. Note, this file is only present for log types that have a static parser implementation.
static_example.adapter
This is a static parser adapter configuration file. It is configured to parse the sample example.log file and write the resulting CommonBaseEvent XML records to a file called example.out. Note, this file is only present for log types that do not have a rules-based parser implementation.

To use the script files in the config directory they must be modified by replacing the value of GLA_HOME with the Generic Log Adapter install directory. Also, a 1.4 or 1.5 java runtime environment (JRE) or java development kit (JDK) must be in the PATH environment in order to execute the script files. Alternatively, the script file can be modified to add the JRE or JDK to the PATH environment.

No parameters are required to run the script files included in the config directory. Go to a command prompt or shell prompt and change the directory to the location of the script file. Type the name of the script file at the prompt and hit the Enter key.

Parent topic: Stand-alone Generic Log Adapter User's Guide

Copyright © 2006 IBM Corporation. All rights reserved. This document and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which is available at http://www.eclipse.org/legal/epl-v10.html