Add doc page on ingester reactive limiters #10591
Conversation
jhalterman
added
type/docs
jhalterman
force-pushed
the
adaptivelimiter-docs
branch
from
c33548f to
7e56297
Compare
docs/sources/mimir/configure/about-ingester-adaptive-limiters.md
Outdated
Show resolved
Hide resolved
|
|
||
| Mimir's adaptive concurrency limiters can be used to guard against ingester overload, by automatically adapting concurreny limits based on indications of overload. | ||
|
|
||
| ## How do adaptive limiters work? |
There was a problem hiding this comment.
Is the feature called adaptive limiters, adaptive concurrency limiters, or ingester adaptive limiters? We should choose one and standardize throughout the doc.
There was a problem hiding this comment.
Adaptive concurrency limiters, which I'd call adaptive limiters for short. I wrote this doc originally based on the about ingester circuit breakers doc, which is why I mentioned ingester in a few places. My preference would be to not though.
There was a problem hiding this comment.
I think we can just refer to them as adaptive limiters throughout. You mention in the description that they adapt concurrency limits to guard against ingester overload, so I think just saying adaptive limiters is sufficiently clear.
docs/sources/mimir/configure/about-ingester-adaptive-limiters.md
Outdated
Show resolved
Hide resolved
docs/sources/mimir/configure/about-ingester-adaptive-limiters.md
Outdated
Show resolved
Hide resolved
docs/sources/mimir/configure/about-ingester-adaptive-limiters.md
Outdated
Show resolved
Hide resolved
docs/sources/mimir/configure/about-ingester-adaptive-limiters.md
Outdated
Show resolved
Hide resolved
docs/sources/mimir/configure/about-ingester-adaptive-limiters.md
Outdated
Show resolved
Hide resolved
docs/sources/mimir/configure/about-ingester-adaptive-limiters.md
Outdated
Show resolved
Hide resolved
|
|
||
| When recent response times increase significantly relative to the longer term trend, an adaptive limiter will temporarily decrease concurrency limits to avoid potential overload. Similarly, when increasing inflight requests correlate with flat or decreasing throughput and increasing response times, this is taken as a sign of overload and the concurrency limit is decreased. | ||
|
|
||
| ## How do adaptive limiters behave in practice? |
There was a problem hiding this comment.
Can we simplify this heading to How adaptive limiters work ?
There was a problem hiding this comment.
The section above was meant to be about how they work, and this section was meant to be more about how they behave. Did you want to shorten this section to How do adaptive limiters behave?
There was a problem hiding this comment.
I think we can actually do away with the heading and just have everything under How adaptive limiters work.
docs/sources/mimir/configure/about-ingester-adaptive-limiters.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
|
|
||
| When recent response times increase significantly relative to the longer term trend, an adaptive limiter will temporarily decrease concurrency limits to avoid potential overload. Similarly, when increasing inflight requests correlate with flat or decreasing throughput and increasing response times, this is taken as a sign of overload and the concurrency limit is decreased. | ||
|
|
||
| ## How do adaptive limiters behave in practice? |
There was a problem hiding this comment.
I think we can actually do away with the heading and just have everything under How adaptive limiters work.
Change "ingester adaptive limiters" to "adaptive limiters". Remove the behavior section and make the queueing and rejection sections into sub-sections.
|
This looks great! Thank you so much! |
jhalterman
changed the title
Add doc page on ingester adaptive limiters Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
Add doc page on ingester adaptive limiters Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
What this PR does
This PR adds a doc page describing ingester reactive limiters, which are being introduced via #10574.
Which issue(s) this PR fixes or relates to
Depends on #10574
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX].about-versioning.mdupdated with experimental features.