Skip to content

docs(demo): system explorer library + manual (github.demo)#159

Merged
BorisTyshkevich merged 1 commit into
mainfrom
docs/system-explorer-demo
Jul 4, 2026
Merged

docs(demo): system explorer library + manual (github.demo)#159
BorisTyshkevich merged 1 commit into
mainfrom
docs/system-explorer-demo

Conversation

@BorisTyshkevich

Copy link
Copy Markdown
Collaborator

Summary

  • Adds a ready-made 14-query saved-queries Library that introspects ClickHouse's own system database (running queries, merges/mutations/replication health, storage, historical query/part/error activity), adapted from Mikhail Filimonov's ClickHouse ops Grafana dashboard gist — not ported 1:1.
  • Six of the fourteen queries share one pair of native ClickHouse query parameters, {from:String}/{to:String} (via parseDateTimeBestEffort), so the Dashboard's global filter bar (Feature: open favorited Library queries as an interactive Dashboard #149 D3) drives all six time-ranged tiles from a single From/To field pair.
  • examples/build-system-explorer-charts.mjs regenerates the JSON, deriving each chart's schema key live via FORMAT JSON (matches the existing build-ontime-charts.mjs pattern).
  • docs/SYSTEM-EXPLORER-DEMO.md + README/docs/local-app.html links, alongside the existing ontime chart demo.

Test plan

  • npm test green (no src/ changes; docs/examples only)
  • Verified live on github.demo (signed in as an account with full system grants): imported via File ▾ → Append (Added 14 · updated 0 · skipped 0), opened as Dashboard — 3 tiles populated immediately, 5 time-ranged tiles showed the shared "enter a value for: from, to" placeholder, and typing one From/To range populated all 5 together (5.5K/15/147/370/2.2K rows)

🤖 Generated with Claude Code

https://claude.ai/code/session_011QWzDSvS1PgxaDFbAjsjjq

A ready-made saved-queries Library that introspects ClickHouse's own
`system` database — running queries, merges/mutations/replication
health, storage, and historical query/part/error activity — adapted
from Mikhail Filimonov's ClickHouse ops Grafana dashboard gist
(not ported 1:1: no template macros, no per-pool time-series).

- examples/system-explorer-charts.json — 14 queries: 5 live snapshots
  (processes/merges/mutations/replicas/replication_queue), 3 storage/
  error bar charts, and 6 historical time-series sharing one pair of
  native query parameters, {from:String}/{to:String} (parsed via
  parseDateTimeBestEffort), so the Dashboard's global filter bar
  (#149 D3) drives all six time-ranged tiles from a single field pair.
- examples/build-system-explorer-charts.mjs — regenerates the JSON;
  derives each chartable entry's schema key live via FORMAT JSON
  (DESCRIBE's TSV output escapes an Enum8(...) type string differently
  from the HTTP+JSON interface the app actually uses).
- docs/SYSTEM-EXPLORER-DEMO.md — load steps, a query/view/feature
  table, and per-query deep links to https://github.demo.altinity.cloud/sql.
- README + docs/local-app.html: link the new demo alongside the
  existing ontime chart demo.

Verified live on github.demo as an account with full system-table
grants: imported cleanly (Added 14 · updated 0 · skipped 0), opened as
Dashboard — 3 tiles populated immediately, 5 showed the shared "enter
a value" placeholder, and typing one From/To range populated all 5
together.
@BorisTyshkevich BorisTyshkevich merged commit 0ef61a3 into main Jul 4, 2026
6 checks passed
@BorisTyshkevich BorisTyshkevich deleted the docs/system-explorer-demo branch July 4, 2026 20:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant