feat: improved karafka plugin for insights #625
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
This implements a new Karafka subscriber that monitors more relevant
events. The subscriber will then emit events and metrics where
applicable.
This also includes new configuration parameters that let you enable and
disable Karafka specific Insights data. These are enabled by default.
```
karafka:
insights:
events: [boolean] # allow plugin to emit events from monitor
metrics: [boolean] # allow plugin to emit metrics from monitor
```
stympy
approved these changes
Oct 29, 2024
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 adds a more comprehensive event listener for monitoring Karafka allowing the plugin to send more event and metrics data to Insights. The error reporting code has also been extracted to its own listener class and now monitors both consumers and producers.
To help facilitate the added complexities and increased data output of this change, I also added two new configuration parameters to allow for fine grained control.
karafka.insights.events— Defaults totrue. Allows you to disable the plugin from automatically sending Insights events forconsumer_consumedanderror_occurrednotifications.karafka.insights.metrics— Defaults totrue. Allows you to disable the plugin from collecting various aggregated metrics.The following changes were also made:
min,max,avg, andlatestvalues to the histogram payload.valuekey. This allows for a more uniform interface when working with different metric types.Before submitting a pull request, please make sure the following is done:
rake specin the repository root.