fix: add guidance re usage query count #6910
Conversation
|
|
||
| // Adjusts table properties to warn user that only flux queries are included in the Query Count. | ||
| const isQueryCount: Boolean = usageVector.name === VectorName.QueryCount | ||
| const vectorName = isQueryCount ? 'Query Count (Flux Only)' : usageVector.name |
There was a problem hiding this comment.
This overrides the default backend-provided vector name.
eatondustin1
left a comment
eatondustin1
left a comment
There was a problem hiding this comment.
Looks good, but I did have one suggestion to mitigate future issues.
src/usage/context/usage.tsx
Outdated
| export enum VectorName { | ||
| QueryCount = 'Query Count', | ||
| Storage = 'Storage', | ||
| DataIn = 'Data In', | ||
| DataOut = 'Data Out', | ||
| } |
There was a problem hiding this comment.
If we're only using 'Query Count' today, I think we're better off either inlining the 'Query Count' string in /src/usage/UsageSingleStat.tsx or exporting a const QueryCount = 'Query Count' here instead. Otherwise, we're maintaining the other vector names without any confirmation that they're correct, which could lead to someone mistakenly relying on their accuracy in the future.
There was a problem hiding this comment.
That's a good point -- this was really anticipating future use since I wasn't happy with the fact that we don't identify the actual string values anywhere in the UI. But there is no need for any of the enum values other than QueryCount now.
wdoconnell
force-pushed
the
add_flux_query_note_to_usage_pg
branch
from
4679df5 to
60ecec8
Compare
|
Amended commit addresses @eatondustin1 's comment above ^ |
| const statHeaders = [ | ||
| 'Data In (MB)', | ||
| 'Query Count', | ||
| 'Query Count (Flux Only) ?', |
There was a problem hiding this comment.
I just noticed the ? here - doesn't the tooltip element cover that?
There was a problem hiding this comment.
This is a change I identified after running the ui integration tests, which failed without the change. This is part of a test that designates what text to look for in the header. QuestionMarkToolip is a Clockface component that, among other things, renders and formats a ? as text wherever the component is rendered. As a result, the test needed to be updated to address the fact that the text within the header now includes that ?.
There was a problem hiding this comment.
Ah, that makes sense, thanks for the explanation!
Clarifies that the query count on the C2 usage page reflects flux queries only.
Checklist
Authors and Reviewer(s), please verify the following: