Improving instance stability with rate limiting

Administering Bitbucket Server

On this page

Still need help?

The Atlassian Community is here for you.

Ask the community

When automated integrations or scripts send requests to Bitbucket Server in huge bursts, it can affect Bitbucket’s stability, leading to drops in performance or even downtime. Rate limiting allows your Bitbucket instance to self-protect. It keeps Bitbucket stable by giving you control over how many requests automations can make, and how often they can make them.

A Data Center license is required to use this feature. Learn more

How rate limiting works

Rate limiting targets HTTP requests with basic or bearer authentication (such as REST API requests). It operates using the token bucket algorithm. When it’s turned on:

  • Each user is given a ‘token bucket’ containing the maximum number of tokens they can hold (this is their token bucket size).

  • Every time they make an HTTP request one token is taken out of their bucket.

  • New tokens are added into their bucket at a constant rate until it is full (this is their token bucket refill rate)

  • If their bucket is empty, they cannot make requests.

When rate limiting is on and set up correctly for your instance, your users should experience improved Bitbucket stability and performance, and those using it reasonably won’t experience any change in their ability to send it requests. The only time users will be rate limited is when they act in a way that will negatively impact Bitbucket, such as when they make requests in large bursts or when they make requests too frequently.

Example

An admin has turned on rate limiting and has set a token bucket size of 60 and a refill rate of 5.

One of their developers sends Bitbucket 60 requests in a single burst. As this developer starts with a full token bucket, all 60 requests will be successful. Their token bucket, however, will now be empty and it will begin refilling at a speed of 5 tokens per second. As it refills, they can send more requests and they won’t be rate limited as long as they have enough tokens in their bucket.

Another developer sends Bitbucket 100 requests in a single burst. As their bucket can only hold 60 tokens, only their first 60 requests will be successful and then they’ll be rate limited. Their token bucket will now be empty and it will begin refilling at 5 tokens per second. If they try to send the remaining 40 requests and they don’t have enough tokens in their bucket they’ll be rate limited again. To send all their requests successfully they'll have to rewrite their script.

How to turn on rate limiting

You need to be a System Admin or Admin to turn on rate limiting. The first time you do this you’ll see default values for:

  1. Token bucket size - This is the number of tokens that are available to a user. It determines the maximum number of requests they can send in a burst. By default, this is set to 60

  2. Token bucket refill rate - This is the number of tokens added to a user’s bucket per second. It determines their throughput. By default, this is set to 5

These values should be suitable for most instances and we recommend starting with them before adjusting up or down.

To turn on rate limiting:

  1. In Bitbucket, go to  > Rate limiting.

  2. Change the status to On.

  3. If necessary, change the token bucket size and token bucket fill rate.

  4. Click Save.

Rate limiting can be disabled instance-wide

If required, System Admins can disable rate limiting instance-wide through the Bitbucket properties file. To find out how to do this, see feature.rate.limiting on the Bitbucket config properties page.

How rate limiting works in a cluster

If your Bitbucket instance consists of a cluster of nodes behind a load balancer, each of your users will have a separate token bucket on each node. In other words, if you have three nodes, your users will have three token buckets.

In addition, the global settings for token bucket size and refill rate apply separately to each of these buckets. In other words, If you’ve set them to 60 and 5, they’ll be 60 and 5 on each bucket, unless the user has an exemption.

This means that each user’s ability to send requests won’t change, and Bitbucket will remain protected and stable regardless of which node their requests are routed to.

Identifying users who have been rate limited

When a user is rate limited, they’ll know immediately as they’ll receive an HTTP 429 error message (too many requests).

There are also two ways you can identify which users have been rate limited:

  1. You can look at the Users rate limited in the past 24 hours table on the rate limiting settings page.

  2. For more detailed information you can look in the Bitbucket access log. Every time a user is rate limited an event with the label rate-limited will be recorded.

Lastly, you can use JMX metrics for an aggregated view of how many users have been rate limited. To allow you to do this, metrics for the number of rate limited requests and current user map size have been exposed.

Adding and editing rate limiting exemptions

To let users to send Bitbucket a different number of requests than the global settings allow, you can add an exemption. There are two types of exemptions:

  • Allow custom settings - Use this to give a user a different token bucket size and refill rate.

  • Allow unlimited requests - Use this to remove users from rate limiting altogether.

To add an exemption:

  1. Open the Exemptions tab.

  2. Click Add exemption.

  3. Find the user and choose their new settings.

  4. Click Save.

It will be applied to the user, and will show up in the list of exemptions.

To edit or remove an exemption:

  1. Open the Exemptions tab.

  2. Find the user in the list of exemptions

  3. Click the

  4. Choose what you’d like to do.

You can also add, edit, and remove exemptions using Bitbucket Server's REST API.

How to help users avoid being rate limited

If rate limiting is set up correctly, users who send Bitbucket requests in a reasonable way won’t experience any change besides improved system stability and performance. As for those users who are being rate limited, there are simple changes they can make to stop this from happening, and at the same time help out their team. They can:

  • Avoid tight loops by writing scripts that wait for each REST request to finish before a new one is fired. For example, if these REST requests are being used to populate a wallboard, they can consider sending them one at a time, and only sending a new request after the previous one has finished.

  • Avoid spawning multiple threads all making requests.

Last modified on Sep 19, 2019

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.