Skip to content

Commit

Permalink
[connector/routing] Change default value of 'match_once' to true.
Browse files Browse the repository at this point in the history
  • Loading branch information
djaglowski committed Dec 18, 2024
1 parent ad60f51 commit f8b91a3
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 6 deletions.
27 changes: 27 additions & 0 deletions .chloggen/routing-deprecation-step2.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# 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. filelogreceiver)
component: routingconnector

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Change default value of `match_once` parameter to `true`.

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [29882]

# (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: This field was deprecated in v0.116.0 and will be removed in v0.120.0.

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# 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: []
3 changes: 3 additions & 0 deletions connector/routingconnector/config_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ func TestLoadConfig(t *testing.T) {
configPath: filepath.Join("testdata", "config", "traces.yaml"),
id: component.NewIDWithName(metadata.Type, ""),
expected: &Config{
MatchOnce: true,
DefaultPipelines: []pipeline.ID{
pipeline.NewIDWithName(pipeline.SignalTraces, "otlp-all"),
},
Expand All @@ -52,6 +53,7 @@ func TestLoadConfig(t *testing.T) {
configPath: filepath.Join("testdata", "config", "metrics.yaml"),
id: component.NewIDWithName(metadata.Type, ""),
expected: &Config{
MatchOnce: true,
DefaultPipelines: []pipeline.ID{
pipeline.NewIDWithName(pipeline.SignalMetrics, "otlp-all"),
},
Expand All @@ -77,6 +79,7 @@ func TestLoadConfig(t *testing.T) {
configPath: filepath.Join("testdata", "config", "logs.yaml"),
id: component.NewIDWithName(metadata.Type, ""),
expected: &Config{
MatchOnce: true,
DefaultPipelines: []pipeline.ID{
pipeline.NewIDWithName(pipeline.SignalLogs, "otlp-all"),
},
Expand Down
1 change: 1 addition & 0 deletions connector/routingconnector/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ func NewFactory() connector.Factory {
func createDefaultConfig() component.Config {
return &Config{
ErrorMode: ottl.PropagateError,
MatchOnce: true,
}
}

Expand Down
3 changes: 1 addition & 2 deletions connector/routingconnector/logs.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,8 @@ func newLogsConnector(
) (*logsConnector, error) {
cfg := config.(*Config)

// TODO update log from warning to error in v0.116.0
if !cfg.MatchOnce {
set.Logger.Warn("The 'match_once' field has been deprecated. Set to 'true' to suppress this warning.")
set.Logger.Error("The 'match_once' field has been deprecated and will be removed in v0.120.0. Remove usage of the parameter to suppress this warning.")
}

lr, ok := logs.(connector.LogsRouterAndConsumer)
Expand Down
3 changes: 1 addition & 2 deletions connector/routingconnector/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,8 @@ func newMetricsConnector(
) (*metricsConnector, error) {
cfg := config.(*Config)

// TODO update log from warning to error in v0.116.0
if !cfg.MatchOnce {
set.Logger.Warn("The 'match_once' field has been deprecated. Set to 'true' to suppress this warning.")
set.Logger.Error("The 'match_once' field has been deprecated and will be removed in v0.120.0. Remove usage of the parameter to suppress this warning.")
}

mr, ok := metrics.(connector.MetricsRouterAndConsumer)
Expand Down
3 changes: 1 addition & 2 deletions connector/routingconnector/traces.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,8 @@ func newTracesConnector(
) (*tracesConnector, error) {
cfg := config.(*Config)

// TODO update log from warning to error in v0.116.0
if !cfg.MatchOnce {
set.Logger.Warn("The 'match_once' field has been deprecated. Set to 'true' to suppress this warning.")
set.Logger.Error("The 'match_once' field has been deprecated and will be removed in v0.120.0. Remove usage of the parameter to suppress this warning.")
}

tr, ok := traces.(connector.TracesRouterAndConsumer)
Expand Down

0 comments on commit f8b91a3

Please sign in to comment.