[JENKINS-28288] Audit Trail Plugin log file rotation issue

Type: Bug
Resolution: Fixed
Priority: Major
Component/s: audit-trail-plugin
Labels:
- logging
Environment:
Jenkins 1.611 running on RHEL 6.6 using audit-trail plugin 2.1

Similar Issues:
Powered by SuggestiMate

Show

There is a log rotation issue with the Log File logger in the audit-trail plugin.

I set the count parameter to 1 and the limit to 512. Yet the log file is still being rotated every time more than two lines are written:

[jenkins ~]$ cat /data/jenkins/audit-trail.xml 
<?xml version='1.0' encoding='UTF-8'?>
<hudson.plugins.audit__trail.AuditTrailPlugin plugin="audit-trail@2.1">
  <pattern>.*/(?:configSubmit|doDelete|postBuildResult|cancelQueue|stop|toggleLogKeep|doWipeOutWorkspace|createItem|createView|toggleOffline)</pattern>
  <logBuildCause>true</logBuildCause>
  <loggers>
    <hudson.plugins.audit__trail.LogFileAuditLogger>
      <log>/data/jenkins/logs/audit-trail.log</log>
      <limit>512</limit>
      <count>1</count>
    </hudson.plugins.audit__trail.LogFileAuditLogger>
  </loggers>
</hudson.plugins.audit__trail.AuditTrailPlugin>

[jenkins ~]$ ls -altr /data/jenkins/logs/audit-trail.log*
-rw-r--r--. 1 jenkins jenkins   0 May  7 11:05 /data/jenkins/logs/audit-trail.log.lck
-rw-r--r--. 1 jenkins jenkins  97 May  7 11:06 /data/jenkins/logs/audit-trail.log
-rw-r--r--. 1 jenkins jenkins   0 May  7 11:06 /data/jenkins/logs/audit-trail.log.1.lck
-rw-r--r--. 1 jenkins jenkins  97 May  7 11:06 /data/jenkins/logs/audit-trail.log.1
-rw-r--r--. 1 jenkins jenkins   0 May  7 11:06 /data/jenkins/logs/audit-trail.log.2.lck
-rw-r--r--. 1 jenkins jenkins  97 May  7 11:06 /data/jenkins/logs/audit-trail.log.2
-rw-r--r--. 1 jenkins jenkins   0 May  7 11:07 /data/jenkins/logs/audit-trail.log.3.lck
-rw-r--r--. 1 jenkins jenkins  97 May  7 11:14 /data/jenkins/logs/audit-trail.log.3
-rw-r--r--. 1 jenkins jenkins   0 May  7 11:14 /data/jenkins/logs/audit-trail.log.4.lck
-rw-r--r--. 1 jenkins jenkins 115 May  7 11:15 /data/jenkins/logs/audit-trail.log.4
-rw-r--r--. 1 jenkins jenkins   0 May  7 11:15 /data/jenkins/logs/audit-trail.log.5.lck
-rw-r--r--. 1 jenkins jenkins 115 May  7 11:15 /data/jenkins/logs/audit-trail.log.5
-rw-r--r--. 1 jenkins jenkins   0 May  7 11:15 /data/jenkins/logs/audit-trail.log.6.lck
-rw-r--r--. 1 jenkins jenkins   0 May  7 11:15 /data/jenkins/logs/audit-trail.log.6

It appears the log rotation count is not working correctly.

duplicates

JENKINS-44129 Log file logger for Audit trail plugin leaks open file descriptors

Resolved

Mark Nejman created issue - 2015-05-07 15:27

Mark Nejman made changes - 2015-05-07 15:33

Description

Original: There are multiple issues with the Log File logger in the audit-trail plugin.

The first has to do with log file rotation. I set the count parameter to 1 and the limit to 5000000000. Yet the log file is still being rotated every time more than two lines are written:

