Skip to content

Commit e8f32c3

Browse files
authored
docs(throttle transform): Fix key_field docs to mention templating (#13561)
* docs(throttle transform): Fix key_field docs to mention templating Signed-off-by: Jesse Szwedko <[email protected]> * ci
1 parent fd0b6c1 commit e8f32c3

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

website/cue/reference/components/transforms/throttle.cue

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,17 @@ components: transforms: throttle: {
3636
key_field: {
3737
common: false
3838
description: """
39-
The name of the log field whose value will be hashed to determine if the event should be rate limited.
39+
A [template string](/docs/reference/configuration/template-syntax/) that will be rendered to determine
40+
if the event should be rate limited.
4041
41-
Each unique key will create a buckets of related events to be rate limited separately. If left unspecified,
42-
or if the event doesn’t have `key_field`, the event be will not be rate limited separately.
42+
Each unique rendered template value will create a buckets of related events to be rate limited
43+
separately. If left unspecified, or if the event doesn’t have `key_field`, the event be will not be rate
44+
limited separately. For example, to throttle events based on the `hostname` field use `{{ hostname }}`.
4345
"""
4446
required: false
4547
type: string: {
4648
default: null
47-
examples: ["message", "{{ hostname }}"]
49+
examples: ["{{ message }}", "{{ hostname }}"]
4850
syntax: "template"
4951
}
5052
}

0 commit comments

Comments
 (0)