gging.log4j.log4j-core.2.23.0.source-code.Log4j-config.xsd Maven / Gradle / Ivy
The Advertiser plugin name which will be used to advertise individual FileAppender or SocketAppender configurations. The only
Advertiser plugin provided is 'multicastdns".
Either "err" for stderr, "out" for stdout, a file path, or a URL.
The minimum amount of time, in seconds, that must elapse before the file configuration is checked for changes.
The name of the configuration.
A comma separated list of package names to search for plugins. Plugins are only loaded once per classloader so changing this value
may not have any effect upon reconfiguration.
Identifies the location for the classloader to located the XML Schema to use to validate the configuration. Only valid when strict
is set to true. If not set no schema validation will take place.
Specifies whether or not Log4j should automatically shutdown when the JVM shuts down. The shutdown hook is enabled by default but
may be disabled by setting this attribute to "disable".
Specifies how many milliseconds appenders and background tasks will get to shutdown when the JVM shuts down. Default is zero which
mean that each appender uses its default timeout, and don't wait for background tasks.
The level of internal Log4j events that should be logged to the console. Valid values for this attribute are "trace", "debug",
"info", "warn", "error" and "fatal".
Enables the use of the strict XML format. Not supported in JSON configurations.
Action to take when the filter matches. May be ACCEPT, DENY or NEUTRAL.
Action to take when the filter does not match. May be ACCEPT, DENY or NEUTRAL.
One or more KeyValuePair elements that define the matching value for the key and the Level to evaluate when the key matches.
The average number of events per second to allow.
The maximum number of events that can occur before events are filtered for exceeding the average rate. The default is 10 times
the rate.
Level of messages to be filtered. Anything at or below this level will be filtered out if maxBurst has been exceeded. The
default is WARN meaning any messages that are higher than warn will be logged regardless of the size of a burst.
The filter type, see https://logging.apache.org/log4j/2.x/manual/filters.html
The name of the item in the ThreadContext Map to compare.
Level of messages to be filtered. The default threshold only applies if the log event contains the specified ThreadContext Map
item and its value does not match any key in the key/value pairs.
The location of the configuration for the filter.
The frequency in seconds that the configuration file should be checked for modifications.
If the operator is "or" then a match by any one of the key/value pairs will be considered to be a match, otherwise all the
key/value pairs must match.
If the operator is "or" then a match by any one of the key/value pairs will be considered to be a match, otherwise all the
key/value pairs must match.
The regular expression.
If true the unformatted message will be used, otherwise the formatted message will be used.
If the operator is "or" then a match by any one of the key/value pairs will be considered to be a match, otherwise all the
key/value pairs must match.
A valid Level name to match on.
If true exceptions are always written even if the pattern contains no exception conversions.
The character set to use when converting the syslog String to a byte array.
If true, do not output ANSI escape codes.
Footer string to include at the bottom of each log file.
Header string to include at the top of each log file.
If true and System.console() is null, do not output ANSI escape codes.
One or more KeyValuePair elements that define custom field in the output.
One or more KeyValuePair elements that define custom field in the output.
The name of the appender.
The default is true, causing exceptions encountered while appending events to be internally logged and then ignored.
When set to false
exceptions will be propagated to the caller, instead.
You must set this to false when wrapping this Appender in a FailoverAppender.
Write directly to java.io.FileDescriptor and bypass java.lang.System.out/.err. Can give up to 10x performance boost when the
output is redirected to file or other process. Cannot be used with Jansi on Windows. Cannot be used with follow.
Identifies whether the appender honors reassignments of System.out or System.err via System.setOut or System.setErr made after
configuration. Note that the follow attribute cannot be used with Jansi on Windows. Cannot be used with direct.
Default is SYSTEM_OUT.
One or more KeyValuePair elements that define the matching value for the key and the Level to evaluate when the
key
matches.
When true, records will be appended to the end of the file.
When set to false, the file will be cleared before new records are
written.
The name of the file to write to. If the file, or any of its parent directories, do not exist, they will be created.
When set to true, each write will be followed by a flush.
This will guarantee that the data is passed to the operating system for writing;
it does not guarantee that the data is actually written to a physical device
such as a disk drive.
When true, records will be written to a buffer and the data will be written to disk when the buffer is full or, if
immediateFlush is set, when the record is written.
File locking cannot be used with bufferedIO.
When bufferedIO is true, this is the buffer size, the default is 8192 bytes.
The appender creates the file on-demand. The appender only creates the file when a log event passes all filters and is routed
to this appender.
File attribute permissions in POSIX format to apply whenever the file is created.
Underlying files system shall support POSIX
file attribute view.
File owner to define whenever the file is created.
Underlying files system shall support POSIX file attribute view.
File group to define whenever the file is created.
Underlying files system shall support POSIX file attribute view.
The length of the mapped region, defaults to 32 MB (32 * 1024 * 1024 bytes). This parameter must be a value between 256 and
1,073,741,824 (1 GB or 2^30); values outside this range will be adjusted to the closest valid value. Log4j will round the specified value
up to the nearest power of two.
The pattern of the file name of the archived log file.
The format of the pattern is dependent on the RolloverPolicy that is
used.
The cron expression. The expression is the same as what is allowed in the Quartz scheduler.
On startup the cron expression will be evaluated against the file's last modification timestamp. If the cron expression indicates a
rollover should have occurred between that time and the current time the file will be immediately rolled over.
The minimum size the file must have to roll over. A size of zero will cause a roll over no matter what the file size is. The default
value is 1, which will prevent rolling over an empty file.
The size can be specified in bytes, with the suffix KB, MB or GB, for example 20MB.
How often a rollover should occur based on the most specific time unit in the date pattern.
Indicates whether the interval should be adjusted to cause the next rollover to occur on the interval boundary.
Indicates the maximum number of seconds to randomly delay a rollover. By default, this is 0 which indicates no delay.
Sets the compression level, 0-9, where 0 = none, 1 = best speed, through 9 = best compression. Only implemented for ZIP files.
If set to "max", files with a higher index will be newer than files with a smaller index.
If set to "min", file renaming and the
counter will follow the Fixed Window strategy described above.
The maximum value of the counter. Once this values is reached older archives will be deleted on subsequent rollovers.
The minimum value of the counter.
The pattern of the file name of the archived log file during compression.
Sets the compression level, 0-9, where 0 = none, 1 = best speed, through 9 = best compression. Only implemented for ZIP files.
The maximum number of files to allow in the time period matching the file pattern. If the number of files is exceeded the oldest file
will be deleted. If specified, the value must be greater than 1. If the value is less than zero or omitted then the number of files will not be
limited.
The pattern of the file name of the archived log file during compression.
Defines whether to stop executing asynchronous actions if an error occurs.
Allow boolean values or variable place holders in the form of ${variablename}
Allow long values or variable place holders in the form of ${variablename}