[PR #1273] [MERGED] docs: make Grafana OTEL quick start runnable #1255

New issue

Closed

opened 2026-10-18 14:18:21 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-18 14:18:21 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/docs/pull/1273
Author: @xuyua9
Created: 5/31/2026
Status: ✅ Merged
Merged: 5/31/2026
Merged by: @Classic298

Base: dev ← Head: devb/grafana-otel-compose

📝 Commits (1)

54cef99 docs: make Grafana OTEL quick start runnable

📊 Changes

2 files changed (+62 additions, -13 deletions)

View changed files

📝 docs/reference/monitoring/otel.md (+23 -13)
➕ static/docker-compose.otel.yaml (+39 -0)

📄 Description

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 https://github.com/open-webui/docs/issues/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.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/docs/pull/1273 **Author:** [@xuyua9](https://github.com/xuyua9) **Created:** 5/31/2026 **Status:** ✅ Merged **Merged:** 5/31/2026 **Merged by:** [@Classic298](https://github.com/Classic298) **Base:** `dev` ← **Head:** `devb/grafana-otel-compose` --- ### 📝 Commits (1) - [`54cef99`](https://github.com/open-webui/docs/commit/54cef995071ddb4ddf3beea8b87ca0fdb64dcfb7) docs: make Grafana OTEL quick start runnable ### 📊 Changes **2 files changed** (+62 additions, -13 deletions) <details> <summary>View changed files</summary> 📝 `docs/reference/monitoring/otel.md` (+23 -13) ➕ `static/docker-compose.otel.yaml` (+39 -0) </details> ### 📄 Description ## 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 https://github.com/open-webui/docs/issues/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)](https://github.com/open-webui/open-webui/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-18 14:18:21 +00:00