No mention of "active slots" setting in Global Concurrency Limits section of documentation

[tristanchambers-bids]

First check

• I added a descriptive title to this issue.
• I used GitHub search to find a similar request and didn't find it 😇

Describe the issue

The Add Concurrency Limit dialog box has a setting called "Active Slots". But this setting is not explained in the documentation, nor is there a tooltip to explain the effect of this setting. The docs list all of the other settings on this dialog box:

Name: The name of the concurrency limit. This name is also how you'll reference the concurrency limit in your code. Special characters, such as /, %, &, >, <, are not allowed.
Concurrency Limit: The maximum number of slots that can be occupied on this concurrency limit.
Slot Decay Per Second: Controls the rate at which slots are released when the concurrency limit is used as a rate limit. This value must be configured when using the rate_limit function.
Active: Whether or not the concurrency limit is in an active state.

Describe the proposed change

Add a line to the list of settings explaining the effect of this setting.

Additional context

I'd like to get my concurrency limits set up, but I'm not confident that I'm doing it right without understanding this setting.

[serinamarie]

Hi, @tristanchambers-bids, we have a section in the documentation for this-- were you able to locate this guide?

[jeffrose-relay]

@serinamarie I am struggling with this too. This guide you linked does not mention the Active Slots field or what it means. I have even looked in the source code but there is nothing helpful there either.

[tristanchambers-bids]

Hi @serinamarie yes those are the docs I was referring to in my issue description. I updated to clarify. This page has no mention of the words "Active Slots".

[tristanchambers-bids]

For those who are scratching their head like me, I discovered today that "Active Slots" is not a parameter that you set. It is in fact a variable which keeps track of how many slots are currently claimed. The system increments and decrements the value when each task is added and completed (respectively). Why is this a user editable value you may ask? Well it turns out that when you cancel a job, the system does not decrement the active slots value for any tasks that were killed. So after you cancel a job you should check this value and set it to zero if there were any killed tasks that did not complete!