Adapter configuration file extensions
The 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 Java 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
- 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.
- com.ibm.etools.logging.adapter.sensors.SNMPSensor: This sensor receives SNMP traps on a specified port and converts them to Common Base Event objects.
- 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.
Sensor type |
Properties |
SeibelSensor |
- 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.
|
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.
|
Outputters
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 the AME 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 the GLA. If a
registry is already available then this registry will be used by the GLA. The GLASubscriber web service and the log adapter should be configured to
use the same RMI registry.
|
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 JNDI provider that will be used to lookup the EmitterFactory.
|
CBENotifyOutputter |
resourceName
Name of the NotificationSink which will receive the events. (required)
Note:The object name of the Java RMI class implementing the com.ibm.autonomic.manager.NotificationSinkManagmentTopic
interface passed to Naming.rebind() should match the resourceName string used with the NotificationOutputter.
IBMGAOutputterCBENotifyOutputterElementName=NotificationOutputterType
|
TECOutputter |
- tecConfigFilePath
- Absolute path of TEC configuration file, used to connect to Tivoli Event Server
- tecUseConfigFilePathFlag
- Boolean flag used to identify whether or not a configuration file is specified.
The value is true if configuration file is specified, and false
if configuration file is not specified. In this case, the tecServerName and tecServerPort
are used to connect to Tivoli event server.
- tecServerName
- Name/IP of Tivoli event server.
- tecServerPort
- Port number on which tivoli event server is running.
|
Related concepts
Overview of the Hyades Generic Log Adapter
Common Base Event format specification
Related tasks
Configuring the plug-in manifest file
Creating a log parser
Creating a rules-based adapter
Related references
Adapter Configuration File structure
Adapter Configuration Editor
Regular expression grammar
(C) Copyright IBM Corporation 2000, 2005. All Rights Reserved.