Adapter configuration file extensions
Generic Log Adapter can be extended through the creation of customized
components that can be included in a context. The following is a list of the
components that can be extended.
- Sensor: The sensor provides the mechanism to read the content for processing.
- Extractor: The extractor takes a collection of input lines provided by the sensor and separates them
into message boundaries.
- Parser: The parser takes the messages that have been delimited by the extractor and builds
a set of mappings of string values to a data structure (a Common Base
Event).
- Formatter: The formatter takes the mappings of attributes to their
values provided by the parser and builds the correct JavaTM object instance (a
Common Base Event).
- Outputter: The outputter externalizes the resulting Common Base Event records provided by the formatter. Outputters provide or wrap the
mechanism for storing the final outputs of the context.
Autonomic Computing provides the following components in the com.ibm.etools.logging.adapter Eclipse plugin.
The classes are packaged in the glacomponents.jar file. To use any of these components, glacomponents.jar must
be included in the classpath.
Sensor
- com.ibm.etools.logging.adapter.sensors.CEIQuerySensor: This sensor connects to a specified Common Event Infrastructure database
using JDBC-ODBC connectivity and converts each result received from the database to a Common Base Event XML string.
- com.ibm.etools.logging.adapter.sensors.ODBCQueryExecSensor: This sensor connects to a specified database using JDBC-ODBC connectivity and converts each row received from the database to an XML Record string.
- com.ibm.etools.logging.adapter.sensors.SNMPSensor: This sensor receives SNMP traps on a specified port and converts them to Common Base Event objects.
- org.eclipse.hyades.logging.adapter.sensors.SiebelSensor: This sensor can be
used for monitoring multiple files that have the same name. For example, an
application which updates multiple log files concurrently.
Sensor type |
Properties |
CEIQuerySensor |
- IBMCEISensorDSNName
- The DSN string used to connect to the database. This string contains the host name and the port number.
- IBMCEISensorlogID
- The key used to fetch a set of Common Base Events that are associated with this key.
- IBMCEISensorUserName
- The user ID used for the database login.
- IBMCEISensorPassword
- The user password used for the database login.
- IBMCEISensorQueryString
- The XPath query string used to fetch the data.
- IBMCEISensorDriverName
- The driver name used for connecting to the database.
- IBMCEISensorJDBCLocation
- The JAR file location of the driver used to connect to the database.
|
ODBCQueryExecSensor |
- IBMGAODBCSensorDSNName
- DSN name
- IBMGAODBCSensorDatabaseName
- Database name
- IBMGAODBCSensorUserName
- User name to access the database.
- IBMGAODBCSensorPassword
- Password used together with IBMGAODBCSensorUserName to access the database.
- IBMGAODBCSensorQueryString
- Database query string
- IBMGAODBCSensorDriverName
- Name of the ODBC driver to be used.
|
SiebelSensor |
- directory (required)
- The directory location of the file to be read by the
SiebelSensor.
- fileName (required)
- The name of the file to be read by the SiebelSensor. If the
application updates multiple files concurrently, regular
expressions can be used to specify the file name.
|
SNMPSensor |
- IBMGASNMPSensorSNMPPort
- SNMP port number. 162 is the default port number used.
|
Outputter
The outputters have the following properties:
Outputter type |
Properties |
AMEWebServicesOutputter |
- resourceName
- This property is used to specify the name of the managed resource, i.e. MRId that will be used by Autonomic Management Engine to identify the resource. The value for this property has to be unique.
- bufferSize
- This property is used to specify the size of the output buffer. This buffer is provided in order to avoid blocking in the outputter when events are being sent by the outputter. This is not a mandatory property . The default value for this property is 50.
- rmiRegistryPort
- This property is used to specify the port at which the RMI registry will be created by Generic Log Adapter. If a
registry is already available then this registry will be used by Generic Log Adapter. The GLASubscriber web service and the log adapter should be configured to
use the same RMI registry.
- waitUntilTime
- This optional property is used to specify the outputter wait time.
If the value is < 0, the outputter waits until the manager is up.
If the value is = 0, the outputter does not wait before sending Common Base Events.
If the value is x, the outputter waits x milliseconds for each Common Base Event and until a manager notifies the outputter to send the Common Base Event.
|
CEIOutputter |
- factoryName
- the emitter factory used to get the CEI emitter to send the Common Base Events to. This property is optional. If it is not specified, the default emitter factory com/ibm/events/configuration/emitter/Default is used.
- synchronizationMode
- Events can be sent in a synchronous or an asynchronous mode. This property is optional. If it is not specified, the default synchonization mode specified in the emitter factory profile is used. The valid values are synchronous and asynchonous.
- transactionMode
- When an event is sent, the emitter may be configured to send the event inside the same transaction as the client or within a new transaction. This property is optional. If it is not specified, the default transaction mode specified in the emitter factory profile is used. These valid values are same and new.
- providerURL
- Specify the URL of a remote Java Naming and Directory Interface (JNDI) provider that will be used to lookup the EmitterFactory.
|
WEF11Outputter |
- directory
- The relative or absolute path of the directory for the file name.
- fileName
- The name of the file (may be a regular expression).
|
WSNotificationOutputter |
- resourceId
- This property is used to specify a unique identifier for a particular context of Generic Log Adapter.
The value will be added to the Topic in the WS-Notification as an id attribute. If this property is not used then the id attribute will be empty.
- endPointReference
- This property is used to specify the End Point Reference of the service to which events have to be sent.
This property must be specified if you want to send events to the desired service.
- callTimeOut
- This property is used to specify the timeout for a socket connection.
The recommended value is 10 for a local connection, and 100 for a remote connection.
You can find exceptions related to this socket connection in the hgla.log file.
|
Related concepts
Overview of Generic Log Adapter
Adapter configuration editor
Related tasks
Deploying the log parser plug-in project
Creating a log parser
Creating a rules-based adapter
Related reference
Adapter configuration file structure
Regular expression grammar
Common Base Event format specification
Best practices for Common Base Event and Common Event Infrastructure
(C) Copyright IBM Corporation 2000, 2006. All Rights Reserved.