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

[exporter/debug] disable sampling by default #10250

Merged
Merged
Show file tree
Hide file tree
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
25 changes: 25 additions & 0 deletions .chloggen/debug-exporter-disable-sampling.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: breaking

# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
component: exporter/debug

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Disable sampling by default

# One or more tracking issues or pull requests related to the change
issues: [9921]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext: To restore the behavior that was previously the default, set `sampling_thereafter` to `500`.

# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: []
10 changes: 6 additions & 4 deletions exporter/debugexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,11 @@ The following settings are optional:
logged.
- `sampling_initial` (default = `2`): number of messages initially logged each
second.
- `sampling_thereafter` (default = `500`): sampling rate after the initial
messages are logged (every Mth message is logged). Refer to [Zap
docs](https://godoc.org/go.uber.org/zap/zapcore#NewSampler) for more details.
- `sampling_thereafter` (default = `1`): sampling rate after the initial
messages are logged (every Mth message is logged).
The default value of `1` means that sampling is disabled.
To enable sampling, change `sampling_thereafter` to a value higher than `1`.
Refer to [Zap docs](https://godoc.org/go.uber.org/zap/zapcore#NewSampler) for more details
on how sampling parameters impact number of messages.

Example configuration:
Expand Down Expand Up @@ -109,4 +111,4 @@ Attributes:

## Warnings

- Unstable Output Format: The output formats for all verbosity levels is not guaranteed and may be changed at any time without a breaking change.
- Unstable Output Format: The output formats for all verbosity levels is not guaranteed and may be changed at any time without a breaking change.
2 changes: 1 addition & 1 deletion exporter/debugexporter/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ var componentType = component.MustNewType("debug")

const (
defaultSamplingInitial = 2
defaultSamplingThereafter = 500
defaultSamplingThereafter = 1
)

// NewFactory creates a factory for Debug exporter
Expand Down
Loading