Parameter types for Event Adapters

Global

Global parameters influence the global Perl process and must be defined in the default section of the configuration file. An example of a global parameter is ReadPerEngine.

Common

Common parameters are common to all adapters, but unlike global parameters, common parameters can be different for different adapter instances. An example of a common parameter is MapFile.

These parameters are defined in the default section of the mcxa.conf file, in the specific adapter sections, or both. If a common parameter is defined in the default section, it applies to all adapters unless it is also defined in a specific adapter section. If it is defined in a specific section, it applies only to that adapter.

Specific

Specific parameters apply only to one specific type of adapter. They are generally defined in specific adapter sections; however, by using the Engine parameter, you can define default specific parameters, in the default section of the mcxa.conf file, that apply to all relevant specific adapters.

Used only if ReadsPerEngine = 1; defines the maximum number of events each adapter generates per poll cycle.

If ReadsPerEngine = 1, records are read until the number of events created equals the value of the EventsPerPoll parameter. Otherwise, the maximum reads per engine per poll cycle is set by the value of the ReadsPerEngine parameter.

Maximum number of renamed trace files that are kept in the trace file directory 

When the number of files exceeds the specified limit, the oldest trace file is deleted. 

To expand the amount of saved trace information, increase the value of one of the following parameters:

• TraceSizeMax (default = 1,000,000)
• TraceFileCount (default = 10)

Valid values are as follows:

• 0 - Disables all traces
• 1 - Header messages
• 2 - Fatal messages
• 3 - Major errors
• 4 - Minor errors
• 5 - Normal output
• 6 - Verbose output

Maximum trace file size 

When the adapter detects that the maximum size is reached, the trace file is closed and renamed mcxa0.trace.

Name of the adapter 

This parameter is required. Default values are as follows:

• Engine = MA::ELogfile for any log file management, including UNIX syslog
• Engine = MA::ESnmpTrap for SNMP trap management
• Engine = MA::EEventLog for Perl EventLog for Windows management

The IP Adapter definitions vary slightly, with the inclusion of Adapter:: in the path:

• Engine = MA::Adapter::TcpClient
• Engine = MA::Adapter::TcpServer
• Engine = MA::Adapter::Telnet
• Engine = MA::Adapter::UdpClient
• Engine = MA::Adapter::UdpServer

Indicates whether incoming events that do not match a CLASS described in the map file are mapped to the DEFAULT class 

Valid values:

• 0 - Events are dropped. (This is the default.)
• 1 - Events are mapped to the DEFAULT class.

Name of the cell to which events processed by the adapter are sent 

The cell parameters can be found in installationDirectory\pw\server\etc\mcell.dir. 
ServerName can contain the names of several cells, separated by colons, such as Cell1:Cell2:Cell3:.... Events are sent to these cells according to their numerical order. For more information, see mposter and msend.

If ServerName is not defined, events are formatted in BAROC and sent to the standard output.

A regular expression, often a character such as " , ", that delimits the attributes of an event when LogRegExpr is empty

Number of events after which the log position is saved to disk 

The position file is flushed after the number of incoming log entries reaches the number specified with LogFlushPosPeriod.

Indicates whether to keep or drop empty events or events only constituted by blanks 

Valid values:

• 0 - Drop events.
• 1 - Keep events.

Maximum number of log files when log rotation is enabled 

For example, if LogMaxCount=5, <logfile>0--4 are saved. <logfile>i is always newer than <logfile>i+1. If LogMaxCount=-1, all log files are kept.

Indicates whether the whole log file is read the first time the adapter starts 

Valid values:

• 0 - Is not read
• 1 - Is read

Regular expression, often a simple character or string, that delimits two events.

Indicates whether the adapter persistently remembers the position of the last log entry 

Valid values:

• 0 - Does not remember position
• 1 - Remembers position

Indicates whether the part of the log file that has not been consumed is considered as being appended to the beginning of the newer log file, when the log file is replaced 

Valid values:

• 0 - Not appended
• 1 - Appended

Starts and stops index extraction, mainly for performance purposes By default, the indexes, such as the suffixed dotted numbers of the object identifiers (OIDs), are extracted and stored in the special $idxinput variable. $idx is a reference on a list of lists. 

Valid values:

• 0 - Starts
• 1 - Stops