Page Comparison

Automation for JIRA comes with a number of service limits out of the box to ensure Automation rules don't overload your JIRA instance.  Sometimes it may be necessary to increase these limits if your server hardware can handle it, and your unique usage scenarios require it.  This is currently only possible in JIRA Server.  In Cloud you can request a limit increase via support (please include why you need this increase in your request).

You will know you're hitting limits if you see errors like these in your audit log:

• The audit item status is 'THROTTLED'

• The audit item contains one of:

  • This automation rule spent more than the allowed total time processing in the last day. Maximum allowed processing time over a day is (in minutes):

  • Automation for JIRA has exceeded the allowed maximum number of rule executions in the last hour:

  • A JQL search in this automation rule has exceeded the allowed maximum number of issues to retrieve per search. Only the first issues up to the following limit where processed:

We haven't had a chance yet to build a configuration UI to increase these limits, but they can be increased with a REST call.

Step-by-step guide

First find out what your current limits are. You can do so with the following REST call:

GET <your JIRA instance url>/rest/cb-automation/latest/configuration/property

RETURNS:
{
	"max.processing.time.per.day": "3600",
	"rule.rate.per.five.second": "2",
	"max.rules.per.hour": "5000",
	"max.issues.per.search": "1000",
	"short.scheduled.interval.issue.limit": "1000",
	"automation.processing.thread.pool.size.per.node":"2",
	"max.lite.executions.per.month": "2147483647"  //doesn't apply in server.
}

Lets break these down:

...

max.processing.time.per.day

...

rule.rate.per.five.second

max.rules.per.hour

...

These control how many rules can be processed. They way these work are as follows:

• If more executions happened in the last 5 seconds than specified by rule.rate.per.five.second check if the max per hour limits have been reached on this tenant.

This guarantees that if there's spikes of activity, they will eventually be throttled. However if after this spike activity returns to normal and rules trickle in slowly then they execute again immediately.

Say for example you have rule A triggered 10 times in the last 5 seconds: We then check how many times did all rules trigger in the last hour. If this exceeds 5000 for the instance then this rule execution will be throttled.

...

max.issues.per.search

...

short.scheduled.interval.issue.limit

...

automation.processing.thread.pool.size.per.node

...

This one is a bit different from properties above. It defines the number of threads processing rules off the queue in Jira server.  By default this is 4 threads per server (or per node in data center).  Generally this should be plenty for most instances.  If you are seeing slow rule executions you may want to increase this to 8 threads.  

WARNING: Increasing this value can have the opposite effect and result in worse performance, if your DB or app server can't handle the increased load. Only increase this value if you are sure your infrastructure can handle it.

To set one of these properties, please use this REST call (the Content-Type must be set to application/json) :

PUT <your JIRA instance url>/rest/cb-automation/latest/configuration/property

{
    "key": "max.processing.time.per.day",
    "value": "10000"
}

curl -X PUT -H 'Content-type: application/json' -d '{"key": "max.executions.bucket.limit", "value": "5000"}'\

 https://your-instance.com/rest/cb-automation/latest/configuration/property

Related articles