[PR #16222] [MERGED] feat: separate otel metrics configuration #62929

New Issue

GiteaMirror · 2026-05-06T07:24:51-05:00

GiteaMirror commented

2026-05-06 07:24:51 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/16222
Author: @expruc
Created: 8/2/2025
Status: ✅ Merged
Merged: 8/2/2025
Merged by: @tjbck

Base: dev ← Head: feat/seperate_otel_metrics_config

📝 Commits (1)

a679fb3 split otel metrics from general otel configuration

📊 Changes

3 files changed (+66 additions, -20 deletions)

View changed files

📝 backend/open_webui/env.py (+17 -0)
📝 backend/open_webui/utils/telemetry/metrics.py (+46 -14)
📝 backend/open_webui/utils/telemetry/setup.py (+3 -6)

📄 Description

Pull Request Checklist

Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.

Before submitting, make sure you've checked the following:

Target branch: Please verify that the pull request targets the dev branch.
Description: Provide a concise description of the changes made in this pull request.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: Have you updated relevant documentation Open WebUI Docs, or other documentation sources?
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
Testing: Have you written and run sufficient tests to validate the changes?
Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
Prefix: To clearly categorize this pull request, prefix the pull request title using one of the following:
- BREAKING CHANGE: Significant changes that may affect compatibility
- build: Changes that affect the build system or external dependencies
- ci: Changes to our continuous integration processes or workflows
- chore: Refactor, cleanup, or other non-functional code changes
- docs: Documentation update or addition
- feat: Introduces a new feature or enhancement to the codebase
- fix: Bug fix or error correction
- i18n: Internationalization or localization changes
- perf: Performance improvement
- refactor: Code restructuring for better maintainability, readability, or scalability
- style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
- test: Adding missing tests or correcting existing tests
- WIP: Work in progress, a temporary label for incomplete or ongoing work

Changelog Entry

Description

This PR adds couple of configuration specific for open telemetry metrics configuration in order to distinguish them from the general otel configuration. This is handy especially in cases where separate endpoint for traces and metrics are used. One example is if lgtm stack is used, and the span exporter is http, where the endpoint for traces is http://grafana:4318/v1/traces and the metrics endpoint is http://grafana:4318/v1/metrics.
Also, this PR adds http metrics exporter (alongside with the existing grpc one), and handles metrics exporter authentication.
This should also resolve #16183.

Added

New configuration/environment variables:

OTEL_METRICS_EXPORTER_OTLP_ENDPOINT - otel metrics exporter endpoint, defaults to the OTEL_EXPORTER_OTLP_ENDPOINT one if not specified
OTEL_METRICS_BASIC_AUTH_USERNAME and OTEL_METRICS_BASIC_AUTH_PASSWORD - basic credentials for authentication handling in metrics endpoint. Defaults to the traces credentials.
OTEL_METRICS_OTLP_SPAN_EXPORTER - the span method for the metrics exporter (http/grpc). Defaults to the traces span exporter method
OTEL_METRICS_EXPORTER_OTLP_INSECURE - whether the exporter should be insecure or not. Defaults to False like the traces one.

Changed

Moved resource definition to the otel setup.py to avoid code duplication.

Fixed

Metrics exporter worked only in grpc mode, not in http
Users couldn't separate endpoints for metrics and traces
Users couldn't use authentication on metrics

Additional Information

If this PR is approved I will create a docs PR.

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/open-webui/pull/16222 **Author:** [@expruc](https://github.com/expruc) **Created:** 8/2/2025 **Status:** ✅ Merged **Merged:** 8/2/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `feat/seperate_otel_metrics_config` --- ### 📝 Commits (1) - [`a679fb3`](https://github.com/open-webui/open-webui/commit/a679fb3f456dca47fa374186c78d45f34a21032d) split otel metrics from general otel configuration ### 📊 Changes **3 files changed** (+66 additions, -20 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/env.py` (+17 -0) 📝 `backend/open_webui/utils/telemetry/metrics.py` (+46 -14) 📝 `backend/open_webui/utils/telemetry/setup.py` (+3 -6) </details> ### 📄 Description # Pull Request Checklist ### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) and describe your changes before submitting a pull request. **Before submitting, make sure you've checked the following:** - [x] **Target branch:** Please verify that the pull request targets the `dev` branch. - [x] **Description:** Provide a concise description of the changes made in this pull request. - [x] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description. - [ ] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources? - [x] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? - [x] **Testing:** Have you written and run sufficient tests to validate the changes? - [x] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards? - [x] **Prefix:** To clearly categorize this pull request, prefix the pull request title using one of the following: - **BREAKING CHANGE**: Significant changes that may affect compatibility - **build**: Changes that affect the build system or external dependencies - **ci**: Changes to our continuous integration processes or workflows - **chore**: Refactor, cleanup, or other non-functional code changes - **docs**: Documentation update or addition - **feat**: Introduces a new feature or enhancement to the codebase - **fix**: Bug fix or error correction - **i18n**: Internationalization or localization changes - **perf**: Performance improvement - **refactor**: Code restructuring for better maintainability, readability, or scalability - **style**: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.) - **test**: Adding missing tests or correcting existing tests - **WIP**: Work in progress, a temporary label for incomplete or ongoing work # Changelog Entry ### Description This PR adds couple of configuration specific for open telemetry metrics configuration in order to distinguish them from the general otel configuration. This is handy especially in cases where separate endpoint for traces and metrics are used. One example is if lgtm stack is used, and the span exporter is http, where the endpoint for traces is `http://grafana:4318/v1/traces` and the metrics endpoint is `http://grafana:4318/v1/metrics`. Also, this PR adds http metrics exporter (alongside with the existing grpc one), and handles metrics exporter authentication. This should also resolve #16183. ### Added **New configuration/environment variables**: - `OTEL_METRICS_EXPORTER_OTLP_ENDPOINT` - otel metrics exporter endpoint, defaults to the `OTEL_EXPORTER_OTLP_ENDPOINT` one if not specified - `OTEL_METRICS_BASIC_AUTH_USERNAME` and `OTEL_METRICS_BASIC_AUTH_PASSWORD` - basic credentials for authentication handling in metrics endpoint. Defaults to the traces credentials. - `OTEL_METRICS_OTLP_SPAN_EXPORTER` - the span method for the metrics exporter (http/grpc). Defaults to the traces span exporter method - `OTEL_METRICS_EXPORTER_OTLP_INSECURE` - whether the exporter should be insecure or not. Defaults to `False` like the traces one. ### Changed Moved `resource` definition to the otel `setup.py` to avoid code duplication. ### Fixed - Metrics exporter worked only in grpc mode, not in http - Users couldn't separate endpoints for metrics and traces - Users couldn't use authentication on metrics --- ### Additional Information If this PR is approved I will create a docs PR. ### Contributor License Agreement By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](/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>

GiteaMirror added the pull-request label 2026-05-06 07:24:51 -05:00

GiteaMirror closed this issue

2026-05-06 07:24:53 -05:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/open-webui#62929