[Feature] Add Monitor page to Canopy
Maintainers usually reply within 1 day
@snowhiteohno is already working on this.
Since Nov 6, 2026.
- #1414 by @pallavithegod — closed without merging
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Active
- Tech stack
- prometheus
- Domain
- backend, documentation, frontend, observability, testing
Research direction
Start by reviewing docs/operation/observability/metrics.md and enumerating the BanyanDB HTTP endpoints and metrics for the proposed sections. Capture the layout and data-fetching approach in canopy/docs/monitor-design.md, then inspect the existing Canopy sidebar and test locations under canopy/e2e/. Done means a scoped design and implementation plan covering the /monitor route, loading/error states, refresh behavior, role enforcement, and tests.
Written by the indexing model from the issue text.
Description
Summary
Introduce a Monitor page in the Canopy web console that surfaces BanyanDB cluster/runtime health, key metrics, and node status — giving operators a single place to observe the state of the database from the UI.
Motivation
Today Canopy focuses on schema CRUD and ad-hoc query (Groups, Streams, Measures, Traces, IndexRules, Properties, TopN pipelines). There is no dedicated surface for runtime/cluster observability. Operators currently have to rely on:
- raw BanyanDB HTTP endpoints,
- external Prometheus/Grafana dashboards,
- log scraping.
A first-class Monitor page in Canopy lowers the operational bar and complements the existing schema/query UI.
Goals
- A new top-level Monitor entry in the Canopy sidebar.
- Pulls data from BanyanDB's existing observability surface (HTTP API + Prometheus metrics where applicable).
- Renders key health signals and recent trends.
- Role-gated: available to
admin(and possiblyreadonly).
Scope (suggested sections — refine during design)
- Cluster overview — node list, liveness, role (liaison/data), version, uptime.
- Shard / group status — per-group shard health, replica state, hot-node distribution (reuses concepts from existing BYDB-Replica work).
- Storage metrics — disk usage per node/path, segment counts,
sidx/inverted-index sizes, write amplification (sourced fromdocs/operation/observability/metrics.md). - Query metrics — QPS, p50/p95/p99 latencies, error rate, slow-query top-N (mirrors the existing
banyandb_*metrics). - Recent events / alerts — last N warnings/errors from BanyanDB (if surfaced via API) and any active TopN pipeline anomalies.
- Trace pipeline status — if Trace Pipeline (per #13634) is enabled, surface its stage/throughput.
Tasks
- Research — enumerate the BanyanDB HTTP endpoints and metrics that can power each Monitor section; identify gaps that require new backend API.
- Design doc — proposed layout under
canopy/docs/monitor-design.md; data-fetching strategy (BFF proxy + caching vs. direct from SPA); refresh interval; empty/error/loading states. - PoC — implement the page shell with Cluster overview + Storage metrics end-to-end (server proxy + web page) using existing BanyanDB endpoints; stub the other sections behind a feature flag.
- Tests — Vitest tests for new BFF proxy routes; component tests for the page; e2e smoke under
canopy/e2e/. - Docs — update
canopy/README.md(sidebar change) and addcanopy/docs/monitor-design.md.
Acceptance Criteria
- New
/monitorroute accessible from the sidebar. - Cluster overview + storage metrics render real data from a running BanyanDB.
- Loading / empty / error states handled.
- Bounded refresh interval (default 10s, configurable).
- Role enforcement:
adminonly by default (configurable to allowreadonly). - Unit + e2e tests pass.
- Docs updated.
Out of Scope
- Custom alerting rules / notification channels.
- Long-term metrics storage (rely on Prometheus).
- Replacing the existing SkyWalking OAP observability dashboards — this page is a lightweight in-product view, not a Grafana replacement.
- Dominant language
- Java
- Stars
- 25k
- Forks
- 6.6k
- Avg merge
- 12h 1m
- Merged PRs (30d)
- 43
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from apache/skywalking
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
apache/skywalking#14239 ·
Maintainers usually reply within 1 day
-
AI Assistant database enhancement
Difficulty 5/5 Over a week Newbie friendliness 24/100
apache/skywalking#14237 ·
Maintainers usually reply within 1 day
-
database enhancement
Difficulty 5/5 Over a week Newbie friendliness 25/100
apache/skywalking#14236 ·
Maintainers usually reply within 1 day
-
AI Assistant database enhancement
Difficulty 5/5 Over a week Newbie friendliness 25/100
apache/skywalking#14235 ·
Maintainers usually reply within 1 day
-
database enhancement
Difficulty 5/5 Over a week Newbie friendliness 30/100
apache/skywalking#14234 ·
Maintainers usually reply within 1 day
All issues in apache/skywalking
Similar issues
-
Re-executed query with IN condition on an index column returns deleted rows (stale IndexCursor)Possibly taken @dbusche claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
h2database/h2database#4580 ·
Maintainers usually reply within 1 day
-
vips-drift
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Stirling-Tools/JPDFium#300 ·
Maintainers usually reply within 1 day
-
hermes-queue
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
chrisalunlloyd2-sudo/mindpalace#403 ·
Maintainers usually reply within 1 day
-
Guidelines: document how to build a use case against a local, unpublished Flow/browserless-test changePossibly taken @totally-not-ai claimed this today. Open
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
vaadin/use-cases#452 · 1 comment ·
Maintainers usually reply within 1 day
-
area/storage area/storage/sql
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Apicurio/apicurio-registry#11159 ·
Maintainers usually reply within 1 day