Generic Log Adapter Web Services bundle v4.2.0

GLASubscriber Web Service
Prerequisites
Installation
Configuring the GLASubscriber
Configuring the Generic Log Adapter
Configuring the Autonomic Management Engine
Running the ensemble
Documentation
Limitations and Restrictions
Related Packages



GLASubscriber Web Service

The Generic Log Adapter (GLA) Web Services bundle contains the GLASubscriber which runs as a web service and acts as interface between Autonomic Management Engine (AME) and GLA. The resource model (RM) running on AME considers the GLASubscriber to be the managed resource. In other words, GLASubscriber acts as the proxy for the managed resource and GLA.  

Prerequisites
Apache Axis 1.2 (Axis) - Download

Installation
Install Apache Axis using the installation guide provided with Axis. Once Axis has been installed successfully and you are able to see the Axis Happiness page go on and copy the contents of WEB-INF folder in the GLAWebservices.zip into the WEB-INF folder of AXIS_HOME (directory where you have installed Axis). Now the steps provided in the Axis installation guide can be followed to deploy the GLASubscriber web service using the deploy_subscriber.wsdd deployment descriptor file present in the AXIS_HOME\WEB-INF directory. The deployment of the GLASubscriber can be verified by viewing the list of services deployed on Axis. The undeploy_subscriber.wsdd file present in the AXIS_HOME\WEB-INF can be used when the GLASubscriber web service has to be undeployed.

Configuring the GLASubscriber
The subscriber.properties file can be used to specify the configuration for the GLASubscriber. The configuration for the GLASubscriber includes the Port Number and the Host Name for the RMI registry that the GLASubscriber is supposed to use.

rmiRegistryHostName=localhost
rmiRegistryPortNo=1099

Configuring the Generic Log Adapter
The following steps can be followed to configure the Generic Log Adapter:  

·        Edit the adapter file to include an outputter component with the Executable class set to “com.ibm.etools.logging.adapter.outputters.AMEWebServiceOutputter”.

·        Change the Outputter type to “undeclared” and include the three required properties for the outputter.

o       bufferSize: Specifies the maximum number of records that have to be buffered.

o       resourceName: The unique identifier for this instance of the GLA. This will be used by the AME to identify the resource with which it is supposed to communicate.

o       rmiRegistryPort: This is the port at which the RMI registry will be created by the GLA. If a registry is already available then that registry will be used by the GLA. Please note that the GLASubscriber web service and the adapter should be configured to use the same RMI registry for them to communicate with each other.

o       waitUntilTime: This is an optional property with which the user can configure the wait time

§         If the value is < 0 then it waits till manager is up.

§         if the value is = 0 then it will never wait for sending Common Base Events.

§         if the value is x, then it waits for x milliseconds for each Common Base Event until a manager notifies it to send.

·        Include the Axis jars into the classpath of the Generic log adapter before running the script file.

o       For shell scripts:

# INSTRUCTIONS: Change the path of AXIS_HOME to the installed directory of axis on your system, add the below lines to the beginning of your shell script and add $AXISCLASSPATH to the classpath of your Generic Log Adapter

set AXIS_HOME=/usr/axis
set AXIS_WEB=$AXIS_HOME/WEB-INF
set AXIS_LIB=$AXIS_WEB/lib
set AXISCLASSPATH=$AXIS_LIB/axis.jar:$AXIS_LIB/commons-discovery.jar:$AXIS_LIB/commons-logging.jar:$AXIS_LIB/jaxrpc.jar:$AXIS_LIB/saaj.jar:$AXIS_LIB/log4j-1.2.8.jar:$AXIS_LIB/xml-apis.jar:$AXIS_LIB/xercesImpl.jar
export AXIS_HOME; export AXIS_LIB; export AXISCLASSPATH

o       For windows batch files:

@rem INSTRUCTIONS: Change the path of AXIS_HOME to the installed directory of axis on your system, add the below lines to the beginning of your batch file and add %AXISCLASSPATH% to the classpath of your Generic Log Adapter

set AXIS_HOME=d:\axis
set AXIS_WEB=$AXIS_HOME\WEB-INF
set AXIS_LIB=%
AXIS_WEB%\lib
set AXISCLASSPATH=%AXIS_LIB%\axis.jar;%AXIS_LIB%\commons-discovery.jar;%AXIS_LIB%\commons-logging.jar;%AXIS_LIB%\jaxrpc.jar;%AXIS_LIB%\saaj.jar;%AXIS_LIB%\log4j-1.2.8.jar;%AXIS_LIB%\xml-apis.jar;%AXIS_LIB%\xercesImpl.jar

 

Configuring Autonomic Management Engine
Create a resource model for the GLA that has to be monitored by the AME and specify the resourceName that the adapter has been configured with as the MRID. The URL of the GLASubscriber should be specified as the End Point Reference address for this resource and install the resource model on AME using the SARA client. More information on creating resource models and specifying other configuration can be found in the AME documentation.

Running the ensemble
Once the above configuration has been completed the following steps can be followed to start the communication with AME:

·        Verify that the GLASubscriber web service is running.

·        Start the shell script or batch file to run the adapter.

·        Start the resource model installed on AME using the SARA client.

Documentation

·        The documentation for Generic Log Adapter is provided by the Eclipse online help system which available when the Generic Log Adapter Rule Builder and Log Trace Analyzer Plug-in is installed.

·        The documentation for Autonomic Management Engine is provided with the AME installable.

Limitations and Restrictions

·        If the GLASubscriber is stopped or terminated while the AME-GLA communication is underway then the GLASubscriber web service will have to be started and all the related resource models running on AME will have to be restarted.

Related Packages
Generic Log Adapter and Log and Trace Analyzer Plug-in: Eclipse based development environment to create rules and to analyze log/trace files.