{code}
[jenkins ~]$ cat /data/jenkins/audit-trail.xml
<?xml version='1.0' encoding='UTF-8'?>
<hudson.plugins.audit__trail.AuditTrailPlugin plugin="audit-trail@2.1">
  <pattern>.*/(?:configSubmit|doDelete|postBuildResult|cancelQueue|stop|toggleLogKeep|doWipeOutWorkspace|createItem|createView|toggleOffline)</pattern>
  <logBuildCause>true</logBuildCause>
  <loggers>
    <hudson.plugins.audit__trail.LogFileAuditLogger>
      <log>/data/jenkins/logs/audit-trail.log</log>
      <limit>500000000</limit>
      <count>1</count>
    </hudson.plugins.audit__trail.LogFileAuditLogger>
  </loggers>
</hudson.plugins.audit__trail.AuditTrailPlugin>

[jenkins ~]$ ls -altr /data/jenkins/logs/audit-trail.log*
-rw-r--r--. 1 jenkins jenkins 0 May 7 11:05 /data/jenkins/logs/audit-trail.log.lck
-rw-r--r--. 1 jenkins jenkins 97 May 7 11:06 /data/jenkins/logs/audit-trail.log
-rw-r--r--. 1 jenkins jenkins 0 May 7 11:06 /data/jenkins/logs/audit-trail.log.1.lck
-rw-r--r--. 1 jenkins jenkins 97 May 7 11:06 /data/jenkins/logs/audit-trail.log.1
-rw-r--r--. 1 jenkins jenkins 0 May 7 11:06 /data/jenkins/logs/audit-trail.log.2.lck
-rw-r--r--. 1 jenkins jenkins 97 May 7 11:06 /data/jenkins/logs/audit-trail.log.2
-rw-r--r--. 1 jenkins jenkins 0 May 7 11:07 /data/jenkins/logs/audit-trail.log.3.lck
-rw-r--r--. 1 jenkins jenkins 97 May 7 11:14 /data/jenkins/logs/audit-trail.log.3
-rw-r--r--. 1 jenkins jenkins 0 May 7 11:14 /data/jenkins/logs/audit-trail.log.4.lck
-rw-r--r--. 1 jenkins jenkins 115 May 7 11:15 /data/jenkins/logs/audit-trail.log.4
-rw-r--r--. 1 jenkins jenkins 0 May 7 11:15 /data/jenkins/logs/audit-trail.log.5.lck
-rw-r--r--. 1 jenkins jenkins 115 May 7 11:15 /data/jenkins/logs/audit-trail.log.5
-rw-r--r--. 1 jenkins jenkins 0 May 7 11:15 /data/jenkins/logs/audit-trail.log.6.lck
-rw-r--r--. 1 jenkins jenkins 0 May 7 11:15 /data/jenkins/logs/audit-trail.log.6
{code}

The next issue has to do with the limit parameter. In the Jenkins console configuration screen, it says says "Log File Size MB" whereas the JavaDoc for FileHandler says the limit parameter is "the maximum number of bytes to write to any one file". As mentioned above, I used a limit of 500000000 assuming it is actually using bytes. However since the rotation isn't working correctly, I have no way of verifying whether or not the plugin does a conversion from MB to bytes.

New: There are multiple issues with the Log File logger in the audit-trail plugin.

The first has to do with log file rotation. I set the count parameter to 1 and the limit to 500000000. Yet the log file is still being rotated every time more than two lines are written:

{code}
[jenkins ~]$ cat /data/jenkins/audit-trail.xml
<?xml version='1.0' encoding='UTF-8'?>
<hudson.plugins.audit__trail.AuditTrailPlugin plugin="audit-trail@2.1">
  <pattern>.*/(?:configSubmit|doDelete|postBuildResult|cancelQueue|stop|toggleLogKeep|doWipeOutWorkspace|createItem|createView|toggleOffline)</pattern>
  <logBuildCause>true</logBuildCause>
  <loggers>
    <hudson.plugins.audit__trail.LogFileAuditLogger>
      <log>/data/jenkins/logs/audit-trail.log</log>
      <limit>500000000</limit>
      <count>1</count>
    </hudson.plugins.audit__trail.LogFileAuditLogger>
  </loggers>
</hudson.plugins.audit__trail.AuditTrailPlugin>

