oximeter: clean up query summary logic and docs. #9184
Conversation
This file contains hidden or 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
Contributor
jmcarp
commented
Oct 9, 2025
jmcarp
commented
- Convert query summaries lazily; h/t @david-crespo.
- Drop query summaries from user-facing docs; h/t @ahl. This feature is only useful for Oxide engineers to investigate oximeter performance, and we don't want to leak implementation details into public docs.
* Convert query summaries lazily; h/t @david-crespo. * Drop query summaries from user-facing docs; h/t @ahl. This feature is only useful for Oxide engineers to investigate oximeter performance, and we don't want to leak implementation details into public docs.
jmcarp
force-pushed
the
jmcarp/oximeter-query-summaries-cleanup
branch
from
080f598 to
23d896c
Compare
ahl
approved these changes
Oct 9, 2025
| pub query: String, | ||
| /// Whether to include ClickHouse query summaries in the response. | ||
| /// Whether to include query summaries in the response. Note: we omit this | ||
| //field from the generated docs, since it's mainly of interest internally. |
There was a problem hiding this comment.
Suggested change
| //field from the generated docs, since it's mainly of interest internally. | |
| /// field from the generated docs, since it is not intended for consumption by customers. |
| } | ||
|
|
||
| /// Basic metadata about the resource usage of a single ClickHouse SQL query. | ||
| /// Basic metadata about the resource usage of a single backend query. |
There was a problem hiding this comment.
Suggested change
| /// Basic metadata about the resource usage of a single backend query. | |
| /// Basic metadata about the resource usage of a query. |
| pub tables: Vec<OxqlTable>, | ||
| /// Summaries of queries run against ClickHouse. | ||
| /// Summaries of queries run against ClickHouse. Note: we omit this field | ||
| //from the generated docs, since it's mainly of interest internally. |
There was a problem hiding this comment.
|
I like skipping it. Didn't realize it was aimed at internal users. We might need to think about this kind of thing more broadly — I can't think of any other spots we hide a field in the OpenAPI schema for this purpose. Would be good to have a sort of policy or rule of thumb about when it's appropriate in order to avoid doing it too much. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.