ref(kafka): Validate topics on startup #3543
Merged
Conversation
This file contains 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
Dav1dde
commented
May 14, 2024
relay-config/src/config.rs
Outdated
| @@ -999,6 +999,9 @@ pub struct Processing { | |||
| /// Kafka topic names. | |||
| #[serde(default)] | |||
| pub topics: TopicAssignments, | |||
| /// Whether to validate the supplied topics by calling Kafka's metadata endpoints. | |||
| #[serde(default)] | |||
| pub validate_kafka_topics: bool, | |||
There was a problem hiding this comment.
Suggested change
| pub validate_kafka_topics: bool, | |
| pub kafka_validate_topics: bool, |
relay-kafka/src/producer/mod.rs
Outdated
| fn validate_topic(&self) -> Result<(), ClientError> { | ||
| let client = self.producer.client(); | ||
| let metadata = client | ||
| .fetch_metadata(Some(&self.topic_name), Duration::from_secs(5)) |
| client_builder = client_builder.add_kafka_topic_config(*topic, kafka_config)?; | ||
| client_builder = client_builder | ||
| .add_kafka_topic_config(*topic, kafka_config, config.validate_kafka_topics()) | ||
| .context(ServiceError::Kafka)?; |
There was a problem hiding this comment.
Did you mean map_err here?
Suggested change
| .context(ServiceError::Kafka)?; | |
| .map_err(ServiceError::Kafka)?; |
|
|
jjbayer
approved these changes
May 14, 2024
| @@ -736,7 +736,7 @@ impl KafkaOutcomesProducer { | |||
| for topic in &[KafkaTopic::Outcomes, KafkaTopic::OutcomesBilling] { | |||
| let kafka_config = &config.kafka_config(*topic).context(ServiceError::Kafka)?; | |||
| client_builder = client_builder | |||
| .add_kafka_topic_config(*topic, kafka_config) | |||
| .add_kafka_topic_config(*topic, kafka_config, config.kafka_validate_topics()) | |||
There was a problem hiding this comment.
nit: To make this more builder pattern, it would be nice to have a method call outside of the loop
.add_kafka_topic_config(*topic, kafka_config)
}
builder.set_topic_validation(conig.kafka_validate_topics());
builder.build()| assert relay.wait_for_exit() != 0 | ||
|
|
||
| error = str(mini_sentry.test_failures.pop(0)) | ||
| assert "failed to validate the topic with name" in error |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds Kafka topics validation when Relay is starting up. This is done to prevent misconfiguration of Relay leading to errors when producing events.
Closes: #3404