[jenkins ~]$ ls -altr /data/jenkins/logs/audit-trail.log*
-rw-r--r--. 1 jenkins jenkins 0 May 7 11:05 /data/jenkins/logs/audit-trail.log.lck
-rw-r--r--. 1 jenkins jenkins 97 May 7 11:06 /data/jenkins/logs/audit-trail.log
-rw-r--r--. 1 jenkins jenkins 0 May 7 11:06 /data/jenkins/logs/audit-trail.log.1.lck
-rw-r--r--. 1 jenkins jenkins 97 May 7 11:06 /data/jenkins/logs/audit-trail.log.1
-rw-r--r--. 1 jenkins jenkins 0 May 7 11:06 /data/jenkins/logs/audit-trail.log.2.lck
-rw-r--r--. 1 jenkins jenkins 97 May 7 11:06 /data/jenkins/logs/audit-trail.log.2
-rw-r--r--. 1 jenkins jenkins 0 May 7 11:07 /data/jenkins/logs/audit-trail.log.3.lck
-rw-r--r--. 1 jenkins jenkins 97 May 7 11:14 /data/jenkins/logs/audit-trail.log.3
-rw-r--r--. 1 jenkins jenkins 0 May 7 11:14 /data/jenkins/logs/audit-trail.log.4.lck
-rw-r--r--. 1 jenkins jenkins 115 May 7 11:15 /data/jenkins/logs/audit-trail.log.4
-rw-r--r--. 1 jenkins jenkins 0 May 7 11:15 /data/jenkins/logs/audit-trail.log.5.lck
-rw-r--r--. 1 jenkins jenkins 115 May 7 11:15 /data/jenkins/logs/audit-trail.log.5
-rw-r--r--. 1 jenkins jenkins 0 May 7 11:15 /data/jenkins/logs/audit-trail.log.6.lck
-rw-r--r--. 1 jenkins jenkins 0 May 7 11:15 /data/jenkins/logs/audit-trail.log.6
{code}

The next issue has to do with the limit parameter. In the Jenkins console configuration screen, it says says "Log File Size MB" whereas the JavaDoc for FileHandler says the limit parameter is "the maximum number of bytes to write to any one file". As mentioned above, I used a limit of 500000000 assuming it is actually using bytes. However since the rotation isn't working correctly, I have no way of verifying whether or not the plugin does a conversion from MB to bytes.

I should note that I also did try limit values of 512 and 1024, but still am seeing the logs rotate after two lines are written.

Mark Nejman made changes - 2015-05-07 16:22

