Skip to content

Deprecate the old exporter batch configuration section #12772

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

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
29 changes: 29 additions & 0 deletions .chloggen/deprecate-old-batcher.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Use this changelog template to create an entry for release notes.

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

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

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: "Deprecate configuring exporter batching separately. Use `sending_queue::batch` instead."

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

# (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: |
Moving the batching configuration to `sending_queue::batch` requires setting `sending_queue::sizer` to `items`
which means that `sending_queue::queue_size` needs to be also increased by the average batch size number (roughly
x5000 for the default batching configuration).
See https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/exporterhelper#configuration

# 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: [user]
11 changes: 6 additions & 5 deletions exporter/exporterhelper/internal/base_exporter_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,12 @@ func TestBaseExporterLogging(t *testing.T) {
sendErr := bs.Send(context.Background(), &requesttest.FakeRequest{Items: 2})
require.Error(t, sendErr)

require.Len(t, observed.FilterLevelExact(zap.ErrorLevel).All(), 2)
assert.Contains(t, observed.All()[0].Message, "Exporting failed. Dropping data.")
assert.Equal(t, "my error", observed.All()[0].ContextMap()["error"])
assert.Contains(t, observed.All()[1].Message, "Exporting failed. Rejecting data.")
assert.Equal(t, "my error", observed.All()[1].ContextMap()["error"])
errorLogs := observed.FilterLevelExact(zap.ErrorLevel).All()
require.Len(t, errorLogs, 2)
assert.Contains(t, errorLogs[0].Message, "Exporting failed. Dropping data.")
assert.Equal(t, "my error", errorLogs[0].ContextMap()["error"])
assert.Contains(t, errorLogs[1].Message, "Exporting failed. Rejecting data.")
assert.Equal(t, "my error", errorLogs[1].ContextMap()["error"])
require.NoError(t, bs.Shutdown(context.Background()))
}

Expand Down
2 changes: 2 additions & 0 deletions exporter/exporterhelper/internal/queuebatch/queue_batch.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ func NewQueueBatchLegacyBatcher(
cfg Config,
next sender.SendFunc[request.Request],
) (*QueueBatch, error) {
set.Telemetry.Logger.Warn("Configuring the exporter batcher capability separately is now deprecated. " +
"Use sending_queue::batch instead.")
return newQueueBatch(set, cfg, next, true)
}

Expand Down
Loading