[PR #1365] Add Arize AX collector guidance to OpenTelemetry docs #1333

New issue

Open

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

bsakaguchi commented

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

Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/docs/pull/1365
Author: @arizedatngo
Created: 8/31/2026
Status: 🔄 Open

Base: main ← Head: add-arize-ax-otel-guidance

📝 Commits (2)

581815f Add Arize AX OpenTelemetry collector guidance
52e67ef Merge remote-tracking branch 'upstream/main' into add-arize-ax-otel-guidance

📊 Changes

1 file changed (+40 additions, -0 deletions)

View changed files

📝 docs/reference/monitoring/otel.md (+40 -0)

📄 Description

Summary

Document how to forward Open WebUI's built-in OpenTelemetry traces through a collector when an OTLP backend requires custom authentication headers.
Use Arize AX as a concrete example because it requires space_id and api_key exporter headers that Open WebUI cannot configure directly.
Clarify that this path exports backend service telemetry; rich prompt, response, token, and tool-call traces require separate instrumentation on the model-provider or Pipeline path.

This benefits self-hosted Open WebUI operators who already use the documented OTLP export but cannot connect directly to a backend requiring non-basic-auth headers. The collector pattern is reusable for other OTLP backends with custom-header requirements.

No linked issue. This extends the existing Custom Collector Setup and Authentication required? sections of the OpenTelemetry reference.

Checklist

I have reviewed the relevant documentation and matched the existing style.
This PR meets Open WebUI's contribution standards: it is accurate, relevant to users, narrowly scoped, maintainable, and not promotional content, advertising, lead generation, SEO placement, or a request to list a product, service, provider, integration, gateway, tool, or company primarily for visibility.
I understand that PRs that do not meet these standards may be closed without review and will not be merged. Repeated, low-quality, off-topic, promotional, or intentionally misleading submissions may result in the contributor being blocked from future participation in Open WebUI repositories.

Notes for reviewers

Rebased through a normal merge with current main; the content change remains confined to docs/reference/monitoring/otel.md.
The collector configuration matches Open WebUI's current OTLP/gRPC setup and uses an otlphttp exporter to add backend-specific headers.
npx prettier@3.3.3 docs/reference/monitoring/otel.md --check passes.
git diff --check passes.

_{🔄 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/1365 **Author:** [@arizedatngo](https://github.com/arizedatngo) **Created:** 8/31/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `add-arize-ax-otel-guidance` --- ### 📝 Commits (2) - [`581815f`](https://github.com/open-webui/docs/commit/581815f2a61ce0c58b0cd4122d866aa01940a462) Add Arize AX OpenTelemetry collector guidance - [`52e67ef`](https://github.com/open-webui/docs/commit/52e67ef4c600bb8e6e37f92c20d8ae1065457da2) Merge remote-tracking branch 'upstream/main' into add-arize-ax-otel-guidance ### 📊 Changes **1 file changed** (+40 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `docs/reference/monitoring/otel.md` (+40 -0) </details> ### 📄 Description ## Summary - Document how to forward Open WebUI's built-in OpenTelemetry traces through a collector when an OTLP backend requires custom authentication headers. - Use Arize AX as a concrete example because it requires `space_id` and `api_key` exporter headers that Open WebUI cannot configure directly. - Clarify that this path exports backend service telemetry; rich prompt, response, token, and tool-call traces require separate instrumentation on the model-provider or Pipeline path. This benefits self-hosted Open WebUI operators who already use the documented OTLP export but cannot connect directly to a backend requiring non-basic-auth headers. The collector pattern is reusable for other OTLP backends with custom-header requirements. ## Related issue or discussion No linked issue. This extends the existing **Custom Collector Setup** and **Authentication required?** sections of the OpenTelemetry reference. ## Checklist - [x] I have reviewed the relevant documentation and matched the existing style. - [x] This PR meets Open WebUI's contribution standards: it is accurate, relevant to users, narrowly scoped, maintainable, and not promotional content, advertising, lead generation, SEO placement, or a request to list a product, service, provider, integration, gateway, tool, or company primarily for visibility. - [x] I understand that PRs that do not meet these standards may be closed without review and will not be merged. Repeated, low-quality, off-topic, promotional, or intentionally misleading submissions may result in the contributor being blocked from future participation in Open WebUI repositories. ## Notes for reviewers - Rebased through a normal merge with current `main`; the content change remains confined to `docs/reference/monitoring/otel.md`. - The collector configuration matches Open WebUI's current OTLP/gRPC setup and uses an `otlphttp` exporter to add backend-specific headers. - `npx prettier@3.3.3 docs/reference/monitoring/otel.md --check` passes. - `git diff --check` passes. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi added the

pull-request

label

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