Skip to content

feat: open telemetry user metrics#15794

Merged
tjbck merged 1 commit intoopen-webui:devfrom
expruc:feat/otel_user_metrics
Jul 18, 2025
Merged

feat: open telemetry user metrics#15794
tjbck merged 1 commit intoopen-webui:devfrom
expruc:feat/otel_user_metrics

Conversation

@expruc
Copy link
Contributor

@expruc expruc commented Jul 16, 2025

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 2 new users metrics: number of active users, and number of registered users

Added

  • webui.users.active - measures the number of users with an active session
  • webui.users.total - counter for the number of total registered users

Additional Information

Active users observer is retrieved from the get_active_user_ids function on the socket main handler file (from which also the UI counter of active users takes it's counter), while the total number of users is retrieved directly from the DB. Self tested and observed the new metrics on prometheus.

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.

@tjbck
Copy link
Contributor

tjbck commented Jul 17, 2025

qq: is this tested? could you provide grafana ss?

@expruc
Copy link
Contributor Author

expruc commented Jul 18, 2025

Yes, I have tested this:

image

Registered a new user (total registered gone up from 2 to 3), and when new user closed the window active users decreased to 1

@tjbck
Copy link
Contributor

tjbck commented Jul 18, 2025

Amazing, Thanks!

@tjbck tjbck merged commit a395abd into open-webui:dev Jul 18, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants