[PR #15640] [MERGED] refactor(logger): Conditionally include extra_json in logs #62754

New Issue

GiteaMirror · 2026-05-06T07:07:00-05:00

GiteaMirror commented

2026-05-06 07:07:00 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/15640
Author: @ipapapa
Created: 7/11/2025
Status: ✅ Merged
Merged: 8/4/2025
Merged by: @tjbck

Base: dev ← Head: feat/cleaner-logs

📝 Commits (1)

54d606e refactor(logger): Conditionally include extra_json in logs

📊 Changes

1 file changed (+6 additions, -2 deletions)

View changed files

📝 backend/open_webui/utils/logger.py (+6 -2)

📄 Description

Pull Request Checklist

Discussion Post

https://github.com/open-webui/open-webui/discussions/15641

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

Refactored the logging utility to make log output cleaner and more efficient by only including the extra_json field when there is actual extra data to display. This avoids cluttering logs with empty JSON objects.

Added

None

Changed

backend/open_webui/utils/logger.py: Modified stdout_format to conditionally add extra_json.

Deprecated

None

Removed

None

Fixed

None

Security

None

Breaking Changes

BREAKING CHANGE: None

Additional Information

This change is a minor refactor to improve log output readability. It aligns with the project's goal of maintaining
clean and efficient code.
Related commit: 54d606eab

Screenshots or Videos

None

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/15640 **Author:** [@ipapapa](https://github.com/ipapapa) **Created:** 7/11/2025 **Status:** ✅ Merged **Merged:** 8/4/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `feat/cleaner-logs` --- ### 📝 Commits (1) - [`54d606e`](https://github.com/open-webui/open-webui/commit/54d606eabfba550798e39ebbf29794744d6c404c) refactor(logger): Conditionally include extra_json in logs ### 📊 Changes **1 file changed** (+6 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/utils/logger.py` (+6 -2) </details> ### 📄 Description # Pull Request Checklist ### Discussion Post https://github.com/open-webui/open-webui/discussions/15641 **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. - [x] **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 Refactored the logging utility to make log output cleaner and more efficient by only including the `extra_json` field when there is actual extra data to display. This avoids cluttering logs with empty JSON objects. ### Added - None ### Changed - `backend/open_webui/utils/logger.py`: Modified `stdout_format` to conditionally add `extra_json`. ### Deprecated - None ### Removed - None ### Fixed - None ### Security - None - ### Breaking Changes - **BREAKING CHANGE**: None --- ### Additional Information - This change is a minor refactor to improve log output readability. It aligns with the project's goal of maintaining clean and efficient code. Related commit: `54d606eab` ### Screenshots or Videos - None ### 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:07:00 -05:00

GiteaMirror closed this issue

2026-05-06 07:07:02 -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#62754