Skip to content

chore: Regen docs for sample and throttle #17390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
spencergilbert merged 1 commit into from
May 15, 2023
Merged

chore: Regen docs for sample and throttle #17390

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion website/cue/reference/components/transforms/base/sample.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ base: components: transforms: sample: configuration: {
sampled.

Each unique value for the key creates a bucket of related events to be sampled together
and the rate is applied to the buckets themselves to sample `1/N` buckets. Overall rate
and the rate is applied to the buckets themselves to sample `1/N` buckets. The overall rate
of sampling may differ from the configured one if values in the field are not uniformly
distributed. If left unspecified, or if the event doesn’t have `key_field`, then the
event is sampled independently.
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/transforms/base/throttle.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ base: components: transforms: throttle: configuration: {
}
key_field: {
description: """
The value to group events into a separate buckets to be rate limited independently.
The value to group events into separate buckets to be rate limited independently.

If left unspecified, or if the event doesn't have `key_field`, then the event is not rate
limited separately.
Expand Down