docs: troubleshooting backlog items (#9474)

* user-not-found-error

* lf-desktop-outdated-1.4.2

* split-text-nvidia-tip

* add-macos-13-requirement

* retrieve-logs-desktop

* fix: update troubleshooting documentation for Langflow Desktop startup logs

* revert-g-assist

* use-com.Langflow-logs

* clarity-env-var-precedence

* cleanup

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* docs-review

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
This commit is contained in:
Mendon Kissling 2025-08-28 13:53:55 -04:00 committed by GitHub
commit 569c39cb97
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 98 additions and 9 deletions

View file

@ -44,6 +44,12 @@ For more information about using embedding model components in flows, see [**Emb
| temperature | Float | Input parameter. The model temperature for embedding generation. Default: `0.1`. |
| embeddings | Embeddings | Output parameter. An `NVIDIAEmbeddings` instance for generating embeddings. |
:::tip Tokenization considerations
Be aware of your embedding model's chunk size limit.
Tokenization errors can occur if your text chunks are too large.
For more information, see [Tokenization errors due to chunk size](/components-processing#chunk-size).
:::
## NVIDIA Rerank
This component finds and reranks documents using the NVIDIA API.
@ -53,7 +59,7 @@ This component finds and reranks documents using the NVIDIA API.
This component uses the NVIDIA `nv-ingest` microservice for data ingestion, processing, and extraction of text files.
For more information, see [Integrate NVIDIA Retriever Extraction with Langflow](/integrations-nvidia-ingest).
## NVIDIA System-Assist
## NVIDIA G-Assist
This component requires a specific system environment.
For information about this component, see [Integrate NVIDIA G-Assist with Langflow](/integrations-nvidia-g-assist).

View file

@ -755,11 +755,18 @@ You can toggle parameters through the <Icon name="SlidersHorizontal" aria-hidden
|------|--------------|------|
| data_inputs | Input | Input parameter. The data to split. Input must be in `Message`, `Data`, or `DataFrame` format. |
| chunk_overlap | Chunk Overlap | Input parameter. The number of characters to overlap between chunks. This helps maintain context across chunks. When a separator is encountered, the overlap is applied at the point of the separator so that the subsequent chunk contains the last _n_ characters of the preceding chunk. Default: `200`. |
| chunk_size | Chunk Size | Input parameter. The target length for each chunk after splitting. The data is first split by separator, and then chunks smaller than the `chunk_size` are merged up to this limit. However, if the initial separator split produces any chunks larger than the `chunk_size`, those chunks are neither further subdivided nor combined with any smaller chunks; these chunks will be output as-is even though they exceed the the `chunk_size`. Default: `1000`. |
| chunk_size | Chunk Size | Input parameter. The target length for each chunk after splitting. The data is first split by separator, and then chunks smaller than the `chunk_size` are merged up to this limit. However, if the initial separator split produces any chunks larger than the `chunk_size`, those chunks are neither further subdivided nor combined with any smaller chunks; these chunks will be output as-is even though they exceed the the `chunk_size`. Default: `1000`. See [Tokenization errors due to chunk size](#chunk-size) for important considerations. |
| separator | Separator | Input parameter. A string defining a character to split on, such as `\n` to split on new line characters, `\n\n` to split at paragraph breaks, or `},` to split at the end of JSON objects. You can directly provide the separator string, or pass a separator string from another component as `Message` input. |
| text_key | Text Key | Input parameter. The key to use for the text column that is extracted from the input and then split. Default: `text`. |
| keep_separator | Keep Separator | Input parameter. Select how to handle separators in output chunks. If False, separators are omitted from output chunks. Options include `False` (remove separators), `True` (keep separators in chunks without preference for placement), `Start` (place separators at the beginning of chunks), or `End` (place separators at the end of chunks). Default: `False`. |
### Tokenization errors due to chunk size {#chunk-size}
When using **Split Text** with embedding models (especially NVIDIA models like `nvidia/nv-embed-v1`), you may need to use smaller chunk sizes (`500` or less) even though the model supports larger token limits.
The **Split Text** component doesn't always enforce the exact chunk size you set, and individual chunks may exceed your specified limit.
If you encounter tokenization errors, modify your text splitting strategy by reducing the chunk size, changing the overlap length, or using a more common separator.
Then, test your configuration by running the flow and inspecting the component's output.
### Other text splitters
See [LangChain text splitter components](/bundles-langchain#text-splitters).

View file

@ -16,12 +16,16 @@ You can set Langflow environment variables in your terminal, in `.env`, and with
If an environment variable is set in multiple places, the following hierarchy applies:
1. Langflow CLI options override `.env` and terminal variables.
2. `.env` overrides terminal variables.
3. Terminal variables are used only if the variable isn't set in `.env` or Langflow CLI options.
1. Langflow CLI options override all other sources.
2. The `.env` file overrides system environment variables.
3. System environment variables are used only if not set elsewhere.
When running a Langflow Docker image, the `-e` flag sets system environment variables.
For example:
- If you set `LANGFLOW_PORT=8080` in your system environment and `LANGFLOW_PORT=7860` in `.env`, Langflow uses `7860` from `.env`.
- If you run `langflow run --port 9000` with `LANGFLOW_PORT=7860` in `.env`, Langflow uses `9000` from the CLI option.
For example, if you set `LANGFLOW_PORT` in `.env` and your terminal, then Langflow uses the value from `.env`.
Similarly, if you run a Langflow CLI command with `--port`, Langflow uses that port number instead of the `LANGFLOW_PORT` in `.env`.
## Configure environment variables

View file

@ -4,6 +4,8 @@ slug: /logging
---
import Icon from "@site/src/components/icon";
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
This page provides information about Langflow logs, including logs for individual flows and the Langflow application itself.
@ -94,6 +96,45 @@ When debugging issues with the format or content of a flow's output, it can help
To view the output produced by a single component during the most recent run, click <Icon name="TextSearch" aria-hidden="true"/> **Inspect output** on the component in the visual editor.
## Access Langflow Desktop logs {#desktop-logs}
If you encounter issues with Langflow Desktop, you might need to access startup logs for debugging.
Follow the steps for your operating system.
<Tabs>
<TabItem value="macos" label="macOS">
1. Open Terminal and run:
```bash
cd ~/Library/Logs/com.Langflow
```
2. To open the folder and view the log files, run the command:
```bash
open .
```
3. Locate the `langflow.log` file.
</TabItem>
<TabItem value="windows" label="Windows">
1. Open the Command Prompt (CMD), and then run the following command:
```cmd
cd %LOCALAPPDATA%\com.langflow\logs
```
2. To open the folder and view the log files, run the command:
```cmd
start .
```
3. Locate the `langflow.log` file.
</TabItem>
</Tabs>
You can use the log file to investigate the issue on your own, add context to a [GitHub Issue](/contributing-github-issues), or send it to [support](/luna-for-langflow) for debugging assistance.
The log file is only created when Langflow Desktop runs. If you don't see a log file, try starting Langflow Desktop first, then check for the log file.
## See also
* [Memory management options](/memory)

View file

@ -26,6 +26,8 @@ However, some features aren't available for Langflow Desktop, such as the **Shar
<Tabs>
<TabItem value="macos" label="macOS" default>
Langflow Desktop requires macOS 13 or later.
1. Navigate to [Langflow Desktop](https://www.langflow.org/desktop).
2. Click **Download Langflow**, enter your contact information, and then click **Download**.
3. Mount and install the Langflow application.

View file

@ -78,7 +78,7 @@ For more information, see the [NV-Ingest documentation](https://nvidia.github.io
| extract_infographics | Extract Infographics | Extract infographics from document. Default: false. |
| text_depth | Text Depth | The level at which text is extracted. Options: 'document', 'page', 'block', 'line', 'span'. Default: `page`. |
| split_text | Split Text | Split text into smaller chunks. Default: true. |
| chunk_size | Chunk Size | The number of tokens per chunk. Default: `500`. |
| chunk_size | Chunk Size | The number of tokens per chunk. Default: `500`. Make sure the chunk size is compatible with your embedding model. For more information, see [Tokenization errors due to chunk size](/components-processing#chunk-size). |
| chunk_overlap | Chunk Overlap | Number of tokens to overlap from previous chunk. Default: `150`. |
| filter_images | Filter Images | Filter images (see advanced options for filtering criteria). Default: false. |
| min_image_size | Minimum Image Size Filter | Minimum image width/length in pixels. Default: `128`. |

View file

@ -107,7 +107,7 @@ For all changes, see the [Changelog](https://github.com/langflow-ai/langflow/rel
- Enhanced file and flow management system with improved bulk capabilities.
- Added the **BigQuery** component
- Added the **Twelve Labs** bundle
- Added the **NVIDIA System Assistant** component
- Added the **NVIDIA G-Assist** component
### Deprecations

View file

@ -124,6 +124,21 @@ There are two possible reasons for this error:
Environment variables set in your terminal aren't automatically available to GUI-based applications like Langflow Desktop when launched through the Finder or the Start Menu.
To set environment variables for Langflow Desktop, see [Set environment variables for Langflow Desktop](/environment-variables#set-environment-variables-for-langflow-desktop).
### Access Langflow Desktop startup logs
If you encounter issues with Langflow Desktop, you might need to [access Langflow Desktop startup logs](/logging#desktop-logs) for debugging.
### User not found or inactive when running multiple flows
When running multiple local Langflow OSS instances on different ports, such as `localhost:7860` and `localhost:7861`, you might see authentication errors in the logs.
For example:
```text
[07/22/25 10:57:07] INFO 2025-07-22 10:57:07 - INFO - utils - User not found or inactive.
```
To resolve this error, use separate browser instances or browser profiles to access each Langflow instance.
### Package is not installed
In Langflow OSS, you can follow the error message's instructions to install the missing dependency.
@ -153,6 +168,15 @@ Clearing the cache erases your settings.
If you want to retain your settings files, create a backup of those files before clearing the cache folder.
:::
### Langflow Desktop says it is running the latest version, but it is actually behind
If you are running Langflow Desktop version 1.4.2 or earlier, the UI might incorrectly report that you are on the latest version when a newer version is available.
This happens because the automatic update feature in the UI was introduced in version 1.4.2.
Earlier versions can't automatically detect or apply updates.
To resolve this issue, uninstall Langflow Desktop, and then [download and install the latest version of Langflow Desktop](https://langflow.org/desktop).
## Langflow uninstall issues
The following issues can occur when uninstalling Langflow.
@ -174,6 +198,11 @@ To fully remove a Langflow Desktop macOS installation, you must also delete `~/.
- [Use MCP Inspector to test and debug flows](/mcp-server#test-and-debug-flows)
- [Troubleshooting MCP server](/mcp-server#troubleshooting-mcp-server)
## Token length limit errors in Embedding Model components
Token length errors can happen if your chunking strategy doesn't align with your embedding model's tokenization limits.
For more information, see [Tokenization errors due to chunk size](/components-processing#chunk-size).
## Custom components and integrations issues
For troubleshooting advice for a third-party integration, see the information about that integration in the Langflow documentation and the provider's documentation.