feat: refactor observability configs for Compose and add for Local #351

JaredforReal · 2025-10-05T17:22:34Z

What type of PR is this?
feat: refactor observability configs for Compose and add for Local

What this PR does / why we need it:

Use Docker to set up Grafana and Prometheus for Local Installation, which is mostly the same as Docker Compose Deployment, so this PR merges them together like:

tools/observability/   # unified for local and compose
├── prometheus.yaml              
├── grafana-datasource.yaml
├── grafana-dashboard.yaml
├── llm-router-dashboard.json
├── README.md
└── scripts/
    ├── start-observability.sh
    └── stop-observability.sh

docker-compose.obs.yml           # Local
docker-compose.yml               # Compose（updated to use configs in tools/observability/）

Original configs for Grafana and Prometheus in config/ are no longer needed.
Update docs/tutorials/observability/observability.md.
Introduce new make commands for easy access.

Signed-off-by: JaredforReal <[email protected]>

netlify · 2025-10-05T17:22:39Z

✅ Deploy Preview for vllm-semantic-router ready!

Name	Link
🔨 Latest commit	`8438044`
🔍 Latest deploy log	https://app.netlify.com/projects/vllm-semantic-router/deploys/68e673f5a3c8a00007c81a97
😎 Deploy Preview	https://deploy-preview-351--vllm-semantic-router.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

github-actions · 2025-10-05T17:22:46Z

👥 vLLM Semantic Team Notification

The following members have been identified for the changed files in this PR and have been automatically assigned:

📁 `Root Directory`

Owners: @rootfs, @Xunzhuo
Files changed:

docker-compose.obs.yml
Makefile
docker-compose.yml

📁 `tools`

Owners: @yuluo-yx, @rootfs, @Xunzhuo
Files changed:

tools/make/observability.mk
tools/observability/README.md
tools/observability/grafana-dashboard.yaml
tools/observability/grafana-datasource.yaml
tools/observability/llm-router-dashboard.json
tools/observability/prometheus.yaml
tools/observability/scripts/start-observability.sh
tools/observability/scripts/stop-observability.sh
tools/make/common.mk

📁 `website`

Owners: @Xunzhuo
Files changed:

website/docs/tutorials/observability/observability.md

🎉 Thanks for your contributions!

This comment was automatically generated based on the OWNER files in the repository.

JaredforReal · 2025-10-05T17:23:14Z

Need further test, leave it as a draft.

Signed-off-by: JaredforReal <[email protected]>

JaredforReal · 2025-10-08T13:12:04Z

It's ready for review now! @Xunzhuo @rootfs

rootfs · 2025-10-08T13:27:23Z

tools/observability/scripts/start-observability.sh

+else
+    log_info "  - Check status: docker compose ps"
+    log_info "  - View logs: docker compose logs prometheus grafana -f"
+fi


would it be possible to add open-webui in a followup PR?

Yeah, all of these will be consolidated in the Modern Dashboard. Working on it

rootfs · 2025-10-08T13:28:40Z

tools/observability/scripts/stop-observability.sh

+    PROJECT_ROOT="$(git -C "$SCRIPT_DIR" rev-parse --show-toplevel)"
+else
+    # Fallback: three levels up from scripts -> repo root
+    PROJECT_ROOT="$(cd "$SCRIPT_DIR/../../../" && pwd)"


can you validate if the PROJECT_ROOT contains the tools directory?

checked, and it's good

rootfs · 2025-10-08T13:30:20Z

tools/make/common.mk

 	@echo ""
+	@echo "  Observability targets:"
+	@echo "    run-observability       - Start observability (alias for obs-local)"
+	@echo "    obs-local               - Start observability in LOCAL mode"


nit: obs-> o11y (obs could be confused with something else)

rootfs · 2025-10-08T13:32:38Z

@JaredforReal this is really helpful! Would you please record a demo and add the demo link to the docs too?

Copilot

Pull Request Overview

This PR refactors observability configurations to unify Docker Compose and Local deployment modes, consolidating Prometheus and Grafana configurations into a shared tools/observability/ directory.

Consolidates observability configs from config/ to unified tools/observability/ directory
Adds new local mode support with docker-compose.obs.yml for running router natively while observability runs in Docker
Introduces convenient make commands for easy observability stack management

