Logs.xml
This file specifies the schema for the log properties used to configure the Diffusion default logging back-end. If you use a different logging back-end, this file is ignored.
logs
Properties defining logging options.
The following table lists the elements that an element of type logs can contain:
| Name | Type | Description | Min occurs | Max occurs |
|---|---|---|---|---|
| console-log-level | push:log-level | The log level to start console logging at. Can be ERROR, WARN, INFO, DEBUG, or TRACE. If a value is not specified, a default of INFO is used. DEPRECATED: Since 6.4.0 - This setting is used to configure the Diffusion log implementation, which is deprecated in favor of Log4j 2. The Diffusion log implementation will be removed in a future release, together with this configuration setting. Use Log4j 2 instead. | 0 | 1 |
| server-log | push:string | The log to use for the server. This must specify the name of a configured log definition. DEPRECATED: Since 6.4.0 - This setting is used to configure the Diffusion log implementation, which is deprecated in favor of Log4j 2. The Diffusion log implementation will be removed in a future release, together with this configuration setting. Use Log4j 2 instead. | 1 | 1 |
| default-log-directory | push:string | The default log folder for all logs, although this can be overridden for each log. The directory is also used for the daily ConnectionCount statistics file. If not set, the default path is "logs". If the path is relative, it is evaluated relative to the Diffusion installation directory. | 1 | 1 |
| console-monitored-log | push:string | Specifies the log file made available to the Diffusion management console. If not set, the default path is 'Server.log'. If the path is relative, it is evaluated relative to the default log directory. | 0 | 1 |
| async-logging | push:boolean | Indicates whether logging is asynchronous. Asynchronous logging is performed by a separate thread as opposed to being performed in-line by the logging thread. This is normally set to true for performance reasons, but asynchronous logging might cause problems in some OS environments. This element provides the option to turn asynchronous logging off, if so advised. If a value is not specified, a default of true is used. DEPRECATED: Since 6.4.0 - This setting is used to configure the Diffusion log implementation, which is deprecated in favor of Log4j 2. The Diffusion log implementation will be removed in a future release, together with this configuration setting. Use Log4j 2 instead. | 0 | 1 |
| logging-queue-size | push:positiveInt | The size of the asynchronous logging queue. In normal cases, leave this value at the default value of 128k entries. DEPRECATED: Since 6.4.0 - This setting is used to configure the Diffusion log implementation, which is deprecated in favor of Log4j 2. The Diffusion log implementation will be removed in a future release, together with this configuration setting. Use Log4j 2 instead. | 0 | 1 |
| thread-name-logging | push:boolean | Indicates whether the thread name is logged with messages. If this is not specified, thread names are logged. DEPRECATED: Since 6.4.0 - This setting is used to configure the Diffusion log implementation, which is deprecated in favor of Log4j 2. The Diffusion log implementation will be removed in a future release, together with this configuration setting. Use Log4j 2 instead. | 0 | 1 |
| log | log | A log definition. DEPRECATED: Since 6.4.0 - This setting is used to configure the Diffusion log implementation, which is deprecated in favor of Log4j 2. The Diffusion log implementation will be removed in a future release, together with this configuration setting. Use Log4j 2 instead. | 0 | unbounded |
log
A log definition. DEPRECATED: Since 6.4.0 - This setting is used to configure the Diffusion log implementation, which is deprecated in favor of Log4j 2. The Diffusion log implementation will be removed in a future release, together with these configuration settings. Use Log4j 2 instead.
The following table lists the attributes that an element of type log can have:
| Name | Type | Description | Required |
|---|---|---|---|
| name | Name of the log definition | true | |
| rotation-period | push:positiveNonZeroInt | A time period that the log exists for before being rotated. This is a positive non-zero integer, with unit specified by rotation-unit. If a rotation-period is specified, the value of file-append must be false. | false |
| rotation-unit | push:timeunit | A time unit to specify the unit used alongside rotation-period. This can be "day(s)", "hour(s)", "minute(s)". | false |
The following table lists the elements that an element of type log can contain:
| Name | Type | Description | Min occurs | Max occurs |
|---|---|---|---|---|
| log-directory | push:string | The name of the directory to which this log file is written. If a value is not specified, the default-log-directory is used. | 0 | 1 |
| file-pattern | push:string | This is used to specify the name of the log file. The following values can be used within the pattern. "/" - the local pathname separator. "%t" - the system temporary directory. "%g" - the generation number to distinguish rotated logs. "%h" - the value of the "user.home" system property. "%s" - the system type - for example, 'Diffusion'. "%n" - the system name as defined in Server.xml. "%d" - the date as specified in diffusion.properties (date.format), this is included when using daily rotation. "%%" - translates to a single percent sign "%". If a log file name is not specified, a default of "%s.log" is used. | 0 | 1 |
| level | push:log-level | Specifies the starting log level. This can be ERROR, WARN, INFO, DEBUG, or TRACE. If a value is not specified, a default of INFO is used. | 0 | 1 |
| xml-format | push:boolean | Indicates whether the log file is output in XML format. If a value is not specified, a default of false is used. | 0 | 1 |
| date-format | push:string | Specifies a date format to name a log. Specify the format according to the Java SimpleDateFormat specification. If a format is not specified, a default of "yyyy-MM-dd" is used. | 0 | 1 |
| file-limit | push:bytes | Specifies an approximate maximum amount to write (in bytes) to any one log file. If this is zero, there is no limit. If a value is not specified, a default of 0 is used. | 0 | 1 |
| file-append | push:boolean | Specifies whether log records are appended to existing log files. If a rotation-period is specified, the value of file-append must be false. If a value is not specified, a default of false is used and log files are overwritten. | 0 | 1 |
| file-count | push:positiveNonZeroInt | Specifies the number of log files to use. Must be at least 1. If a value is not specified, a default of 1 is used. | 0 | 1 |