[PR #16192] [MERGED] feat: otel logger handler #62913

New Issue

GiteaMirror · 2026-05-06T07:23:31-05:00

GiteaMirror commented

2026-05-06 07:23:31 -05:00

📋 Pull Request Information

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

Base: dev ← Head: feat/otel-logger-handler

📝 Commits (2)

2035eab added otel logging handler
49926f0 Merge branch 'dev' into feat/otel-logger-handler

📊 Changes

3 files changed (+59 additions, -3 deletions)

View changed files

📝 backend/open_webui/env.py (+1 -0)
📝 backend/open_webui/utils/logger.py (+5 -3)
➕ backend/open_webui/utils/telemetry/logs.py (+53 -0)

📄 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

Added an integration to otel logging handler as part of the default handler for the loguru logger.

Added

The application default python logger now sends logs the otel endpoint if enabled. This was added as a part of the default logger handler.
New environment variable ENABLE_OTEL_LOGS which controls the activation of the logging handler.

Additional Information

Note about implementation: this PR changes the way otel logs are handled, compared to metrics/traces which are handled through the setup function. The reason for this, is setting this up using the otel setup function would require patching the loggers on runtime (after the application has started), which seemed to cause problems especially with the uvicorn logger.

Also, the otel handler is added only if both ENABLE_OTEL and ENABLE_OTEL_LOGS are enabled, to comply with the way otel metrics are enabled.

Documentation: if this PR will be approved I will create a separate PR for the docs.

Screenshots or Videos

Snippet from grafana showing the application logs

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/16192 **Author:** [@expruc](https://github.com/expruc) **Created:** 7/31/2025 **Status:** ✅ Merged **Merged:** 8/2/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `feat/otel-logger-handler` --- ### 📝 Commits (2) - [`2035eab`](https://github.com/open-webui/open-webui/commit/2035eabb1f2ede3f1cdf261ce092e19df201dad7) added otel logging handler - [`49926f0`](https://github.com/open-webui/open-webui/commit/49926f06ee9cf5564c342898dea8f31922faa756) Merge branch 'dev' into feat/otel-logger-handler ### 📊 Changes **3 files changed** (+59 additions, -3 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/env.py` (+1 -0) 📝 `backend/open_webui/utils/logger.py` (+5 -3) ➕ `backend/open_webui/utils/telemetry/logs.py` (+53 -0) </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 Added an integration to otel logging handler as part of the default handler for the loguru logger. ### Added - The application default python logger now sends logs the otel endpoint if enabled. This was added as a part of the default logger handler. - New environment variable `ENABLE_OTEL_LOGS` which controls the activation of the logging handler. --- ### Additional Information **Note about implementation**: this PR changes the way otel logs are handled, compared to metrics/traces which are handled through the `setup` function. The reason for this, is setting this up using the otel `setup` function would require patching the loggers on runtime (after the application has started), which seemed to cause problems especially with the uvicorn logger. Also, the otel handler is added only if both `ENABLE_OTEL` and `ENABLE_OTEL_LOGS` are enabled, to comply with the way otel metrics are enabled. **Documentation**: if this PR will be approved I will create a separate PR for the docs. ### Screenshots or Videos Snippet from grafana showing the application logs <img width="1899" height="863" alt="image" src="https://github.com/user-attachments/assets/91431d1d-3f6a-4a7e-b1e6-22a3dd308bfc" /> ### 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:23:32 -05:00

GiteaMirror closed this issue

2026-05-06 07:23:38 -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#62913