Add support for filtering metrics in data streams #179
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
tiyash-basu-frequenz
requested review from
TalweSingh and
thomas-nicolai-frequenz
github-actions
bot
added
part:docs
Otherwise it makes it difficult to add links that make the lines go beyond the 80 character limit. Signed-off-by: Tiyash Basu <tiyash.basu@frequenz.com>
tiyash-basu-frequenz
force-pushed
the
178_filter
branch
from
1479f57
to
25317e1
Compare
|
As discussed, the filters are optional now, so that users have a convenient way of fetching all metrics from a component, given that the list of available metrics can vary between components. |
tiyash-basu-frequenz
force-pushed
the
178_filter
branch
from
25317e1
to
1dd6a51
Compare
tiyash-basu-frequenz
referenced
this pull request
Nov 17, 2023
This commit makes the filter for the data stream RPCs optional. This is implemented by moving the ID and metrics fields into a nested message, which is then added as the only field in the request. This allows the filter to be omitted, which will result in the server returning all metrics for all components or sensors. This is helpful for clients to easily know which metrics are available for a component or sensor. Otherwise, it may become difficult, given that the list if available metrics can very from one component to another. Signed-off-by: Tiyash Basu <tiyash.basu@frequenz.com>
|
I updated the PR based on comments here. I also changed the filter by moving the |
TalweSingh
reviewed
Nov 19, 2023
tiyash-basu-frequenz
force-pushed
the
178_filter
branch
from
1dd6a51
to
4d34a31
Compare
TalweSingh
previously approved these changes
Nov 20, 2023
This commit adds support for filtering metrics in data streams. The request messages for receiving data streams have now been extended to consist of a list of metrics to be streamed. This allows the user to request only the metrics they are interested in, instead of receiving all of them. If this list is empty, then no data will be streamed, and the service will return an error. The filter for the data stream RPCs are optional. This is implemented by putting the metrics field into a nested message, which is then added as a field in the request message. This makes the filter optional, so users can apply filters only when they intend to. This allows the filter to be omitted, which will result in the server returning all metrics for the given component or sensor. Signed-off-by: Tiyash Basu <tiyash.basu@frequenz.com>
tiyash-basu-frequenz
force-pushed
the
178_filter
branch
from
4d34a31
to
2357c5a
Compare
stefan-brus-frequenz
approved these changes
Nov 21, 2023
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 change adds support for filtering metrics in data streams. The request messages for receiving data streams have now been extended to consist of a list of metrics to be streamed. This allows the user to request only the metrics they are interested in, instead of receiving all of them. If this list is empty, then no data will be streamed, and the service will return an error.