mirror of
https://github.com/hanzoai/flow.git
synced 2026-10-17 01:29:18 +00:00
zeekay
94741a8363
Completes the rebrand per direction: LANGFLOW_/LANGFLOW -> FLOW_/FLOW (env vars, headers), langflow_ -> flow_ (settings fields, local vars), camelCase identifiers (LangflowClient/Logo/HTTPError, builtWithLangflow, getLangflowDesktop) -> Flow*, and all remaining bare tokens. Fixed the identifier-space hazard (Langflow -> 'Hanzo Flow' is prose-only; in code it collapses to Flow so no identifier gains a space). compileall of flow + lfx is clean. Repo-wide langflow now = 4, all the protected MIT attribution to langflow-ai/ langflow in README (legally required; deliberately preserved). Breaking (per no-backwards-compat / forward-perfection): the LANGFLOW_* env-var prefix is now FLOW_* — deployments must update their env. CI's uv + frontend build is the runtime gate.
97 lines
3.5 KiB
Plaintext
97 lines
3.5 KiB
Plaintext
---
|
|
title: Logs endpoints
|
|
slug: /api-logs
|
|
---
|
|
import CodeSnippet from '@site/src/components/CodeSnippet';
|
|
import exampleApiLogsStreamLogs from '!!raw-loader!@site/docs/API-Reference/curl-examples/api-logs/stream-logs.sh';
|
|
import resultApiLogsResultStreamLogs from '!!raw-loader!@site/docs/API-Reference/curl-examples/api-logs/result-stream-logs.txt';
|
|
import exampleApiLogsRetrieveLogsWithOptionalParameters from '!!raw-loader!@site/docs/API-Reference/curl-examples/api-logs/retrieve-logs-with-optional-parameters.sh';
|
|
import resultApiLogsResultRetrieveLogsWithOptionalParameters from '!!raw-loader!@site/docs/API-Reference/curl-examples/api-logs/result-retrieve-logs-with-optional-parameters.txt';
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
import examplePythonApiLogsStreamLogs from '!!raw-loader!@site/docs/API-Reference/python-examples/api-logs/stream-logs.py';
|
|
import exampleJavascriptApiLogsStreamLogs from '!!raw-loader!@site/docs/API-Reference/javascript-examples/api-logs/stream-logs.js';
|
|
import examplePythonApiLogsRetrieveLogsWithOptionalParameters from '!!raw-loader!@site/docs/API-Reference/python-examples/api-logs/retrieve-logs-with-optional-parameters.py';
|
|
import exampleJavascriptApiLogsRetrieveLogsWithOptionalParameters from '!!raw-loader!@site/docs/API-Reference/javascript-examples/api-logs/retrieve-logs-with-optional-parameters.js';
|
|
|
|
|
|
|
|
Retrieve logs for your Hanzo Flow flows and server.
|
|
|
|
## Enable log retrieval
|
|
|
|
The `/logs` endpoint requires log retrieval to be enabled in your Hanzo Flow instance.
|
|
|
|
To enable log retrieval, set the following [environment variables](/environment-variables) in your Hanzo Flow `.env` file, and then start Hanzo Flow with `uv run flow run --env-file .env`:
|
|
|
|
```text
|
|
FLOW_ENABLE_LOG_RETRIEVAL=True
|
|
FLOW_LOG_RETRIEVER_BUFFER_SIZE=10000 // Must be greater than 0
|
|
FLOW_LOG_LEVEL=DEBUG // Can be DEBUG, ERROR, INFO, WARNING, or CRITICAL
|
|
```
|
|
|
|
## Stream logs
|
|
|
|
Stream logs in real-time using Server Sent Events (SSE):
|
|
|
|
<Tabs>
|
|
<TabItem value="Python" label="Python" default>
|
|
|
|
<CodeSnippet source={examplePythonApiLogsStreamLogs} language="python" />
|
|
|
|
</TabItem>
|
|
<TabItem value="JavaScript" label="JavaScript">
|
|
|
|
<CodeSnippet source={exampleJavascriptApiLogsStreamLogs} language="javascript" />
|
|
|
|
</TabItem>
|
|
<TabItem value="curl" label="curl">
|
|
|
|
<CodeSnippet source={exampleApiLogsStreamLogs} language="bash" />
|
|
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
<details>
|
|
<summary>Result</summary>
|
|
|
|
<CodeSnippet source={resultApiLogsResultStreamLogs} language="text" />
|
|
|
|
</details>
|
|
|
|
## Retrieve logs with optional parameters
|
|
|
|
Retrieve logs with optional query parameters:
|
|
|
|
- `lines_before`: The number of logs before the timestamp or the last log.
|
|
- `lines_after`: The number of logs after the timestamp.
|
|
- `timestamp`: The timestamp to start getting logs from.
|
|
|
|
The default values for all three parameters is `0`.
|
|
With default values, the endpoint returns the last 10 lines of logs.
|
|
|
|
<Tabs>
|
|
<TabItem value="Python" label="Python" default>
|
|
|
|
<CodeSnippet source={examplePythonApiLogsRetrieveLogsWithOptionalParameters} language="python" />
|
|
|
|
</TabItem>
|
|
<TabItem value="JavaScript" label="JavaScript">
|
|
|
|
<CodeSnippet source={exampleJavascriptApiLogsRetrieveLogsWithOptionalParameters} language="javascript" />
|
|
|
|
</TabItem>
|
|
<TabItem value="curl" label="curl">
|
|
|
|
<CodeSnippet source={exampleApiLogsRetrieveLogsWithOptionalParameters} language="bash" />
|
|
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
<details>
|
|
<summary>Result</summary>
|
|
|
|
<CodeSnippet source={resultApiLogsResultRetrieveLogsWithOptionalParameters} language="text" />
|
|
|
|
</details>
|