JobConfigHistory Plugin Best Practices

Issue

Environment

Resolution

JobConfigHistory Plugin is a plugin designed to maintain the history of what has changed in the Jenkins job configuration and the system configuration. If a user has performed an operation to the job configuration and performed a save operation, then the history of what was changed (diff) and the user making the changes.

Recommended configuration

There are many customization posibilities to improve the performance of the JobConfigHistory Plugin that are going to impact positively in the overall instance performance.

At Manage Jenkins -> Configure System -> Job Config History you could see:

Configure System / JobConfigHistory

  • Use different history directory than default - Setting this option to a new location is good if you would like to store the job configuration history in another location other than $JENKINS_HOME/config-history (like another mount or another drive). We strongly encourage users to set this to another mount/drive as the job config history plugin will increase the number of inodes for the JENKINS_HOME directory.

  • Max number of history entries to keep - We recommend keeping this number to a minimum (about 1000). If left blank then all entries will be kept.

  • Max number of days to keep history entries - We recommend the max number of days to be 30 days.

  • System configuration exclude file pattern (default: queue\.xml|nodeMonitors\.xml|UpdateCenter\.xml|global-build-stats) - If there is configuration in the System configuration page which is not altered often or altering it does not impact users, then those options can be excluded from being added to the exclude file pattern. Please, keep the default configuration, adding more patterns if required. For example, queue\.xml|nodeMonitors\.xml|UpdateCenter\.xml|global-build-stats|com.cloudbees.opscenter.client.plugin.OperationsCenterCredentialsProvider

  • Do not save duplicate history - We recommend disabling this option. This option removes duplicate entries or entries where nothing changes but is also the cause of performance issues.

  • Save Maven module configuration changes - We recommend disabling this option. When a maven project completes the job configuraiton is saved, which causes an increase in the amount of maven module configuration changes.

  • Show build badges - in order to not overload the history widget.

  • Exclude users - if you want to exclude changes by system. For example, excluding SYSTEM in a CJP OC - CJP CM configuration.

Have more questions? Submit a request

1 Comments

  • 0
    Avatar
    Subhabrata Sarkar

    This was very useful for me, thanks

Please sign in to leave a comment.