[PR #24046] [CLOSED] fix(telemetry): run OTEL metric callbacks synchronously #98529

New Issue

GiteaMirror · 2026-05-16T01:20:19-05:00

GiteaMirror commented

2026-05-16 01:20:19 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/24046
Author: @franciseliang99-dot
Created: 4/23/2026
Status: ❌ Closed

Base: dev ← Head: fix/otel-metrics-sync-callbacks

📝 Commits (1)

fe8fcf3 fix(telemetry): run OTEL metric callbacks synchronously

📊 Changes

2 files changed (+35 additions, -8 deletions)

View changed files

📝 backend/open_webui/models/users.py (+23 -1)
📝 backend/open_webui/utils/telemetry/metrics.py (+12 -7)

📄 Description

OTEL observable-gauge callbacks run on the PeriodicExportingMetricReader thread, which has no event loop. The three async callbacks in utils/telemetry/metrics.py (observe_active_users, observe_total_registered_users, observe_users_active_today) returned coroutines instead of iterables of Observation, causing TypeError: 'coroutine' object is not iterable on every export cycle.

This PR:

Adds sync COUNT(*) variants on UsersTable (get_num_users_sync, get_active_user_count_sync, get_num_users_active_today_sync) using the existing sync SessionLocal from open_webui/internal/db.py.
Converts the three OTEL callbacks back to plain def and points them at the new sync methods.

Sync SessionLocal is documented in db.py as "used ONLY for startup config loading"; OTEL metric callbacks are the one legitimate runtime exception because OTel's PeriodicExportingMetricReader runs them on a worker thread outside any event loop. Option 2 (asyncio.run_coroutine_threadsafe against the captured main loop) was considered but would require a lifespan hook plus cross-thread scheduling per export, with no runtime advantage for metrics polled every ~30s.

Closes #23936
Closes #23938

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.

Note

Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in.

_{🔄 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/24046 **Author:** [@franciseliang99-dot](https://github.com/franciseliang99-dot) **Created:** 4/23/2026 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `fix/otel-metrics-sync-callbacks` --- ### 📝 Commits (1) - [`fe8fcf3`](https://github.com/open-webui/open-webui/commit/fe8fcf313569ffc43fd8d1274f09a5d285a328e2) fix(telemetry): run OTEL metric callbacks synchronously ### 📊 Changes **2 files changed** (+35 additions, -8 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/models/users.py` (+23 -1) 📝 `backend/open_webui/utils/telemetry/metrics.py` (+12 -7) </details> ### 📄 Description OTEL observable-gauge callbacks run on the `PeriodicExportingMetricReader` thread, which has no event loop. The three async callbacks in `utils/telemetry/metrics.py` (`observe_active_users`, `observe_total_registered_users`, `observe_users_active_today`) returned coroutines instead of iterables of `Observation`, causing `TypeError: 'coroutine' object is not iterable` on every export cycle. This PR: - Adds sync `COUNT(*)` variants on `UsersTable` (`get_num_users_sync`, `get_active_user_count_sync`, `get_num_users_active_today_sync`) using the existing sync `SessionLocal` from `open_webui/internal/db.py`. - Converts the three OTEL callbacks back to plain `def` and points them at the new sync methods. Sync `SessionLocal` is documented in `db.py` as "used ONLY for startup config loading"; OTEL metric callbacks are the one legitimate runtime exception because OTel's `PeriodicExportingMetricReader` runs them on a worker thread outside any event loop. Option 2 (`asyncio.run_coroutine_threadsafe` against the captured main loop) was considered but would require a lifespan hook plus cross-thread scheduling per export, with no runtime advantage for metrics polled every ~30s. Closes #23936 Closes #23938 ### Contributor License Agreement  - [X] 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. > [!NOTE] > Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in. --- <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-16 01:20:19 -05:00

GiteaMirror closed this issue

2026-05-16 01:20:21 -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#98529