ui icon indicating copy to clipboard operation
ui copied to clipboard

Feature Request: Descriptions for Concurrency Limits

Open kvnkho opened this issue 2 years ago • 5 comments

Why

Just a quality of life enhancement so that teams can know why there is a concurrency limit when they look at the limits in the UI.

What A description field in the UI for concurrency tag limits.

Picture below would be the place to add the description.

Notes image (18)

kvnkho avatar Dec 23 '21 17:12 kvnkho

https://docs.prefect.io/orchestration/flow-runs/concurrency-limits.html

zhen0 avatar Dec 30 '21 19:12 zhen0

Did you link the docs page exists for information about concurrency limits? The request though is a metadata description on the limit set if that clears things up a bit.

kvnkho avatar Dec 30 '21 20:12 kvnkho

Hi @kvnkho - I linked the logs to give Natalie more background about concurrency limits. But I'm going to get @ThatGalNatalie to touch base with you to make sure she understands what you are requesting with this ticket.

zhen0 avatar Jan 10 '22 18:01 zhen0

@zhen0 - @kvnkho entered this for me, as I initially requested it in slack. If it provides any additional context. I requested this after configuring a bunch of task concurrency limits in my Prefect Cloud. These limits are used to both limit concurrent access to source systems to prevent overloading and keep some replication processes synchronous.

I noticed after configuring everything, that nobody coming in after me is going to understand why these limits were put in place unless I document the limits in an external system.

What I thought would help the user experience is to add an additional Description field to the limit so a brief description can be entered to explain the reasoning of the created limits. It's purely for documentation/UX purposes.

Here is the results of all the configured limits after setting them up. You might imagine that if you came back later in life to this you may have forgot what all the limits were for. Another engineer behind you would also have no context. It would be useful to have a description column either on the grid or in the popup that allows for this context/documentation

image

image

Hopefully that helps understand the use case.

zyzil avatar Jan 10 '22 19:01 zyzil

Thanks for the extra info @zyzil - that's a slightly more complex request as would require changes in the backend too. I've marked this as one for future consideration as I like the idea!

zhen0 avatar Jan 11 '22 16:01 zhen0