oximeter: clean up query summary logic and docs. #9184
Conversation
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.
jmcarp
force-pushed
the
jmcarp/oximeter-query-summaries-cleanup
branch
from
080f598 to
23d896c
Compare
ahl
left a comment
ahl
left a comment
There was a problem hiding this comment.
This looks good with the very significant caveat that I don't understand how we intend to use it or for it to be used.
| 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. |
* 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
1a5ac66 to
0818cb6
Compare
I think I can get the information I need with |
