Skip to content

Commit

Permalink
docs(sample transform): add sample_rate_key docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dekelpilli committed Sep 16, 2024
1 parent 32518ef commit 9a14181
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions website/cue/reference/components/transforms/base/sample.cue
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,14 @@ base: components: transforms: sample: configuration: {
1500,
]
}
sample_rate_key: {
description: """
The name of the log field used to add the sample rate to each event. If set to "", the rate will not be set.
"""
required: false
type: string: {
default: "sample_rate"
examples: ["sample_rate", ""]
}
}
}

0 comments on commit 9a14181

Please sign in to comment.