[DOCS-12158] Add how throttle works #32885
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Preview links (active after the
|
maycmlee
commented
Nov 17, 2025
mikhacim
reviewed
Nov 21, 2025
|
|
||
| {{% observability_pipelines/processors/filter_syntax %}} | ||
|
|
||
| ## How the throttle processor works |
Contributor
There was a problem hiding this comment.
Would we normally capitalize Throttle?
mikhacim
reviewed
Nov 21, 2025
|
|
||
| ## How the throttle processor works | ||
|
|
||
| The throttle processor sets a rate limit on the number of logs sent within a specified time window. While similar to the quota processor, the main difference between the throttle and quota is that the quota processor's time window is fixed at 24 hours and cannot be changed, while the throttle processor's time window can be configured. Since the throttle processor's time window is configurable, the processor has a capacity replenishment rate based on the throttling rate and time window you set. See [Capacity replenishment rate](#capacity-replenishment-rate) for more information. |
Contributor
There was a problem hiding this comment.
Link to quota processor docs on the first mention. Should we capitalize all instances of Quota and Throttle since they are names of a feature? Or do we usually keep lowercase
mikhacim
reviewed
Nov 21, 2025
|
|
||
| The throttle processor uses a generic cell rate algorithm, which enables a steady rate of events to pass through. The replenishment rate is based on the settings of your throttle processor and allows a certain number of events to pass through per second. This rate can be calculated as follows: | ||
|
|
||
| $$\text"Throttle rate" / \text"Time window (in seconds)"$$ |
Contributor
There was a problem hiding this comment.
In the preview the images of the formulas seems a little broken
mikhacim
reviewed
Nov 21, 2025
|
|
||
| ### Capacity replenishment rate | ||
|
|
||
| The throttle processor uses a generic cell rate algorithm, which enables a steady rate of events to pass through. The replenishment rate is based on the settings of your throttle processor and allows a certain number of events to pass through per second. This rate can be calculated as follows: |
Contributor
There was a problem hiding this comment.
Maybe link to some documentation of what a generic cell rate algorithm is: https://en.wikipedia.org/wiki/Generic_cell_rate_algorithm
Not sure if we use wikipedia in our docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do? What is the motivation?
Adds section on how the throttle processor works
Merge instructions
Merge readiness:
For Datadog employees:
Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.
Additional notes