Skip to content

Commit

Permalink
[exporterhelper] Remove deprecated aliases for Queue/TimeoutSettings (o…
Browse files Browse the repository at this point in the history
…pen-telemetry#11264)

#### Description

Follow-up to open-telemetry#11132 now that 0.110 has been released.

#### Link to tracking issue

Should be the final step for open-telemetry#6767.
  • Loading branch information
jade-guiton-dd authored and HongChenTW committed Dec 19, 2024
1 parent 37d2414 commit dbda1de
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 26 deletions.
25 changes: 25 additions & 0 deletions .chloggen/exporterhelper-remove-deprecated.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: exporterhelper

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Removed deprecated `QueueTimeout`/`TimeoutSettings` aliases in favor of `QueueConfig`/`TimeoutConfig`.

# One or more tracking issues or pull requests related to the change
issues: [11264, 6767]

# (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: "`NewDefaultQueueSettings` and `NewDefaultTimeoutSettings` have been similarly renamed."

# 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: [api]
4 changes: 2 additions & 2 deletions exporter/exporterhelper/common.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ func WithShutdown(shutdown component.ShutdownFunc) Option {
return internal.WithShutdown(shutdown)
}

// WithTimeout overrides the default TimeoutSettings for an exporter.
// The default TimeoutSettings is 5 seconds.
// WithTimeout overrides the default TimeoutConfig for an exporter.
// The default TimeoutConfig is 5 seconds.
func WithTimeout(timeoutConfig TimeoutConfig) Option {
return internal.WithTimeout(timeoutConfig)
}
Expand Down
8 changes: 0 additions & 8 deletions exporter/exporterhelper/internal/queue_sender.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,6 @@ import (

const defaultQueueSize = 1000

// Deprecated: [v0.110.0] Use QueueConfig instead.
type QueueSettings = QueueConfig

// QueueConfig defines configuration for queueing batches before sending to the consumerSender.
type QueueConfig struct {
// Enabled indicates whether to not enqueue batches before sending to the consumerSender.
Expand All @@ -40,11 +37,6 @@ type QueueConfig struct {
StorageID *component.ID `mapstructure:"storage"`
}

// Deprecated: [v0.110.0] Use NewDefaultQueueConfig instead.
func NewDefaultQueueSettings() QueueSettings {
return NewDefaultQueueConfig()
}

// NewDefaultQueueConfig returns the default config for QueueConfig.
func NewDefaultQueueConfig() QueueConfig {
return QueueConfig{
Expand Down
8 changes: 0 additions & 8 deletions exporter/exporterhelper/queue_sender.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,9 @@ package exporterhelper // import "go.opentelemetry.io/collector/exporter/exporte

import "go.opentelemetry.io/collector/exporter/exporterhelper/internal"

// Deprecated: [v0.110.0] Use QueueConfig instead.
type QueueSettings = internal.QueueConfig

// QueueConfig defines configuration for queueing batches before sending to the consumerSender.
type QueueConfig = internal.QueueConfig

// Deprecated: [v0.110.0] Use NewDefaultQueueConfig instead.
func NewDefaultQueueSettings() QueueSettings {
return internal.NewDefaultQueueConfig()
}

// NewDefaultQueueConfig returns the default config for QueueConfig.
func NewDefaultQueueConfig() QueueConfig {
return internal.NewDefaultQueueConfig()
Expand Down
8 changes: 0 additions & 8 deletions exporter/exporterhelper/timeout_sender.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,8 @@ import (
"go.opentelemetry.io/collector/exporter/exporterhelper/internal"
)

// Deprecated: [v0.110.0] Use TimeoutConfig instead.
type TimeoutSettings = TimeoutConfig

type TimeoutConfig = internal.TimeoutConfig

// Deprecated: [v0.110.0] Use NewDefaultTimeoutConfig instead.
func NewDefaultTimeoutSettings() TimeoutSettings {
return internal.NewDefaultTimeoutConfig()
}

// NewDefaultTimeoutConfig returns the default config for TimeoutConfig.
func NewDefaultTimeoutConfig() TimeoutConfig {
return internal.NewDefaultTimeoutConfig()
Expand Down

0 comments on commit dbda1de

Please sign in to comment.