icm/TCP/logging : Configuration for TCP Logging in ICM

Short text

Configuration for TCP Logging in ICM

Parameter Description

This parameter activates TCP logging. Various different network events are logged — for example, connecting to or accepting TCP connections, or receiving and transmitting messages. The default value is empty, which means that TCP Logging is deactivated.

The parameter has the following syntax:

icm/TCP/logging = [LOGFILE=<log file name>] [,LEVEL=<log level>] [, MAXSIZEKB=<size in KBytes>] [, MAXFILES=<maximum number of logfiles>] [, FLUSH=ON|OFF] [, APPEND=TRUE|FALSE] [, SWITCHTF=<options>] [, MAXPAYLOAD=<max payload in bytes>].

TCP logging is activated whenever at least one subparameter is set (for example, icm/TCP/logging = LEVEL=4; all other subparameters that are not set have their respective default values).

The following subparameters are permitted:

LOGFILE:

Name of the output file in the file system. The default value is “tcp_log_”. You have the following options for specifying the log file:

%d Day of the month (1-31)
%m Month of the year (1-12)
%y Year, in four-digit format YYYY
%h Hour (0-23)
%t Minute (0-59)
%s Seconds (0-59)

LEVEL:

Log level for the entries. Possible values are [0..4]. The default value is 3.

Level 0: No entries are written; TCP Logging is deactivated.
Level 1: Only events with errors
Level 2: Connecting to or accepting TCP connections; events with errors
Level 3: All events, including TCP messages. Only the first defined characters of the processed data in MAXPAYLOAD are written.
Level 4: All events including TCP messages. Processed data is written in full length, up to a maximum of the length of the first data block (64 KB).

MAXSIZEKB

Maximum size of the log file in kilobytes. If this size is exceeded, the current file is closed and a new one (with a new name) is opened. The default value is 10000.

MAXFILES:

MAXFILES specifies how many files to keep. MAXFILES=1 means that only the current file is kept. A higher value for MAXFILES means that more files can be kept. The special value MAXFILES=0 means that there is no upper limit for the number of files to keep. That is, all files are kept.

The default value is 5.

FLUSH:

Using FLUSH you can define whether TCP log entries are written directly into the file system. This setting can have a negative effect on performance. The default value is OFF.

APPEND:

Using APPEND you can determine whether a log file that already exists should be used further. The default value is TRUE.

SWITCHTF:

A new log file can be created not only if the file reaches a certain size, but also when the time data changes. Possible values are {day, hour, month, none}. The default value is empty.