This plugin allows Jobs to be prioritised based on Queue Strategies and Priority Strategies.

Description

This plugin adds the ability to assign different priorities to jobs: the lower the priority a job has, the sooner the job will run.

This can be very helpful, when one wants to add low priority jobs, but wants to have higher-priority jobs run first. This is especially true when hardware is limited, or when there are different groups of jobs that should share resources (equally).

Fundamentals

The plugin is build around some basic concepts:

• Queue Strategy
• Job Group
• Job Inclusion Strategy, and
• Priority Strategy.

First, the Queue Strategy describes how the priority of a job is interpreted. It will translate the job's assigned priority to a corresponding weight in the queue. The queue is, then, sorted based on the assigned weight.

With the Priority Sorter, you will need to group your jobs into Job Groups. A Job Group's Job Inclusion Strategy devides whether a specific job should be included in the group.

The priority of the job is then set by the Priority Strategy, and each Job Group can have any number priority strategies.

When a new job is queued, the following will happen:

• The Priority Sorter will go though the configured Job Groups from top to bottom.
  
  • When it finds a Job Group where the job is to be included, it will look though the Priority Strategies from top to bottom
    • When it finds a Priority Strategy that matches its criteria, it will use this strategy to assign a priority the the Job.
• The Priority Sorter will then consult the Queue Strategy to translate the priority to a weight, i.e. a position in the queue.

Queue Strategies

There are three included Queue Strategies, each of which will sort the Queue differently.

Absolute

Each job will be assigned a priority, and, the lower the priority, the sooner the job will be run.

Fair Queuing

Each Job will be assigned a priority, but the queue will try to share the resources equally over different priorities in a round-robin fashion.

Weighted Fair Queuing

The same as Fair Queuing, but jobs with a lower priority will be run more frequently those with higher a priority. Remember, that the lower the priority assignment, the higher the importance.

Job Inclusion Strategies

This setting describes which jobs are included in a Job Group, and is relatively self explanatory. It is worth mentioning the "Jobs Marked for Inclusion" setting. When this is selected, you are requested to enter a name of the Job Group. This name will then be an available option on each job, providing an alternative "bottom-up" way to group jobs, rather than the default "top-down" approach of the other strategies.

Priority Strategies

It is possible to assign the priority, based on different Priority Strategies.

This setting describes what priority a job should have, and is self explanatory. It is worth mentioning the the "Take the Priority from Property on the Job" setting. When selected, a drop-down - where you can select a priority - appears on all projects that would generate jobs to be included in this group.

Main Configuration

The plugin's main configuration options are available on the Jenkins configuration page. Configuration options for Priority Strategy are available on its own page, accessible from the root actions menu.

On the main configuration page, you can select the number of priorities you would like to use, as well as a default priority to use where no other priority could be assigned.

 Please note that lower number means higher priority! See details on the screen, for the specifics on each strategy. 

Assigning Priorities

On the main menu, you will find the link to a page where you can assign priorities to each Job

On this page you will be able to assign jobs to groups, and priorities to jobs.

 Please note that all matching is done top to bottom by first match

You can limit access to this functionality to administrators, by checking the appropriate check-box on the main configuration page.

Run Exclusive

If a job from a Run Exclusive job group gets started, jobs from other groups will remain blocked, and will not get executed until all jobs from the Run Exclusive job group are complete, regardless of priority.

Using the View Column

Since a job can get a different priority each time it is started, the view column cannot show the "correct" priority for the Job.

The column will show the priority used the last time the job was launched, and, if the job has not been started yet, the column will show Pending.

Notable changes and upgrading

Upgrading from 1.x

Version 2.x is a complete rewrite of the plugin, but still supports running in version 1.x compatibility mode. However if you are satisfied with the functionality of 1.x, there is little point in upgrading.
Upgrading from version 1.x to version 3.x will remove all 1.x configurations. Therefore, if you need to keep configured values, upgrade to 2.x, first, switch to Advanced Mode, and then upgrade from 2.x to 3.x.

Upgrading from 2.x

In version 3.x, the option "Allow priorities directly on Jobs" has been removed in favor of the Priority Strategy "Take the priority from Property on the Job" (see above). Legacy Mode is removed (see above regarding upgrading from version 1.x).

Troubleshooting

To get some inside information on how, and why, a certain job gets a certain priority, you can turn on some extra logging.

• Logger: PrioritySorter.Queue.Items
  • To get more info on the assigned priorities, and state transition of the items in the queue, set the log level to FINE.
  • To get more info on how the jobs are matched to job groups, and rules to get the priority, set the log level to FINER.

To get logging on when the Queue Sorter is active log, use:

• Logger: PrioritySorter.Queue.Sorter, with the level set to FINE.
  • To see all items sorted (the queue) by the Queue Sorter, set the log level to FINER.

Changelog

Version 3.6.0 (2018-01-12)

• PR #42 - Make plugin compatible with class serialization whitelists in Jenkins Core 2.102 and above (JEP-200)
  • Warning: the change fixes the base class of the SorterStrategy extension point. If you implement it in plugins, it is recommended to update the dependency
• PR #40 - Null safety in some plugin methods (e.g. Strategy#getPriority()

Version 3.5.1 (2017-06-18)

• JENKINS-41419 - Fix sorting of queue items when `sortAsInQueueSince` is set
• JENKINS-42584 - Take priorities of upstream jobs into account when scheduling downstream jobs
• PR #38 - Prevent NullPointerException in PriorityConfigurationPlaceholderTaskHelper when restarting Jenkins with pending jobs
• JENKINS-44014 - Prevent NullPointerException in AdvancedQueueSorter#onLeft() when item is missing in the queue
  • Instead of exceptions, there will be warning messages in Jenkins logs with diagnostics info
