[DBM] ClickHouse: document query errors, explain plans, query tagging, parts & merges, schema collection, CPU time#37409
Conversation
…query tagging, parts and merges, schema collection, CPU time per query Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…n framing (sqlcommenter/marginalia) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
domalessi
left a comment
There was a problem hiding this comment.
Thanks for the PR! A handful of editorial fixes inline.
Also, one higher-level note for discussion:
The Data collected section is now quite dense, and it has a framing issue introduced by the new entries. The existing lead-in ("Database Monitoring collects the following data from ClickHouse:") sets up a flat list, but the entries aren't all the same kind of thing:
- Query observability (Instance metadata through Query tagging): query execution data
- Parts and merges: storage health metrics with no query involvement
- Schema collection: catalog metadata
As a result, it's unclear whether Parts and merges is part of the "data" in that intro sentence, or something separate (and if separate, what exactly it is).
Suggest restructuring Data collected with H3 subheadings:
## Data collected
### Query observability
[Instance metadata through Query tagging]
### Storage health metrics (Agent 7.80+)
[Parts and merges]
### Schema (Agent 7.81+)
[Schema collection]
Two secondary wins from this:
- The (Agent 7.80+) / (Agent 7.81+) inline version callouts in the definition list can move into the subheadings instead, where they're more visible
- The 17-row metrics table in Parts and merges fits better in the Configuration reference section under the parts_and_merges config table -- that's where a reader configuring the feature will look for it, and removing it from Data collected makes the overview section much lighter
|
|
||
| Tags appear on the Sample Details page under **Propagated Tags** and can be used to filter the Explain Plans and Query Samples views. See [Tagging SQL Statements][tag-statements] for full details. | ||
|
|
||
| [sqlcommenter]: https://google.github.io/sqlcommenter |
There was a problem hiding this comment.
Move these three reference definitions to the bottom of the file with the other link refs, and convert to numbered style ([1], [2], [3]) instead of named identifiers.
| | `schema_metrics.enabled` | boolean | `false` | Enable per-table size and per-view refresh gauges. Requires `dbm: true`. | | ||
| | `schema_metrics.collection_interval` | number | `60` | Collection interval in seconds. | | ||
|
|
||
| ## Coming soon |
There was a problem hiding this comment.
Remove this heading and the <div class="alert alert-info"> block that follows — forward-looking placeholder content gets stale once the feature ships.
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
Summary
query_errorsconfig, error event contents (exception message, error code, stack trace), enabled by defaultEXPLAIN json=1collection forSELECT/WITHqueries with rate-limit config optionstag_database_statementsguide. Also adds ClickHouse to the supported databases list in that guide.parts_and_mergesconfig reference, explains storage health timeline viewcollect_schemasandschema_metricsconfig, required grants (system.tables,system.columns,system.view_refreshes)cpu_virtual_time_us/cpu_wait_usfields on completions and aggregatedtotal_*fields on query metricsBoth
selfhosted.mdandcloud.mdupdated identically. "Before you begin" now has a per-feature Agent version matrix.Files changed
content/en/database_monitoring/setup_clickhouse/selfhosted.mdcontent/en/database_monitoring/setup_clickhouse/cloud.mdcontent/en/database_monitoring/guide/tag_database_statements.md— added ClickHouse (Agent 7.79+) to supported databases listTest plan
conf.yaml.examplein integrations-core🤖 Generated with Claude Code