Fix potential TopologyException when running multiple vulnerability-analyzer instances
#796
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
…-analyzer instances Kafka Streams works based on topologies. It relies on the fact that the *exact* same topology is present on all instances of a KS app. This means that the order of topology nodes must be identical. For the vulnerability-analyzer, users can enable or disable individual scanners. Only enabled scanners will be added to the topology on startup. Scanners are CDI beans, and we inject all of them via [`Instance`](https://jakarta.ee/specifications/cdi/3.0/apidocs/jakarta/enterprise/inject/instance). `Instance` can contain zero or more beans. Scanners are added to the topology by iterating over the `Instance` bean. The problem here is that the order of the beans in `Instance` is not guaranteed. It could happen that instance A of the service added scanners in the order 123, whereas instance B added them in order 213. A symptom of this problem is the following exception, followed by a shutdown of Kafka Streams: ``` org.apache.kafka.streams.errors.TopologyException: Invalid topology: Topic hyades-vulnerability-analyzer-scan-task-ossindex-repartition is unknown to the topology. This may happen if different KafkaStreams instances of the same application execute different Topologies. Note that Topologies are only identical if all operators are added in the same order. ``` Sorting the beans before adding them to the topology resolved the issue. Signed-off-by: nscuro <nscuro@protonmail.com>
|
Kudos, SonarCloud Quality Gate passed! |
VithikaS
approved these changes
Sep 11, 2023
VithikaS
deleted the
fix-topology-exception-with-multiple-vuln-analyzers
branch
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.
Kafka Streams works based on topologies. It relies on the fact that the exact same topology is present on all instances of a KS app. This means that the order of topology nodes must be identical.
For the vulnerability-analyzer, users can enable or disable individual scanners. Only enabled scanners will be added to the topology on startup.
Scanners are CDI beans, and we inject all of them via
Instance.Instancecan contain zero or more beans.Scanners are added to the topology by iterating over the
Instancebean. The problem here is that the order of the beans inInstanceis not guaranteed. It could happen that instance A of the service added scanners in the order 123, whereas instance B added them in order 213.A symptom of this problem is the following exception, followed by a shutdown of Kafka Streams:
Sorting the beans before adding them to the topology resolved the issue.