Adding documentation for object_per_topic_config and metric_per_topic_config #114
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
hikhvar
approved these changes
Jan 2, 2023
|
Thank you for your contribution! |
This was referenced Jan 2, 2023
wmoss
commented
Jan 2, 2023
| if cfg.MQTT.ObjectPerTopicConfig != nil && cfg.MQTT.MetricPerTopicConfig != nil { | ||
| return Config{}, fmt.Errorf("only one of object_per_topic_config and metric_per_topic_config can be specified") | ||
| } | ||
|
|
There was a problem hiding this comment.
I should have said this earlier, but it is worth noting that this is potentially a breaking change for some users. They would have had an incorrect config, but if they were using it to parse json then it would have worked with both configs in there and now it will throw an error. I don't think this is a big deal, but maybe worth noting in the release notes or something.
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
object_per_topic_configandmetric_per_topic_configto the documentation as well as an example taken from #96. It also adds a check when parsing the config to make sure both are not specified.