Stand-alone Generic Log Adapter v4.4
Installation Guide

This install guide describes how to install the TPTP Generic Log Adapter stand-alone run-time package. This package is used to run the Generic Log Adapter as a stand-alone application. It can be downloaded from the Eclipse Test and Performance Tools Platform download site.

This installation guide contains the following information:

• Software prerequisites
• Installing the Adapter Configuration Editor
• Installing the Generic Log Adapter Runtime
  

Software prerequisites

• Java runtime (JRE) or Java development kit (JDK) 1.5 or 1.4

Installing the Adapter Configuration Editor

The Adapter Configuration Editor is a tool for creating, modifying and testing adapter configuration files. Adapter configuration files provide the Generic Log Adapter with information necessary to parse log files and specify which log files to parse, how to parse them, and what to do with the parsed log file data. The Adapter Configuration Editor is included in the Monitoring Tools package of the Eclipse Test and Performance Tools Platform.

To install Adapter Configuration Editor, the Platform SDK and Monitoring Tools SDK packages are required to be installed. These packages can also be downloaded from the Eclipse Test and Performance Tools Platform download site. For more information on installing these packages refer to the Eclipse Test and Performance Tools Platform Installation Guide.

For information about using the Adapter Configuration Editor to create static or rule-based adapters, see Stand-alone Generic Log Adapter v4.4 User's Guide.

Installing the TPTP Generic Log Adapter Runtime

The TPTP Generic Log Adapter runtime package consists of the following components:

• bin - contains the gla.bat and gla.sh runtime scripts used to execute the Generic Log Adapter as a stand-alone application.
• lib - contains the runtime jar files required to execute the Generic Log Adapter.
• schema - contains the schema files that describe Generic Log Adapter configurations and are used to validate adapter configuration files at run-time.
• config - contains directories for application log types supported in the Generic Log Adapter stand-alone package. The directories include adapter configuration files, example log files, and example batch files to parse the example logs. The table below lists the supported log file types.

  Parser name	Supported versions (adapter type)
  Apache HTTP Server access log	1.3.20(static), 1.3.26(static), 2.0(static), 1.3.x(rules), 2.0.x(rules)
  Apache HTTP Server error log	1.3.20(static), 1.3.26(static), 2.0(static), 1.3.x(rules), 2.0.x(rules)
  Common Base Event XML log	1.0.1(rules)
  Java Logging XML log	1.4(static), 5(static)
  Microsoft Windows Application log	All(rules)
  Microsoft Windows Security log	All(rules)
  Microsoft Windows System log	All(rules)

  
   

To install the Generic Log Adapter runtime:

1. Unzip the stand-alone Generic Log Adapter package. Typically, the package name has the form tptp.gla.runtime-VersionInfo.zip. The Generic Log Adapter package includes a root directory called GenericLogAdapter.
   Note: If you are installing on a z/OS system, use the following commands to unzip the GLARunTime.zip file:
   1. unzip -a tptp.gla.runtime-VersionInfo.zip
   2. unzip -o tptp.gla.runtime-VersionInfo.zip *.adapter
   3. unzip -o tptp.gla.runtime-VersionInfo.zip *.xsd
2. Open the command file for running the Generic Log Adapter:
   • For a Windows environment, edit the bin\gla.bat file.
   • For a non-Windows environment, edit the bin/gla.sh file.
3. Replace the value for GLA_HOME with the Generic Log Adapter install directory. For example, if you unzipped the Generic Log Adapter package in the c:\ directory, set GLA_HOME=c:\GenericLogAdapter.
4. Update the class path as required. For example, if you wrote a static parser or substitution extension class you need to add them to the class path in order for the Generic Log Adapter to execute them.

The gla.bat and gla.sh files execute the Generic Log Adapter with an adapter configuration file specified as a command line parameter. For example, gla.bat myadapter.adapter. The adapter configuration file describes the log file to parse, the rules used to parse the file and the destination of the resulting parsed data.

For information about using the stand-alone Generic Log Adapter, see Stand-alone Generic Log Adapter v4.4 User's Guide.

Copyright © 2005, 2007 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