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 for validating 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 cleary 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
After debugging the issue for some time, I noticed that the hangs disappear for some reason if logging is reduced in save_docs_to_vector_db. I have not had time to figure out the exact cause for this, but I suspect that trying to log the entire document contents has some ill effects in the underlying Python logging library.
Logging file contents at loglevel INFO seems like a bit too much in any case, so I think the change to reduce logging would be beneficial also from a monitoring perspective.
Changed
backend/open_webui/apps/retrieval/main.py: Avoid logging file contents at level INFO. Log document name, title or source instead
backend/open_webui/apps/retrieval/utils.py: Log result metadata, omit page contents
🔄 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/6543
**Author:** [@execgit](https://github.com/execgit)
**Created:** 10/29/2024
**Status:** ✅ Merged
**Merged:** 10/30/2024
**Merged by:** [@tjbck](https://github.com/tjbck)
**Base:** `dev` ← **Head:** `main`
---
### 📝 Commits (2)
- [`bc7622c`](https://github.com/open-webui/open-webui/commit/bc7622c0fe33c08014e77d83002e2afda33e8d4a) Avoid logging file contents at level INFO
- [`03e9add`](https://github.com/open-webui/open-webui/commit/03e9add96d58c4cc5253e9981933d5b65c4820b6) retrieval.utils: omit logging file contents at level INFO
### 📊 Changes
**2 files changed** (+25 additions, -3 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/open_webui/apps/retrieval/main.py` (+20 -1)
📝 `backend/open_webui/apps/retrieval/utils.py` (+5 -2)
</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?
- [ ] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation?
- [x] **Testing:** Have you written and run sufficient tests for validating 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 cleary 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
I've encountered strange issues with [nerdctl](https://github.com/containerd/nerdctl) [rootless mode](https://github.com/containerd/nerdctl/blob/main/docs/rootless.md) when handling documents. Namely, too large documents (~>130kB) cause the document embedding to hang in the function [retrieval.main.save_docs_to_vector_db](https://github.com/open-webui/open-webui/blob/main/backend/open_webui/apps/retrieval/main.py#L639).
After debugging the issue for some time, I noticed that the hangs disappear for some reason if logging is reduced in [save_docs_to_vector_db](https://github.com/open-webui/open-webui/blob/main/backend/open_webui/apps/retrieval/main.py#L647). I have not had time to figure out the exact cause for this, but I suspect that trying to log the entire document contents has some ill effects in the underlying Python logging library.
Logging file contents at loglevel INFO seems like a bit too much in any case, so I think the change to reduce logging would be beneficial also from a monitoring perspective.
### Changed
- backend/open_webui/apps/retrieval/main.py: Avoid logging file contents at level INFO. Log document name, title or source instead
- backend/open_webui/apps/retrieval/utils.py: Log result metadata, omit page contents
---
<sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
📋 Pull Request Information
Original PR: https://github.com/open-webui/open-webui/pull/6543
Author: @execgit
Created: 10/29/2024
Status: ✅ Merged
Merged: 10/30/2024
Merged by: @tjbck
Base:
dev← Head:main📝 Commits (2)
bc7622cAvoid logging file contents at level INFO03e9addretrieval.utils: omit logging file contents at level INFO📊 Changes
2 files changed (+25 additions, -3 deletions)
View changed files
📝
backend/open_webui/apps/retrieval/main.py(+20 -1)📝
backend/open_webui/apps/retrieval/utils.py(+5 -2)📄 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:
devbranch.Changelog Entry
Description
I've encountered strange issues with nerdctl rootless mode when handling documents. Namely, too large documents (~>130kB) cause the document embedding to hang in the function retrieval.main.save_docs_to_vector_db.
After debugging the issue for some time, I noticed that the hangs disappear for some reason if logging is reduced in save_docs_to_vector_db. I have not had time to figure out the exact cause for this, but I suspect that trying to log the entire document contents has some ill effects in the underlying Python logging library.
Logging file contents at loglevel INFO seems like a bit too much in any case, so I think the change to reduce logging would be beneficial also from a monitoring perspective.
Changed
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.