apunkt/plano
1
0
Fork 0
mirror of https://github.com/katanemo/plano.git synced 2026-04-25 00:36:34 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Update monitoring docs to reflect one-command Grafana stack

Browse source
This commit is contained in:
adilhafeez 2026-04-21 16:31:01 -07:00
parent 3cd5ba8536
commit da09c2cbed
1 changed files with 26 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

32
docs/source/guides/observability/monitoring.rst
View file

@ -99,10 +99,30 @@ with ``METRICS_BIND_ADDRESS``). It publishes:
* Process & build — ``process_resident_memory_bytes``,
``process_cpu_seconds_total``, ``brightstaff_build_info``.
A drop-in Prometheus scrape config and a Grafana dashboard JSON are
shipped under ``config/grafana/``:
A self-contained Prometheus + Grafana stack is shipped under
``config/grafana/``. With Plano already running on the host, bring it up
with one command:
* ``config/grafana/prometheus_scrape.yaml`` — adds ``envoy`` and
``brightstaff`` scrape jobs.
* ``config/grafana/brightstaff_dashboard.json`` — import via *Dashboards →
New → Import* in Grafana; pick your Prometheus datasource when prompted.
.. code-block:: bash
cd config/grafana
docker compose up -d
open http://localhost:3000 # admin / admin (anonymous viewer also enabled)
Grafana auto-loads the Prometheus datasource and the brightstaff
dashboard (look under the *Plano* folder). Prometheus scrapes the host's
``:9092`` and ``:9901`` via ``host.docker.internal``.
Files:
* ``config/grafana/docker-compose.yaml`` — one-command Prom + Grafana
stack with provisioning.
* ``config/grafana/prometheus_scrape.yaml`` — complete Prometheus config
with ``envoy`` and ``brightstaff`` scrape jobs (mounted by the
compose).
* ``config/grafana/brightstaff_dashboard.json`` — 19-panel dashboard
across HTTP RED, LLM upstream, Routing service, and Process & Envoy
link rows. Auto-provisioned by the compose; can also be imported by
hand via *Dashboards → New → Import*.
* ``config/grafana/provisioning/`` — Grafana provisioning files for the
datasource and dashboard provider.