You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by "hanahmily (via GitHub)" <gi...@apache.org> on 2026/06/05 11:29:28 UTC
[PR] Refresh observability docs and add FODC-proxy Grafana dashboard [skywalking-banyandb]
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: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Refresh observability docs and add FODC-proxy Grafana dashboards [skywalking-banyandb]
Posted by "hanahmily (via GitHub)" <gi...@apache.org>.
hanahmily merged PR #1159:
URL: https://github.com/apache/skywalking-banyandb/pull/1159
--
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: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Refresh observability docs and add FODC-proxy Grafana dashboard [skywalking-banyandb]
Posted by "codecov-commenter (via GitHub)" <gi...@apache.org>.
codecov-commenter commented on PR #1159:
URL: https://github.com/apache/skywalking-banyandb/pull/1159#issuecomment-4631251834
## [Codecov](https://app.codecov.io/gh/apache/skywalking-banyandb/pull/1159?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
:white_check_mark: All modified and coverable lines are covered by tests.
:white_check_mark: Project coverage is 41.14%. Comparing base ([`3530dd9`](https://app.codecov.io/gh/apache/skywalking-banyandb/commit/3530dd9b5cefaa4fef60eec91ecbfbdfcaf243c5?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)) to head ([`a25a175`](https://app.codecov.io/gh/apache/skywalking-banyandb/commit/a25a175432b8e61bf33c2a6eb8c7dfd996b78065?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)).
:warning: Report is 279 commits behind head on main.
<details><summary>Additional details and impacted files</summary>
```diff
@@ Coverage Diff @@
## main #1159 +/- ##
==========================================
- Coverage 45.97% 41.14% -4.83%
==========================================
Files 328 196 -132
Lines 55505 20380 -35125
==========================================
- Hits 25520 8386 -17134
+ Misses 27909 11144 -16765
+ Partials 2076 850 -1226
```
| [Flag](https://app.codecov.io/gh/apache/skywalking-banyandb/pull/1159/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | Coverage Δ | |
|---|---|---|
| [pkg](https://app.codecov.io/gh/apache/skywalking-banyandb/pull/1159/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `41.14% <ø> (?)` | |
Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#carryforward-flags-in-the-pull-request-comment) to find out more.
</details>
[:umbrella: View full report in Codecov by Harness](https://app.codecov.io/gh/apache/skywalking-banyandb/pull/1159?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
:loudspeaker: Have feedback on the report? [Share it here](https://about.codecov.io/codecov-pr-comment-feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
<details><summary> :rocket: New features to boost your workflow: </summary>
- :snowflake: [Test Analytics](https://docs.codecov.com/docs/test-analytics): Detect flaky tests, report on failures, and find test suite problems.
- :package: [JS Bundle Analysis](https://docs.codecov.com/docs/javascript-bundle-analysis): Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
</details>
--
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: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org