Class DefaultRolloverStrategy
- All Implemented Interfaces:
RolloverStrategy
DefaultRolloverStrategy
renames files according to an algorithm as described below.
The DefaultRolloverStrategy is a combination of a time-based policy and a fixed-window policy. When the file name pattern contains a date format then the rollover time interval will be used to calculate the time to use in the file pattern. When the file pattern contains an integer replacement token one of the counting techniques will be used.
When the ascending attribute is set to true (the default) then the counter will be incremented and the current log file will be renamed to include the counter value. If the counter hits the maximum value then the oldest file, which will have the smallest counter, will be deleted, all other files will be renamed to have their counter decremented and then the current file will be renamed to have the maximum counter value. Note that with this counting strategy specifying a large maximum value may entirely avoid renaming files.
When the ascending attribute is false, then the "normal" fixed-window strategy will be used.
Let max and min represent the values of respectively the MaxIndex and MinIndex
options. Let "foo.log" be the value of the ActiveFile option and "foo.%i.log" the value of
FileNamePattern. Then, when rolling over, the file foo.max.log
will be deleted, the file
foo.max-1.log
will be renamed as foo.max.log
, the file
foo.max-2.log
renamed as foo.max-1.log
, and so on, the file
foo.min+1.log
renamed as foo.min+2.log
. Lastly, the active file
foo.log
will be renamed as foo.min.log
and a new active file name
foo.log
will be created.
Given that this rollover algorithm requires as many file renaming operations as the window size, large window sizes are discouraged.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Builds DefaultRolloverStrategy instances. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final int
private static final int
private final int
Index for oldest retained log file.private static final int
private final int
Index for most recent log file.private final boolean
private final PatternProcessor
private final boolean
Fields inherited from class org.apache.logging.log4j.core.appender.rolling.AbstractRolloverStrategy
LOGGER, PATTERN_COUNTER, strSubstitutor
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
DefaultRolloverStrategy
(int minIndex, int maxIndex, boolean useMax, int compressionLevel, StrSubstitutor strSubstitutor, Action[] customActions, boolean stopCustomActionsOnError) Deprecated.Since 2.9 Added tempCompressedFilePatternString parameterprotected
DefaultRolloverStrategy
(int minIndex, int maxIndex, boolean useMax, int compressionLevel, StrSubstitutor strSubstitutor, Action[] customActions, boolean stopCustomActionsOnError, String tempCompressedFilePatternString) Constructs a new instance. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultRolloverStrategy
createStrategy
(String max, String min, String fileIndex, String compressionLevelStr, Action[] customActions, boolean stopCustomActionsOnError, Configuration config) Deprecated.Since 2.9 Usage of Builder API is preferableint
int
int
boolean
boolean
isUseMax()
private int
purge
(int lowIndex, int highIndex, RollingFileManager manager) private int
purgeAscending
(int lowIndex, int highIndex, RollingFileManager manager) Purges and renames old log files in preparation for rollover.private int
purgeDescending
(int lowIndex, int highIndex, RollingFileManager manager) Purges and renames old log files in preparation for rollover.rollover
(RollingFileManager manager) Performs the rollover.toString()
Methods inherited from class org.apache.logging.log4j.core.appender.rolling.AbstractRolloverStrategy
getEligibleFiles, getEligibleFiles, getEligibleFiles, getEligibleFiles, getEligibleFiles, getStrSubstitutor, merge, suffixLength
-
Field Details
-
MIN_WINDOW_SIZE
private static final int MIN_WINDOW_SIZE- See Also:
-
DEFAULT_WINDOW_SIZE
private static final int DEFAULT_WINDOW_SIZE- See Also:
-
maxIndex
private final int maxIndexIndex for oldest retained log file. -
minIndex
private final int minIndexIndex for most recent log file. -
useMax
private final boolean useMax -
compressionLevel
private final int compressionLevel -
customActions
-
stopCustomActionsOnError
private final boolean stopCustomActionsOnError -
tempCompressedFilePattern
-
-
Constructor Details
-
DefaultRolloverStrategy
@Deprecated protected DefaultRolloverStrategy(int minIndex, int maxIndex, boolean useMax, int compressionLevel, StrSubstitutor strSubstitutor, Action[] customActions, boolean stopCustomActionsOnError) Deprecated.Since 2.9 Added tempCompressedFilePatternString parameterConstructs a new instance.- Parameters:
minIndex
- The minimum index.maxIndex
- The maximum index.customActions
- custom actions to perform asynchronously after rolloverstopCustomActionsOnError
- whether to stop executing asynchronous actions if an error occurs
-
DefaultRolloverStrategy
protected DefaultRolloverStrategy(int minIndex, int maxIndex, boolean useMax, int compressionLevel, StrSubstitutor strSubstitutor, Action[] customActions, boolean stopCustomActionsOnError, String tempCompressedFilePatternString) Constructs a new instance.- Parameters:
minIndex
- The minimum index.maxIndex
- The maximum index.customActions
- custom actions to perform asynchronously after rolloverstopCustomActionsOnError
- whether to stop executing asynchronous actions if an error occurstempCompressedFilePatternString
- File pattern of the working file used during compression, if null no temporary file are used
-
-
Method Details
-
newBuilder
-
createStrategy
@PluginFactory @Deprecated public static DefaultRolloverStrategy createStrategy(@PluginAttribute("max") String max, @PluginAttribute("min") String min, @PluginAttribute("fileIndex") String fileIndex, @PluginAttribute("compressionLevel") String compressionLevelStr, @PluginElement("Actions") Action[] customActions, @PluginAttribute(value="stopCustomActionsOnError",defaultBoolean=true) boolean stopCustomActionsOnError, @PluginConfiguration Configuration config) Deprecated.Since 2.9 Usage of Builder API is preferableCreates the DefaultRolloverStrategy.- Parameters:
max
- The maximum number of files to keep.min
- The minimum number of files to keep.fileIndex
- If set to "max" (the default), 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.compressionLevelStr
- The compression level, 0 (less) through 9 (more); applies only to ZIP files.customActions
- custom actions to perform asynchronously after rolloverstopCustomActionsOnError
- whether to stop executing asynchronous actions if an error occursconfig
- The Configuration.- Returns:
- A DefaultRolloverStrategy.
-
getCompressionLevel
public int getCompressionLevel() -
getCustomActions
-
getMaxIndex
public int getMaxIndex() -
getMinIndex
public int getMinIndex() -
isStopCustomActionsOnError
public boolean isStopCustomActionsOnError() -
isUseMax
public boolean isUseMax() -
getTempCompressedFilePattern
-
purge
-
purgeAscending
Purges and renames old log files in preparation for rollover. The oldest file will have the smallest index, the newest the highest.- Parameters:
lowIndex
- low index. Log file associated with low index will be deleted if needed.highIndex
- high index.manager
- The RollingFileManager- Returns:
- true if purge was successful and rollover should be attempted.
-
purgeDescending
Purges and renames old log files in preparation for rollover. The newest file will have the smallest index, the oldest will have the highest.- Parameters:
lowIndex
- low indexhighIndex
- high index. Log file associated with high index will be deleted if needed.manager
- The RollingFileManager- Returns:
- true if purge was successful and rollover should be attempted.
-
rollover
Performs the rollover.- Parameters:
manager
- The RollingFileManager name for current active log file.- Returns:
- A RolloverDescription.
- Throws:
SecurityException
- if an error occurs.
-
toString
-