Description	Original: There are multiple issues with the Log File logger in the audit-trail plugin. The first has to do with log file rotation. I set the count parameter to 1 and the limit to 500000000. Yet the log file is still being rotated every time more than two lines are written: {code} [jenkins ~]$ cat /data/jenkins/audit-trail.xml <?xml version='1.0' encoding='UTF-8'?> <hudson.plugins.audit__trail.AuditTrailPlugin plugin="audit-trail@2.1"> <pattern>./(?:configSubmit\|doDelete\|postBuildResult\|cancelQueue\|stop\|toggleLogKeep\|doWipeOutWorkspace\|createItem\|createView\|toggleOffline)</pattern> <logBuildCause>true</logBuildCause> <loggers> <hudson.plugins.audit__trail.LogFileAuditLogger> <log>/data/jenkins/logs/audit-trail.log</log> <limit>500000000</limit> <count>1</count> </hudson.plugins.audit__trail.LogFileAuditLogger> </loggers> </hudson.plugins.audit__trail.AuditTrailPlugin> [jenkins ~]$ ls -altr /data/jenkins/logs/audit-trail.log -rw-r--r--. 1 jenkins jenkins 0 May 7 11:05 /data/jenkins/logs/audit-trail.log.lck -rw-r--r--. 1 jenkins jenkins 97 May 7 11:06 /data/jenkins/logs/audit-trail.log -rw-r--r--. 1 jenkins jenkins 0 May 7 11:06 /data/jenkins/logs/audit-trail.log.1.lck -rw-r--r--. 1 jenkins jenkins 97 May 7 11:06 /data/jenkins/logs/audit-trail.log.1 -rw-r--r--. 1 jenkins jenkins 0 May 7 11:06 /data/jenkins/logs/audit-trail.log.2.lck -rw-r--r--. 1 jenkins jenkins 97 May 7 11:06 /data/jenkins/logs/audit-trail.log.2 -rw-r--r--. 1 jenkins jenkins 0 May 7 11:07 /data/jenkins/logs/audit-trail.log.3.lck -rw-r--r--. 1 jenkins jenkins 97 May 7 11:14 /data/jenkins/logs/audit-trail.log.3 -rw-r--r--. 1 jenkins jenkins 0 May 7 11:14 /data/jenkins/logs/audit-trail.log.4.lck -rw-r--r--. 1 jenkins jenkins 115 May 7 11:15 /data/jenkins/logs/audit-trail.log.4 -rw-r--r--. 1 jenkins jenkins 0 May 7 11:15 /data/jenkins/logs/audit-trail.log.5.lck -rw-r--r--. 1 jenkins jenkins 115 May 7 11:15 /data/jenkins/logs/audit-trail.log.5 -rw-r--r--. 1 jenkins jenkins 0 May 7 11:15 /data/jenkins/logs/audit-trail.log.6.lck -rw-r--r--. 1 jenkins jenkins 0 May 7 11:15 /data/jenkins/logs/audit-trail.log.6 {code} The next issue has to do with the limit parameter. In the Jenkins console configuration screen, it says says "Log File Size MB" whereas the JavaDoc for FileHandler says the limit parameter is "the maximum number of bytes to write to any one file". As mentioned above, I used a limit of 500000000 assuming it is actually using bytes. However since the rotation isn't working correctly, I have no way of verifying whether or not the plugin does a conversion from MB to bytes. I should note that I also did try limit values of 512 and 1024, but still am seeing the logs rotate after two lines are written.	New: There is a log rotation issue with the Log File logger in the audit-trail plugin. I set the count parameter to 1 and the limit to 512. Yet the log file is still being rotated every time more than two lines are written: {code} [jenkins ~]$ cat /data/jenkins/audit-trail.xml <?xml version='1.0' encoding='UTF-8'?> <hudson.plugins.audit__trail.AuditTrailPlugin plugin="audit-trail@2.1"> <pattern>./(?:configSubmit\|doDelete\|postBuildResult\|cancelQueue\|stop\|toggleLogKeep\|doWipeOutWorkspace\|createItem\|createView\|toggleOffline)</pattern> <logBuildCause>true</logBuildCause> <loggers> <hudson.plugins.audit__trail.LogFileAuditLogger> <log>/data/jenkins/logs/audit-trail.log</log> <limit>512</limit> <count>1</count> </hudson.plugins.audit__trail.LogFileAuditLogger> </loggers> </hudson.plugins.audit__trail.AuditTrailPlugin> [jenkins ~]$ ls -altr /data/jenkins/logs/audit-trail.log -rw-r--r--. 1 jenkins jenkins 0 May 7 11:05 /data/jenkins/logs/audit-trail.log.lck -rw-r--r--. 1 jenkins jenkins 97 May 7 11:06 /data/jenkins/logs/audit-trail.log -rw-r--r--. 1 jenkins jenkins 0 May 7 11:06 /data/jenkins/logs/audit-trail.log.1.lck -rw-r--r--. 1 jenkins jenkins 97 May 7 11:06 /data/jenkins/logs/audit-trail.log.1 -rw-r--r--. 1 jenkins jenkins 0 May 7 11:06 /data/jenkins/logs/audit-trail.log.2.lck -rw-r--r--. 1 jenkins jenkins 97 May 7 11:06 /data/jenkins/logs/audit-trail.log.2 -rw-r--r--. 1 jenkins jenkins 0 May 7 11:07 /data/jenkins/logs/audit-trail.log.3.lck -rw-r--r--. 1 jenkins jenkins 97 May 7 11:14 /data/jenkins/logs/audit-trail.log.3 -rw-r--r--. 1 jenkins jenkins 0 May 7 11:14 /data/jenkins/logs/audit-trail.log.4.lck -rw-r--r--. 1 jenkins jenkins 115 May 7 11:15 /data/jenkins/logs/audit-trail.log.4 -rw-r--r--. 1 jenkins jenkins 0 May 7 11:15 /data/jenkins/logs/audit-trail.log.5.lck -rw-r--r--. 1 jenkins jenkins 115 May 7 11:15 /data/jenkins/logs/audit-trail.log.5 -rw-r--r--. 1 jenkins jenkins 0 May 7 11:15 /data/jenkins/logs/audit-trail.log.6.lck -rw-r--r--. 1 jenkins jenkins 0 May 7 11:15 /data/jenkins/logs/audit-trail.log.6 {code} It appears the log rotation count is not working correctly.
Summary	Original: Audit Trail Plugin log file issues	New: Audit Trail Plugin log file rotation issue

