Issue #435: Add the possibility to use the same connector with different connector variables #467
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
…ent connector variables * Added the possibility to define additional connectors, which are connectors with variables where the user can customize variables values. * It is possible to define many instances of the same connector, and this by customizing values for each instance. * Updated unit tests to make sure everything is working. * Tested the changes on MetricsHub. * Updated the MetricsHub documentation to explain how to define and customize connector variables. * Updated MetricsHub maven plugin to generate additionalConnectors configuration.
13 tasks
CherfaElyes
requested review from
MedMaalej,
NassimBtk,
bertysentry,
TNohaic and
SafaeAJ
…-the-same-connector-with-different-connector-variables-values
…-the-same-connector-with-different-connector-variables-values
NassimBtk
requested changes
Oct 23, 2024
...shub-agent/src/main/java/org/sentrysoftware/metricshub/agent/config/AdditionalConnector.java
Outdated
Show resolved
Hide resolved
...a/org/sentrysoftware/metricshub/agent/deserialization/AdditionalConnectorsParsingResult.java
Outdated
Show resolved
Hide resolved
...a/org/sentrysoftware/metricshub/agent/deserialization/AdditionalConnectorsParsingResult.java
Outdated
Show resolved
Hide resolved
...rc/main/java/org/sentrysoftware/metricshub/agent/helper/ConnectorVariablesLibraryParser.java
Outdated
Show resolved
Hide resolved
...rc/main/java/org/sentrysoftware/metricshub/agent/helper/ConnectorVariablesLibraryParser.java
Outdated
Show resolved
Hide resolved
...rc/main/java/org/sentrysoftware/metricshub/agent/helper/ConnectorVariablesLibraryParser.java
Outdated
Show resolved
Hide resolved
...rc/main/java/org/sentrysoftware/metricshub/agent/helper/ConnectorVariablesLibraryParser.java
Outdated
Show resolved
Hide resolved
...rc/main/java/org/sentrysoftware/metricshub/agent/helper/ConnectorVariablesLibraryParser.java
Outdated
Show resolved
Hide resolved
...rc/main/java/org/sentrysoftware/metricshub/agent/helper/ConnectorVariablesLibraryParser.java
Outdated
Show resolved
Hide resolved
| @@ -828,7 +828,9 @@ loggerLevel: ... | |||
|
|
|||
| #### Configure Connector Variables | |||
|
|
|||
| In **MetricsHub**, connector variables are essential for customizing the behavior of data collection. The connector variables are configured in the `metricshub.yaml` file under the `variables` section of your configured resource. These variables are specified under the name of the connector to which they belong and contain key-value pairs. The key of each variable corresponds to a variable already configured in the connector. | |||
| In **MetricsHub**, connector variables are essential for customizing the behavior of data collection. These variables are configured in the `additionalConnectors` section of your `metricshub.yaml` file. When configuring variables for connectors with variables, the connector becomes an additional connector, which is by default forced, and uses the variables configured by the user. | |||
There was a problem hiding this comment.
We need to review this documentation 😉
There was a problem hiding this comment.
Let me know when I can start the doc review @CherfaElyes and @NassimBtk :)
There was a problem hiding this comment.
Thanks @CherfaElyes! @iguitton you can start the review, I am fine with the source code.
…ent connector variables * Refactored ConnectorVariablesLibraryParser for better clarity. * Corrected some Javadoc errors. * Moved some classes to a new package.
…ent connector variables * Updated Documentation.
…-the-same-connector-with-different-connector-variables-values
…ifferent connector variables * Reformatted the code.
NassimBtk
previously approved these changes
Oct 25, 2024
…ent connector variables * Updated configure-monitoring.md
NassimBtk
approved these changes
Oct 25, 2024
NassimBtk
previously approved these changes
Oct 25, 2024
…nt connector variables values * Reviewed and updated the user documentation
|
@CherfaElyes , @NassimBtk: I reviewed and updated the user documentation. If you are fine with my version, you can approve and merge this PR. Thanks. |
Thank you @iguitton for the review! |
NassimBtk
previously approved these changes
Nov 4, 2024
connector variables * Reformatted tables. * Updated connector links to use relative paths.
NassimBtk
approved these changes
Nov 4, 2024
…-the-same-connector-with-different-connector-variables-values
NassimBtk
deleted the
feature/issue-435-add-the-possibility-to-use-the-same-connector-with-different-connector-variables-values
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.
Tests
Two additional connectors (same connector twice)
In this case, connectors compiled filename will take as value the connectorId.
One additional connector without uses
No additional connectors configured, only connector with variables is forced.