[receiver/kafka] Add support for topic and exclude_topic as an array #44575
+368
−139
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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: enhancement | ||
|
|
||
| # The name of the component, or a single word describing the area of concern, (e.g. receiver/filelog) | ||
| component: receiver/kafka | ||
|
|
||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: Support configuring a list of topics and exclude_topics | ||
khushijain21 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. | ||
| issues: [44477] | ||
|
|
||
| # (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: | ||
|
|
||
| # 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: [user] | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -53,6 +53,45 @@ func (c *Config) Unmarshal(conf *confmap.Conf) error { | |
| return err | ||
| } | ||
|
|
||
| // Check if deprecated fields have been explicitly set | ||
| // give them precedence | ||
| var zeroConfig Config | ||
| if err := conf.Unmarshal(&zeroConfig); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // handle deprecated topic and exclude_topic for log signal | ||
| if zeroConfig.Logs.Topic != "" && len(zeroConfig.Logs.Topics) == 0 { | ||
| c.Logs.Topics = []string{zeroConfig.Logs.Topic} | ||
| } | ||
| if zeroConfig.Logs.ExcludeTopic != "" && len(zeroConfig.Logs.ExcludeTopics) == 0 { | ||
| c.Logs.ExcludeTopics = []string{zeroConfig.Logs.ExcludeTopic} | ||
| } | ||
|
|
||
| // handle deprecated topic and exclude_topic for metric signal | ||
| if zeroConfig.Metrics.Topic != "" && len(zeroConfig.Logs.Topics) == 0 { | ||
| c.Metrics.Topics = []string{zeroConfig.Metrics.Topic} | ||
| } | ||
| if zeroConfig.Metrics.ExcludeTopic != "" && len(zeroConfig.Logs.ExcludeTopics) == 0 { | ||
| c.Metrics.ExcludeTopics = []string{zeroConfig.Metrics.ExcludeTopic} | ||
| } | ||
|
|
||
| // handle deprecated topic and exclude_topic for trace signal | ||
| if zeroConfig.Traces.Topic != "" && len(zeroConfig.Logs.Topics) == 0 { | ||
| c.Traces.Topics = []string{zeroConfig.Traces.Topic} | ||
| } | ||
| if zeroConfig.Traces.ExcludeTopic != "" && len(zeroConfig.Logs.ExcludeTopics) == 0 { | ||
| c.Traces.ExcludeTopics = []string{zeroConfig.Traces.ExcludeTopic} | ||
| } | ||
|
|
||
| // handle deprecated topic and exclude_topic for profile signal | ||
| if zeroConfig.Profiles.Topic != "" && len(zeroConfig.Logs.Topics) == 0 { | ||
| c.Profiles.Topics = []string{zeroConfig.Profiles.Topic} | ||
| } | ||
| if zeroConfig.Profiles.ExcludeTopic != "" && len(zeroConfig.Logs.ExcludeTopics) == 0 { | ||
| c.Profiles.ExcludeTopics = []string{zeroConfig.Profiles.ExcludeTopic} | ||
| } | ||
|
|
||
| // Set OnPermanentError default value to inherit from OnError for backward compatibility | ||
| // Only if OnPermanentError was not explicitly set in the config | ||
| rawConf := conf.Get("message_marking") | ||
|
|
@@ -73,61 +112,80 @@ func (c *Config) Unmarshal(conf *confmap.Conf) error { | |
| // Validate checks the receiver configuration is valid. | ||
| func (c *Config) Validate() error { | ||
axw marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // Validate that exclude_topic is only used with regex topic patterns | ||
| if err := validateExcludeTopic("logs", c.Logs.Topics, c.Logs.ExcludeTopics); err != nil { | ||
| return err | ||
| } | ||
| if err := validateExcludeTopic("metrics", c.Metrics.Topics, c.Metrics.ExcludeTopics); err != nil { | ||
| return err | ||
| } | ||
| if err := validateExcludeTopic("traces", c.Traces.Topics, c.Traces.ExcludeTopics); err != nil { | ||
| return err | ||
| } | ||
| if err := validateExcludeTopic("profiles", c.Profiles.Topics, c.Profiles.ExcludeTopics); err != nil { | ||
| return err | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // validateExcludeTopic checks that exclude_topic is only configured when topic uses regex pattern | ||
| func validateExcludeTopic(signalType string, topics, excludeTopics []string) error { | ||
khushijain21 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| if len(excludeTopics) == 0 { | ||
| return nil // No exclude_topic configured, nothing to validate | ||
| } | ||
|
|
||
| // if none of the configured topic uses regex return error | ||
| var usesRegex bool | ||
| for _, topic := range topics { | ||
| if strings.HasPrefix(topic, "^") { | ||
| usesRegex = true | ||
khushijain21 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| } | ||
|
|
||
| if !usesRegex { | ||
| return fmt.Errorf( | ||
| "%s.exclude_topics is configured but none of the configured %s.topics use regex pattern (must start with '^')", | ||
| signalType, signalType, | ||
| ) | ||
| } | ||
|
|
||
| for _, excludeTopic := range excludeTopics { | ||
| // Validate that exclude_topic is a valid regex pattern | ||
| if _, err := regexp.Compile(excludeTopic); err != nil { | ||
| return fmt.Errorf( | ||
| "%s.exclude_topic contains invalid regex pattern: %w", | ||
| signalType, err, | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // TopicEncodingConfig holds signal-specific topic and encoding configuration. | ||
| type TopicEncodingConfig struct { | ||
| // Deprecated [v0.142.0]: Use Topics | ||
| Topic string `mapstructure:"topic"` | ||
|
|
||
| // Topics holds the name of the Kafka topic from which messages of the | ||
khushijain21 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| // signal type should be consumed. | ||
| // | ||
| // The default depends on the signal type: | ||
| // - "otlp_spans" for traces | ||
| // - "otlp_metrics" for metrics | ||
| // - "otlp_logs" for logs | ||
| // - "otlp_profiles" for profiles | ||
| Topics []string `mapstructure:"topics"` | ||
|
|
||
| // Encoding holds the expected encoding of messages for the signal type | ||
| // | ||
| // Defaults to "otlp_proto". | ||
| Encoding string `mapstructure:"encoding"` | ||
|
|
||
| // Deprecated [v0.142.0]: Use ExcludeTopics | ||
| ExcludeTopic string `mapstructure:"exclude_topic"` | ||
|
|
||
| // Optional exclude topics option, used only in regex mode. | ||
| ExcludeTopics []string `mapstructure:"exclude_topics"` | ||
| } | ||
|
|
||
| type MessageMarking struct { | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.