The file eif.conf is a configuration
file for the TEC Adapter used by the scala_custom_eif plugin to send
log records as events to the IBM® Operations Analytics - Log Analysis EIF
Receiver.
The file eif.conf is found in the logstash/outputs directory
relative to where the logstash Integration
Toolkit was installed on the logstash server.
The logstash Integration
Toolkit installation configures eif.conf during
installation with the server location, server port, cache file location,
and the log file. You can modify any other properties to customize
your installation. You must restart the logstash agent
in order effect changes to this configuration file.
Note: Please
refer to the comments in the eif.conf file for
the latest details on the available parameters and their descriptions.
eif.conf file parameters
- BufEvtMaxSize=<kilobytes>
- Specifies the maximum size, in kilobytes, of the adapter cache
file. The default value is 64. The cache file stores events on disk
when the BufferEvents keyword is set to YES. The minimum size for
the file is 8 KB. File sizes specified below this level are ignored,
and 8 KB is used. There is no upper limit for the file size.
Note: If
the cache file already exists, you must delete the file for parameter
changes to take effect.
The BufEvtMaxSize parameter is optional.
- BufEvtPath=<pathname>
- Specifies the full path name of the adapter cache file. This is
a required parameter when the BufferEvents value is set to YES.
- BufferEvents=YES | MEMORY_ONLY | NO
- Specifies how event buffering is enabled.
- YES - Stores events in the file specified
by the BufEvtPath keyword.
- MEMORY_ONLY - Buffers events in memory.
- NO - Does not store or buffer events.
The value is not case-sensitive. The default value is YES.
This parameter is optional.
- ConnectionMode=connection_oriented | connection_less
- Specifies the connection mode to use to connect to the IBM Operations Analytics - Log Analysis EIF
Receiver. The default value is connection_less.
- connection_oriented - A connection is established
at adapter initialization and is maintained for all events sent. A
new connection is established only if the initial connection is lost.
The connection is discarded when the adapter is stopped. This option
can be abbreviated to co or CO.
- connection_less - A new connection is established
and discarded for each event or group of events that is sent.
This parameter is optional.
- LogFileName=<pathname>
- Specifies the full path name of the log file for the adapter.
- LogLevel=<level>
- Specifies whether the Java API generates log messages or not.
By default, no messages are generated. Specify ALL to generate messages.
If you specify any other value or no value, the API does not generate
messages. This parameter is optional.
- ServerLocation=<host>
Specifies the name of the host where the IBM Operations Analytics - Log Analysis EIF
Receiver resides.
ServerPort=number Specifies
the port number on which the IBM Operations Analytics - Log Analysis EIF
Receiver listens for events.
- FQDomain=YES | NO | <fully.qualified.domain.suffix>
- Specifies the fqhostname slot.
- YES - The adapter will attempt to determine
the fully qualified hostname and if successful will fill in the fqhostname
slot in the event.
- NO - The fqhostname slot will be set to a
null string.
- <fully.qualified.domain.suffix> - The
adapter will append this value to the hostname in order to set the
fqhostname slot.