File tree Expand file tree Collapse file tree 1 file changed +6
-4
lines changed
website/cue/reference/components/transforms Expand file tree Collapse file tree 1 file changed +6
-4
lines changed Original file line number Diff line number Diff line change @@ -36,15 +36,17 @@ components: transforms: throttle: {
36
36
key_field : {
37
37
common : false
38
38
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.
40
41
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 }}`.
43
45
"""
44
46
required : false
45
47
type : string : {
46
48
default : null
47
- examples : [" message " , " {{ hostname }} " ]
49
+ examples : [" {{ message }} " , " {{ hostname }} " ]
48
50
syntax : " template "
49
51
}
50
52
}
You can’t perform that action at this time.
0 commit comments