Routing file entries
Each routing file contains entries that control the logging of events. Use the following format (entered on a single line without spaces) when defining entries in routing files:
component:subcomponent.level[[,subcomponent.level]...] :destination:location [[;destination:location]...] [;GOESTO:{other_severity | other_component}] Where:
- component:subcomponent [[,subcomponent ]...]
- Specifies the component, subcomponents, and reporting levels of events to log.
For the component portion, we can specify an asterisk (*) to log data for all components.
For the subcomponent portion, we can specify an asterisk (*) to log data for all subcomponents of the specified component.
- destination
- Where to log the events. For each destination, we must specify a location. When we specify multiple destination-location pairs, separate each pair with a semicolon (;). The following destinations are valid:
- DISCARD
- Discards the events.
- FILE
- Writes the events as ASCII text in the current code page and locale to the specified location.
When We use this destination on the appliance, do not include any path information.. Optionally, we can follow the FILE destination by a period and two numbers that are separated by a period (for example, FILE.10.100).
The first value indicates the number of files to use. The second value indicates the number of events each file can contain. If we do not specify these values, there is only 1 log file that grows without limit.
The average size of an ASCII event is 200 bytes. Because the maximum size of a log file is 2 GB, the maximum number of events must be limited to approximately 10,000,000 events.
- STDERR
- Writes the events as ASCII text in the current code page and locale to the standard error device.
- STDOUT
- Writes the events as ASCII text in the current code page and locale to the standard output device.
- TEXTFILE
- Same a FILE.
- UTF8FILE
- Writes the events as UTF-8 text to the specified location.
When We use this destination, do not include any path information. Optionally, we can follow the UTF8FILE destination by a period and two numbers that are separated by a period (for example, UTF8FILE.10.100).
The first value indicates the number of files to use. The second value indicates the number of events each file can contain. If we do not specify these values, there is only 1 log file that grows without limit.
The average size of a UTF-8 event is 200 bytes. Because the maximum size of a log file is 2 GB, the maximum number of events must be limited to approximately 10,000,000 events. When the operating system does not use a UTF-8 code page, the conversion to UTF-8 can result in data loss. When data loss occurs, the log file contains a series of question mark (?) characters at the location where the data conversion was problematic.
- XMLFILE
- Writes events to the specified location in the XML log format.
When We use this destination, do not include any path information. Optionally, we can follow the XMLFILE destination by a period and two numbers that are separated by a period (for example, XMLFILE.10.100). The first value indicates the number of files to use. The second value indicates the number of events each file can contain.
If you do not specify these values, there is only 1 log file that grows without limit.
The maximum size of a log file is 2 GB.
- XMLSTDERR
- Writes events to the standard error device in the XML log format.
- XMLSTDOUT
- Writes events to the standard output device in the XML log format.
- GOESTO:{other_severity | other_component}]
- Specifies that events must additionally be routed to the same destination and location as events of the specified component.
- location
- Name and location of the log file. When the destination is TEXT, TEXTFILE, UTF8FILE or XMLFILE, we must specify a location. When the destination is DISCARD, STDERR, STDOUT, XMLSTDERR, or XMLSTDOUT, we must specify a hyphen (-).
When we specify a fully qualified file name, we can use the %ld character string to insert the process ID into the file name. When the number of files is specified as part of the destination, a period and the file number are appended to the specified log file. On Windows operating systems, the file name must not end with a period. If the file name ends with a period, when the file number is appended, the file name contains two consecutive periods. File names with two consecutive periods are not valid. On AIX, Linux, and Solaris operating systems, the file name must be followed by:
- File permissions.
- The user who owns the file.
- The group that owns the file.
Use the following format:
location:permissions:owner:group
Parent topic: Routing files