Skip to content
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.

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

relay: Add metrics.buffering and metrics.sample_rate options #2616

Merged
merged 2 commits into from
Oct 30, 2020
Merged
Changes from all commits
Commits
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
20 changes: 19 additions & 1 deletion src/docs/product/relay/options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@ human-readable strings of a number and a human-readable unit, such as:

`metrics.default_tags`

: _Map of strings to strings, default empty_
: _Map of strings to strings, default: empty_

A set of default tags that should be attached to all outgoing StatsD metrics.

Expand All @@ -374,6 +374,24 @@ human-readable strings of a number and a human-readable unit, such as:
If set, adds a tag of the given name and sets it to the hostname of the machine that
is running Relay. This configuration is useful to distinguish multiple Relays.

`metrics.buffering`

: _boolean, default: `true`_

Whether the emitted metrics will be buffered before sending to StatsD server. This generally improves
performance, but comes with a caveat that with low traffic volume, metrics might take a few more seconds to
propagate.

`metrics.sample_rate`

: _Float, default 1.0_

Global sample rate for all emitted metrics. Should be between 0.0 and 1.0. If outside that range,
the value will be normalized (negative values would become 0.0, positive larger than 1.0 become 1.0).
For instance, the value of 0.3 means that only 30% of the emitted metrics will be sent.
Note that the implemented sampling approach is not aware of metrics types, and, for example, does not
rescale counter values when the sample rate is less than 1.0.

## Internal Error Reporting

Configures error reporting for errors happening within Relay. Disabled by
Expand Down