• JENKINS-44014 - Prevent ClassCastException if owner of the Pipeline placeholder task is not a Job
  • In such case a default priority will be set. The issue will be logged on the FINE level

Version 3.5.0 (2017-01-18)

Fixes : JENKINS-40284 Fix blocked weights with Fair Queuing strategies
Fixes : JENKINS-36570 Add Pipeline support

Version 3.4.1 (2015-09-29)

Fixes : JENKINS-37644 Update Folders Plugin dependency to fix the compatibility issue

Version 3.4 (2015-06-06)

Fixes : JENKINS-28621 Jenkins jobs get held up in queue waiting for available executors, even though all are available

Version 3.3 (2015-05-26)

Fixes : JENKINS-28462 Priority selection on Job is "always" shown
Fixes : JENKINS-28461 Control Node usage based on Priority
Relates : JENKINS-23640 Validate regular expression and report matching jobs on Job Priorities page

Version 3.2 (2015-05-18)

Fixes : JENKINS-24962 Cannot assign a JobGroup to a Nested (sub) View
Fixes : JENKINS-28280 Wrong Job Group is shown in the selector (one more place) (Thanks to Kyrremann)

Version 3.1 (2015-05-12)

Fixes : JENKINS-28195 Jenkins not scheduling any jobs after upgrade to Priority Sorter 3.0 but giving exception
Fixes : JENKINS-28280 Wrong Job Group is shown in the selector (Thanks to Kyrremann)
Fixes : JENKINS-28359 Remove support and conversion from Legacy Mode

Version 3.0 (2015-05-02)

Fixes : JENKINS-21337 Add support for cloudbees-folders
Fixes : JENKINS-21356 Add support for using JobProperty to join a Job to a JobGroup
Fixes : JENKINS-23538 Remove support for Legacy Sorter
Fixes : JENKINS-23552 Replace "Allow priorities directly on Jobs"
Fixes : JENKINS-23557 Add matrix child jobs to the front of the queue
Fixes : JENKINS-27966 Priority Sorter must not require matrix-project

Version 2.12 (2015-04-15)

Fixes : JENKINS-27957 NullPointerException in AdvancedQueueSorter

Version 2.11 (2015-04-14)

Fixes : JENKINS-27770 AdvancedQueueSorter call to sort violates the comparison contract

Version 2.10 (2015-04-14)

Never released - maven hickup

Version 2.9 (2014-10-08)

• Fixed NPE happening at startup [X] (Thanks to christ66)
• Added description field to JobGroups [X] (Thanks to olivergondza)

Version 2.8 (2014-06-17)

Fixes : JENKINS-23462 Sectioned views are not evaluated for job priority

Version 2.7 (2014-06-16)

• Adds some more logging about queue contents, see Troubleshooting above
• Performance enhancement when updating the configuration [X] (Thanks to ndeloof)

Fixes : JENKINS-23428 Jobs in NestedView (ViewGroup) are not correctly found

Version 2.6 (2014-01-11)

Fixes : JENKINS-21310 CCE when a Queue.Task was not a Job
Fixes : JENKINS-21316 PrioritySorter wrongly assumes Queue.Task is Job
Relates: JENKINS-21314 Stack trace displayed on web page when attempting to configure PrioritySorter plugin

Version 2.5 (2014-01-08)

Fixes: JENKINS-21289 Item Logging causing NPE
Fixes: JENKINS-21284 Add some logging to show what the sorter is doing
Fixes: JENKINS-21204 Add ability to boost recently failed Jobs

Version 2.4 (2014-01-02)

Fixes: JENKINS-21173 Anonymous Users Can Configure Priorities
Fixes: JENKINS-21119 Extend loggning to show assigned priority
Fixes: JENKINS-21103 "Priorities are assigned top down by first match" does not work correctly (Thanks to Adam Gabryś for debugging help)

Version 2.3 (2013-12-20)

• introduces the Run Exclusive Mode to deal with JENKINS-11997
• adds a new Priority Strategy to give Jobs the same priority as a UpstreamJob
• some performance enhancements
• hopefully fixes the deadlock issue in JENKINS-21034
• fixes the priority assignment issue on main configuration page

Fixes: JENKINS-11997 Consider jobs in the Executors for priority sorter
Fixes: JENKINS-21034 Jenkins Startup Deadlock - QueueSorter.installDefaultQueueSorter and Queue.init
Fixes: JENKINS-20995 Default Priority always shows 1-5

Version 2.2 (2013-12-05)

Fixing bug that made the plugin switch to Advanced mode even though Legacy (1.3) data was present in the system. (Thanks to help from Matthew Webber)

Fixes: [JENKINS-8597] Deal with matrix builds better

Version 2.1 (2013-12-04)

Fixes bug that mapped all Jobs to all Views/JobGroups.

Version 2.0 (2013-12-02)

Introducing advanced queueing features with possibility to selected different strategies for how priorities are assigned and how the queue is sorted.

Thanks Oleg for testing, reviewing and helping out.

Version 1.3

Removed view column from default view (Thanks to work from larrys)

Version 1.2

Added View column to easily compare priorities between jobs (Thanks to work from cjo9900)

Version 1.1

Fixed a potential NPE when using the plugin on existing jobs without setting a default priority.

Version 1.0

Initial Release