Reviewed Changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
`tools/observability/`	New unified config directory with Prometheus, Grafana configs, dashboard JSON, and management scripts
`docker-compose.yml`	Updated to use new observability configs and added persistent volumes
`docker-compose.obs.yml`	New compose file for local mode (router on host, observability in Docker)
`tools/make/observability.mk`	New makefile with observability management targets
`website/docs/tutorials/observability/observability.md`	Comprehensive rewrite to document the new unified approach
`config/prometheus.yaml`, `config/grafana/`	Removed old config files replaced by unified structure

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

tools/observability/scripts/stop-observability.sh

tools/observability/scripts/start-observability.sh

website/docs/tutorials/observability/observability.md

tools/make/observability.mk

Signed-off-by: JaredforReal <[email protected]>

rootfs · 2025-10-08T14:22:31Z

@JaredforReal this is cool! looking forward to open-webui integration and demo links

Signed-off-by: JaredforReal <[email protected]>

JaredforReal · 2025-10-08T14:26:52Z

I think it's ready to be merged now! Thanks for your time! @rootfs

refactor obser for Compose and add for Local

3c57f9b

Signed-off-by: JaredforReal <[email protected]>

github-actions bot assigned rootfs and Xunzhuo Oct 5, 2025

JaredforReal changed the title ~~feat: refactored observability configs for Compose and added for Local~~ feat: refactor observability configs for Compose and add for Local Oct 5, 2025

JaredforReal added 2 commits October 8, 2025 20:57

fix docker-compose.obs path error

f3cd278

Signed-off-by: JaredforReal <[email protected]>

get rig of network config

1f093de

Signed-off-by: JaredforReal <[email protected]>

JaredforReal marked this pull request as ready for review October 8, 2025 13:11

JaredforReal requested review from rootfs and Xunzhuo as code owners October 8, 2025 13:11

Merge branch 'main' into local-obs

8427f58

rootfs reviewed Oct 8, 2025

View reviewed changes

rootfs requested a review from Copilot October 8, 2025 13:31

Copilot AI reviewed Oct 8, 2025

View reviewed changes

JaredforReal and others added 2 commits October 8, 2025 22:01

Renamed observability to o11y-* with backward-compatible obs-* aliases

567d64b

Signed-off-by: JaredforReal <[email protected]>

Merge branch 'main' into local-obs

6508996

rootfs previously approved these changes Oct 8, 2025

View reviewed changes

refine docs, shell, and makefile

8438044

Signed-off-by: JaredforReal <[email protected]>

JaredforReal dismissed rootfs’s stale review via 8438044 October 8, 2025 14:23

rootfs merged commit 565c7ab into vllm-project:main Oct 8, 2025
9 checks passed

JaredforReal deleted the local-obs branch October 8, 2025 14:29

feat: refactor observability configs for Compose and add for Local #351

feat: refactor observability configs for Compose and add for Local #351

Uh oh!

Conversation

JaredforReal commented Oct 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Oct 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for vllm-semantic-router ready!

Uh oh!

github-actions bot commented Oct 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

👥 vLLM Semantic Team Notification

📁 Root Directory

📁 tools

📁 website

🎉 Thanks for your contributions!

Uh oh!

JaredforReal commented Oct 5, 2025

Uh oh!

JaredforReal commented Oct 8, 2025

Uh oh!

rootfs Oct 8, 2025

Choose a reason for hiding this comment

Uh oh!

JaredforReal Oct 8, 2025

Choose a reason for hiding this comment

Uh oh!

rootfs Oct 8, 2025

Choose a reason for hiding this comment

Uh oh!

JaredforReal Oct 8, 2025

Choose a reason for hiding this comment

Uh oh!

rootfs Oct 8, 2025

Choose a reason for hiding this comment

Uh oh!

JaredforReal Oct 8, 2025

Choose a reason for hiding this comment

Uh oh!

rootfs commented Oct 8, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rootfs commented Oct 8, 2025

Uh oh!

JaredforReal commented Oct 8, 2025

Uh oh!

Uh oh!

Uh oh!

JaredforReal commented Oct 5, 2025 •

edited

Loading

netlify bot commented Oct 5, 2025 •

edited

Loading

github-actions bot commented Oct 5, 2025 •

edited

Loading

📁 `Root Directory`

📁 `tools`

📁 `website`