docs: add embedding troubleshooting for stalled flows#327
Open
mason5052 wants to merge 1 commit into
Open
Conversation
Add a troubleshooting subsection to the Embedding Configuration and Testing section for the common case where a flow starts but then waits indefinitely with no subtasks progressing. As noted on the issue, this is frequently caused by a misconfigured or unreachable embedding provider rather than by the flow itself. The subsection points users to "docker logs pentagi" as the first check, to the etester "test" command to validate the embedding provider and database connection without starting a flow, and to the specific .env settings to verify (EMBEDDING_PROVIDER, EMBEDDING_MODEL, EMBEDDING_URL, EMBEDDING_KEY, the LLM-provider fallback, PROXY_URL, and HTTP_CLIENT_TIMEOUT). Documentation only: no new environment variables, no provider default changes, and no code or test changes. Refs vxcontrol#322
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds a README troubleshooting section to help diagnose flows that stall/hang due to embedding provider misconfiguration or connectivity issues.
Changes:
- Documented symptoms and likely root cause (embedding calls failing/hanging) for stalled flows
- Added step-by-step diagnostics: container logs +
etestervalidation - Added configuration checklist and guidance on reindex/flush when switching providers
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a troubleshooting subsection to the Embedding Configuration and Testing section of the README for the case where a flow starts but then waits indefinitely with no progress. Documentation only.
Problem
In #322 a user reported that a flow "just keeps waiting, nothing moving ahead." As noted on the issue, this symptom is frequently caused by a misconfigured or unreachable embedding provider rather than by the flow itself, and the suggested first step is to check
docker logs pentagiand the embedding configuration guide. The README documents how to configure and test embeddings, but it does not connect the "flow hangs / never progresses" symptom to embedding provider settings, so users debug the flow instead of the provider.Solution
A new
### Troubleshooting: Flow Stalls or Hangs Without Progresssubsection placed at the end of the Embedding Configuration and Testing section. It gives a short, ordered diagnostic path that matches the maintainer guidance on the issue:docker logs pentagifor embedding errors (auth, wrong model, timeout, TLS).etester test -verboseto validate the embedding provider and database connection without starting a flow..envsettings, with cross-links to the existing Supported Embedding Providers and Why Consistent Embedding Providers Matter subsections.Every environment variable referenced (
EMBEDDING_PROVIDER,EMBEDDING_MODEL,EMBEDDING_URL,EMBEDDING_KEY,OPEN_AI_KEY,OPEN_AI_SERVER_URL,PROXY_URL,HTTP_CLIENT_TIMEOUT) already exists in both.env.exampleandbackend/pkg/config/config.go. The LLM-provider fallback note mirrors the behavior already documented just above in the same section.User Impact
Documentation only. No new environment variables, no provider default changes, and no code or test changes. Users who hit a stalled flow get a direct, ordered path to the likely embedding-provider cause instead of debugging the flow.
Test Plan
git diff --checkreports no whitespace errorsREADME.md, 29 insertions); no code, schema, compose, or.env.examplechanges.env.exampleandbackend/pkg/config/config.go#embedding-tester-utility-etester,#supported-embedding-providers,#why-consistent-embedding-providers-matter) resolve to existing headingsRefs #322