Mark Nejman added a comment - 2015-05-07 17:09

I see there are multiple .lck files that are opened and do not go away. From reading up on FileHandler, that typically indicates multiple instances of FileHandler being instantiated. They say that is typically caused by multiple JVMs writing to the same log file. However, I am only using one JVM (verified with ps).

I'm wondering if the issue is in hudson.plugins.audit_trail.LogFileAuditLogger line 21:

private transient FileHandler handler;

I'm thinkning maybe the extension creates several instances of the audit-trail logger, and therefore multiple FileHandler instances trying to write to the same log file.

Is there a reason this attribute is marked as transient? I didn't think this was a serializable object. Perhaps the solution would be to mark it as static so that multiple instances do not exist in the same container.

Mark Nejman added a comment - 2015-05-07 17:09 I see there are multiple .lck files that are opened and do not go away. From reading up on FileHandler, that typically indicates multiple instances of FileHandler being instantiated. They say that is typically caused by multiple JVMs writing to the same log file. However, I am only using one JVM (verified with ps). I'm wondering if the issue is in hudson.plugins.audit_trail.LogFileAuditLogger line 21: private transient FileHandler handler; I'm thinkning maybe the extension creates several instances of the audit-trail logger, and therefore multiple FileHandler instances trying to write to the same log file. Is there a reason this attribute is marked as transient? I didn't think this was a serializable object. Perhaps the solution would be to mark it as static so that multiple instances do not exist in the same container.

Mark Nejman made changes - 2015-05-07 17:10

Assignee

New: Nicolas De Loof [ ndeloof ]

Mark Nejman made changes - 2015-05-18 17:20

Assignee

Original: Nicolas De Loof [ ndeloof ]

R. Tyler Croy made changes - 2016-07-25 23:51

Workflow

Original: JNJira [ 163122 ]

New: JNJira + In-Review [ 181107 ]

Pierre Beitz added a comment - 2019-05-19 13:58

Fixed by ~~JENKINS-44129~~

Pierre Beitz added a comment - 2019-05-19 13:58 Fixed by JENKINS-44129

Pierre Beitz made changes - 2019-05-19 13:58

Link

New: This issue duplicates ~~JENKINS-44129~~ [ ~~JENKINS-44129~~ ]

Pierre Beitz made changes - 2019-05-19 13:58

Assignee		New: Pierre Beitz [ pierrebtz ]
Resolution		New: Fixed [ 1 ]
Status	Original: Open [ 1 ]	New: Resolved [ 5 ]

Assignee:: Pierre Beitz

Reporter:: Mark Nejman

Votes:: 1 Vote for this issue

Watchers:: 2 Start watching this issue

Created:: 2015-05-07 15:27

Updated:: 2019-05-19 13:58

Resolved:: 2019-05-19 13:58

Jenkins

Details

Description

Attachments

Issue Links

Activity

Collapse comment: Mark Nejman added a comment - 2015-05-07 17:09

Expand comment: Mark Nejman added a comment - 2015-05-07 17:09

Collapse comment: Pierre Beitz added a comment - 2019-05-19 13:58

Expand comment: Pierre Beitz added a comment - 2019-05-19 13:58

People

Dates