Skip to content

Commit 760fbbc

Browse files
[exporter/debug]: disable sending queue by default (#14151)
#### Description The recently added (#13791, #14101) sending queue functionality in the Debug exporter had a default size of 1, causing issue described in #14138. I propose to disable the queue by default in the Debug exporter. #### Link to tracking issue Fixes #14138 #### Testing Updated unit tests. I would feel better if the queue scenarios where better covered by tests. On the other hand, I don't want to have similar queue/batching tests duplicated in all exporters. #### Documentation Updated documentation to say the sending queue is disabled by default.
1 parent 5fa8e32 commit 760fbbc

File tree

4 files changed

+31
-3
lines changed

4 files changed

+31
-3
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: enhancement
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
7+
component: exporter/debug
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: Disable sending queue by default
11+
12+
# One or more tracking issues or pull requests related to the change
13+
issues: [14138]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext: |
19+
The recently added sending queue configuration in Debug exporter was enabled by default and had a problematic default size of 1.
20+
This change disables the sending queue by default.
21+
Users can enable and configure the sending queue if needed.
22+
23+
# Optional: The change log or logs in which this entry should be included.
24+
# e.g. '[user]' or '[user, api]'
25+
# Include 'user' if the change is relevant to end users.
26+
# Include 'api' if there is a change to a library API.
27+
# Default: '[user]'
28+
change_logs: []

exporter/debugexporter/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The following settings are optional:
3838
Refer to [Zap docs](https://godoc.org/go.uber.org/zap/zapcore#NewSampler) for more details
3939
on how sampling parameters impact number of messages.
4040
- `use_internal_logger` (default = `true`): uses the collector's internal logger for output. See [below](#using-the-collectors-internal-logger) for description.
41-
- `sending_queue`: see [Sending Queue](../exporterhelper/README.md#sending-queue) for the full set of available options.
41+
- `sending_queue` (disabled by default): see [Sending Queue](../exporterhelper/README.md#sending-queue) for the full set of available options.
4242

4343
Example configuration:
4444

exporter/debugexporter/config_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ func TestUnmarshalDefaultConfig(t *testing.T) {
2525

2626
func TestUnmarshalConfig(t *testing.T) {
2727
queueCfg := exporterhelper.NewDefaultQueueConfig()
28-
queueCfg.QueueSize = 1
28+
queueCfg.Enabled = false
2929
tests := []struct {
3030
filename string
3131
cfg *Config

exporter/debugexporter/factory.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ func NewFactory() exporter.Factory {
4343

4444
func createDefaultConfig() component.Config {
4545
queueCfg := exporterhelper.NewDefaultQueueConfig()
46-
queueCfg.QueueSize = 1
46+
queueCfg.Enabled = false
4747

4848
return &Config{
4949
Verbosity: configtelemetry.LevelBasic,

0 commit comments

Comments
 (0)