[LOG4J2-1653] CronTriggeringPolicy uses wrong naming and produces NPE

• Type: Bug
• Status: Resolved
• Priority: Critical
• Resolution: Fixed
• Affects Version/s: 2.7
• Fix Version/s: 2.8
• Flags: Patch
• Assignee: Ralph Goers
• Reporter: Georg Friedrich
• Created: 28/Oct/16 13:38
• Updated: 09/Jan/17 10:07
• Resolved: 09/Jan/17 10:07

Description

After having worked on LOG4J2-1649 I found another serious issue in combination with the CronTriggeringPolicy.
The policy has some very weird behaviour when it comes to naming rolled over files and also creates a NPE on specific configurations.
The following is broken:

• when using "evaluateOnStartup" a NPE is the result of an immediate rollover
• when no rollover is happing at startup the first rollover produces a file that uses the time of the rollover (e.g. rollover is happening at midnight 2010-05-05 producing a rolled over file named log-2010-05-05)
• but it becomes worse: all files after the first rollover are named using a date of the "previous rollover date minus a second" - when using the previous example this results in:
  • first rollover happening at midnight 2010-05-05, resulting in file log-2010-05-05
  • next rollover happening at 2010-05-06, resulting in file log-2010-05-04
  • next rollover happening at 2010-05-07, resulting in file log-2010-05-05 again so the previously saved file gets removed!

I would expect the file to be named after the content it contains. E.g. a file rolled over at 2010-05-05 should be named log-2010-05-04 as it contains all the data of the 2010-05-04.

So I decided to write a patch for those problems too (again the sources of Log4J2 2.7 were used). Unfortunately I needed a method to calculate the last cron date. The CronExpression class has such a method ("getTimeBefore") but nobody implemented this one since years.
The only quick solution I found: I used another 3rd party library to fix this called cronutils. The solution I wrote uses the latest version of this library which now only supports Java 8.
My guess is that you don't want Log4J2 to only support Java 8 - if this is the case you will have to use a different library/version or whatever to be able to calculate the last cron date.

This patch should also fix the following bugs: LOG4J2-1640, LOG4J2-1621, LOG4J2-1487, LOG4J2-1474 (and maybe even more - I didn't feel like searching the whole Jira )

Issue Links

• contains: LOG4J2-1474 CronTriggeringPolicy raise exception and fail to rollover log file when evaluateOnStartup is true.
• contains: LOG4J2-1487 Log4j RollingFileAppender every minute
• contains: LOG4J2-1621 RollingFileAppender can't generate daily file according to cron expressions
• contains: LOG4J2-1640 RollingFileAppender with CronTriggeringPolicy broken?
• relates to: LOG4J2-1649 CronTriggeringPolicy breaks awefully when using "reconfigure" of LoggerContext
• relates to: LOG4J2-1474 CronTriggeringPolicy raise exception and fail to rollover log file when evaluateOnStartup is true.
• relates to: LOG4J2-1487 Log4j RollingFileAppender every minute
• relates to: LOG4J2-1640 RollingFileAppender with CronTriggeringPolicy broken?