hanahmily opened a new pull request, #1159: URL: https://github.com/apache/skywalking-banyandb/pull/1159
### Refresh observability docs & Grafana dashboard for FODC-proxy scraping In the cluster deployment, Prometheus now scrapes the **FODC proxy** `/metrics` endpoint as the single target instead of scraping each BanyanDB pod directly. Under proxy scraping, per-node identity is carried in the `pod_name` / `container_name` sample labels (the proxy aggregates every agent's metrics), so the old `job`/`pod`/`up` target-label scheme no longer distinguishes nodes. This PR updates the dashboard and observability docs accordingly, and fixes several stale/incorrect descriptions found while auditing. This is a documentation + dashboard-artifact change only — no Go code is modified. #### What's included - **New dashboard `docs/operation/grafana-cluster-fodc.json`** built for FODC-proxy scraping: role-oriented layout (liaison / data) with fleet overview, per-node health table, resources, disk-by-path, liaison ingestion/query/publish + write-queue (wqueue) backlog, data storage/inverted-index/internal-queue, and Go runtime sections. All PromQL was validated against a live cluster Prometheus. The stale direct-scrape `grafana-cluster.json` is removed. - **Observability docs audit & refresh**: corrected prose/PromQL to match the current code, emphasized that metrics are fetched from the FODC proxy (with the recommended scrape config), replaced the out-of-date `self-observability-write.png` (etcd removed) with an inline mermaid write-flow diagram, and added a top-of-doc "Key Signals to Watch" section. - **Doc restructure**: split the oversized `observability.md` into an `observability/` folder — `overview`, `logging`, `metrics`, `providers`, `profiling`, `tracing` — with `menu.yml` and inbound cross-links updated. - **FODC overview API reconciliation**: the overview doc described proxy HTTP endpoints that didn't match `fodc/proxy/internal/api/server.go`. Corrected the `/metrics` (aggregated per-node Prometheus text, not proxy-only metrics) and `/metrics-windows` (JSON, windowed) descriptions, fixed `GET /cluster` → `GET /cluster/topology`, and replaced the non-existent `GET /cluster/config` with the real `GET /cluster/lifecycle` and `GET /diagnostics`. The endpoint surface now matches the six routes in `server.go` and `apis.md`. - [x] Update the [`CHANGES` log](https://github.com/apache/skywalking-banyandb/blob/main/CHANGES.md). -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
