Skip to content

docs: make Grafana OTEL quick start runnable#1273

Merged
Classic298 merged 1 commit into
open-webui:devfrom
xuyua9:devb/grafana-otel-compose
May 31, 2026
Merged

docs: make Grafana OTEL quick start runnable#1273
Classic298 merged 1 commit into
open-webui:devfrom
xuyua9:devb/grafana-otel-compose

Conversation

@xuyua9
Copy link
Copy Markdown
Contributor

@xuyua9 xuyua9 commented May 31, 2026

Summary

  • Add a downloadable docker-compose.otel.yaml example for the OpenTelemetry monitoring quick start.
  • Update the Grafana LGTM quick-start steps so the documented Compose command has a real file and concrete Open WebUI/Grafana URLs.
  • Align the example OTLP endpoints and troubleshooting container name with the Compose service names.

Context

The existing OpenTelemetry guide tells readers to run docker compose -f docker-compose.otel.yaml up -d, but the docs site did not include that file. This makes the quick start difficult to follow for users trying to monitor Open WebUI with Grafana.

Supports #657.

Validation

  • npx prettier --check docs/reference/monitoring/otel.md static/docker-compose.otel.yaml
  • npm run build (passes; Docusaurus still reports an unrelated pre-existing broken anchor on /features/extensibility/plugin/functions/filter)

Contributor License Agreement
By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), and I am providing my contributions under its terms.

@Classic298 Classic298 changed the base branch from main to dev May 31, 2026 21:58
@Classic298
Copy link
Copy Markdown
Collaborator

lgtm thanks

@Classic298 Classic298 merged commit c0fd8e0 into open-webui:dev May 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants