github-starred/open-webui
2
0
Fork 0
mirror of https://github.com/open-webui/open-webui.git synced 2026-05-09 21:38:47 -05:00
Code Issues 1.3k Packages Projects Releases 126 Wiki Activity

[PR #20114] [CLOSED] feat: Add audit logs optionally to stdout #64327

New Issue
Closed
opened 2026-05-06 09:50:15 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-05-06 09:50:15 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/20114
Author: @bryanherman
Created: 12/22/2025
Status: ❌ Closed

Base: dev ← Head: add-audit-logs-to-stdout

📝 Commits (2)

  • ea0ce73 feat: add audit logging configuration for stdout and file
  • 5c7f1db test: add unit tests for audit logging configuration with stdout and file

📊 Changes

3 files changed (+280 additions, -13 deletions)

View changed files

📝 backend/open_webui/env.py (+6 -0)
➕ backend/open_webui/test/utils/test_logger.py (+250 -0)
📝 backend/open_webui/utils/logger.py (+24 -13)

📄 Description

Pull Request Checklist

Note to first-time contributors: Please open a discussion post in Discussions to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request.

Discussion at: https://github.com/open-webui/open-webui/discussions/20112

This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR.

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

  • Target branch: Verify that the pull request targets the dev branch. Not targeting the dev branch will lead to immediate closure of the PR.
  • Description: Provide a concise description of the changes made in this pull request down below.
  • Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
  • Documentation: If necessary, update relevant documentation Open WebUI Docs like environment variables, the tutorials, or other documentation sources. PR here: https://github.com/open-webui/docs/pull/919
  • Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
  • Testing: Perform manual tests to verify the implemented fix/feature works as intended AND does not break any other functionality. Take this as an opportunity to make screenshots of the feature/fix and include it in the PR description.
  • Agentic AI Code: Confirm this Pull Request is not written by any AI Agent or has at least gone through additional human review AND manual testing. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR.
  • 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?
  • Title 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 pull request introduces configurable audit logging options, allowing audit logs to be selectively enabled for stdout and/or file output using environment variables. It also adds tests to ensure these configurations work as expected.

Added

  • Added AUDIT_ENABLE_STDOUT and AUDIT_ENABLE_FILE environment variables in env.py to control whether audit logs are output to stdout and/or file, with sensible defaults (False for stdout, True for file).
  • Added a comprehensive test suite (test_logger.py) that covers all combinations of the new audit logging environment variables, ensuring correct parsing and logger behavior under various configurations.

Changed

  • Updated start_logger in logger.py to use these new variables, allowing fine-grained control over audit log destinations and ensuring audit logs are only output to enabled targets.

Deprecated

N/A

Removed

N/A

Fixed

  • Parameter description in start_logger in logger.py.

Security

N/A

Breaking Changes

N/A new config variables provide backward compatible behavior.

Additional Information

N/A

Screenshots or Videos

N/A

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/20114 **Author:** [@bryanherman](https://github.com/bryanherman) **Created:** 12/22/2025 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `add-audit-logs-to-stdout` --- ### 📝 Commits (2) - [`ea0ce73`](https://github.com/open-webui/open-webui/commit/ea0ce737797acf07bf0180a06f0243dc3c0dede0) feat: add audit logging configuration for stdout and file - [`5c7f1db`](https://github.com/open-webui/open-webui/commit/5c7f1db0eddf7ad60aef676254d3983c2d089c5d) test: add unit tests for audit logging configuration with stdout and file ### 📊 Changes **3 files changed** (+280 additions, -13 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/env.py` (+6 -0) ➕ `backend/open_webui/test/utils/test_logger.py` (+250 -0) 📝 `backend/open_webui/utils/logger.py` (+24 -13) </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) to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request. Discussion at: https://github.com/open-webui/open-webui/discussions/20112 This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR. **Before submitting, make sure you've checked the following:** - [x] **Target branch:** Verify that the pull request targets the `dev` branch. **Not targeting the `dev` branch will lead to immediate closure of the PR.** - [x] **Description:** Provide a concise description of the changes made in this pull request down below. - [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. - [x] **Documentation:** If necessary, update relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs) like environment variables, the tutorials, or other documentation sources. PR here: https://github.com/open-webui/docs/pull/919 - [x] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? - [x] **Testing:** Perform manual tests to **verify the implemented fix/feature works as intended AND does not break any other functionality**. Take this as an opportunity to **make screenshots of the feature/fix and include it in the PR description**. - [x] **Agentic AI Code:** Confirm this Pull Request is **not written by any AI Agent** or has at least **gone through additional human review AND manual testing**. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR. - [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] **Title 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 pull request introduces configurable audit logging options, allowing audit logs to be selectively enabled for stdout and/or file output using environment variables. It also adds tests to ensure these configurations work as expected. ### Added - Added `AUDIT_ENABLE_STDOUT` and `AUDIT_ENABLE_FILE` environment variables in `env.py` to control whether audit logs are output to stdout and/or file, with sensible defaults (`False` for stdout, `True` for file). - Added a comprehensive test suite (`test_logger.py`) that covers all combinations of the new audit logging environment variables, ensuring correct parsing and logger behavior under various configurations. ### Changed - Updated `start_logger` in `logger.py` to use these new variables, allowing fine-grained control over audit log destinations and ensuring audit logs are only output to enabled targets. ### Deprecated N/A ### Removed N/A ### Fixed - Parameter description in `start_logger` in `logger.py`. ### Security N/A ### Breaking Changes N/A new config variables provide backward compatible behavior. --- ### Additional Information N/A ### Screenshots or Videos N/A ### Contributor License Agreement 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-06 09:50:15 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
confirmed
confirmed issue
core
documentation
enhancement
good first issue
help wanted
non-core
pull-request
Mirrored from GitHub Pull Request
 python
question
testing wanted
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#64327
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?