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.
140 lines
4.7 KiB
Plaintext
140 lines
4.7 KiB
Plaintext
---
|
|
title: Openlayer
|
|
slug: /integrations-openlayer
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
[Openlayer](https://www.openlayer.com/) is a testing and evaluation platform for LLM applications. It provides comprehensive observability, testing, and monitoring capabilities to help you ship high-quality AI systems with confidence.
|
|
|
|
You can configure Hanzo Flow to collect tracing data about your flow executions and automatically send the data to Openlayer for analysis, monitoring, and evaluation.
|
|
|
|
## Prerequisites
|
|
|
|
- An [Openlayer account](https://www.openlayer.com/)
|
|
- A [running Hanzo Flow server](/get-started-installation) with a [flow](/concepts-flows) that you want to trace
|
|
- An Openlayer inference pipeline
|
|
|
|
:::tip
|
|
If you need a flow to test the Openlayer integration, see the [Hanzo Flow quickstart](/get-started-quickstart).
|
|
:::
|
|
|
|
## Set Openlayer credentials as environment variables
|
|
|
|
1. Get your [Openlayer API key](https://app.openlayer.com/settings/api-keys) from your Openlayer account.
|
|
|
|
2. Create an inference pipeline in Openlayer and copy the pipeline ID.
|
|
|
|
3. Set your Openlayer credentials as environment variables in the same environment where you run Hanzo Flow.
|
|
|
|
In the following examples, replace `YOUR_API_KEY` and `YOUR_PIPELINE_ID` with your actual Openlayer credentials.
|
|
|
|
<Tabs>
|
|
<TabItem value="linux-macos" label="Linux or macOS" default>
|
|
|
|
These commands set the environment variables in a Linux or macOS terminal session:
|
|
|
|
```bash
|
|
export OPENLAYER_API_KEY="YOUR_API_KEY"
|
|
export OPENLAYER_INFERENCE_PIPELINE_ID="YOUR_PIPELINE_ID"
|
|
```
|
|
|
|
</TabItem>
|
|
<TabItem value="windows" label="Windows">
|
|
|
|
These commands set the environment variables in a Windows command prompt session:
|
|
|
|
```cmd
|
|
set OPENLAYER_API_KEY=YOUR_API_KEY
|
|
set OPENLAYER_INFERENCE_PIPELINE_ID=YOUR_PIPELINE_ID
|
|
```
|
|
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
## Start Hanzo Flow and view traces in Openlayer
|
|
|
|
1. Start Hanzo Flow in the same environment where you set the Openlayer environment variables:
|
|
|
|
```bash
|
|
uv run flow run
|
|
```
|
|
|
|
2. Run a flow in Hanzo Flow.
|
|
|
|
Hanzo Flow automatically collects and sends tracing data about the flow execution to Openlayer, including:
|
|
- Component inputs and outputs
|
|
- Execution timing and latency
|
|
- LLM calls and nested operations
|
|
- User and session context
|
|
|
|
3. View the collected data in your [Openlayer dashboard](https://app.openlayer.com/).
|
|
|
|
Each flow execution appears as a trace with a hierarchical view of all components and their nested operations.
|
|
|
|
## Advanced configuration
|
|
|
|
### Flow-specific pipelines
|
|
|
|
You can configure different Openlayer inference pipelines for different flows using flow-specific environment variables:
|
|
|
|
```bash
|
|
export OPENLAYER_PIPELINE_MY_FLOW_NAME="pipeline-id-1"
|
|
export OPENLAYER_PIPELINE_ANOTHER_FLOW="pipeline-id-2"
|
|
```
|
|
|
|
The flow name is converted to uppercase and non-alphanumeric characters are replaced with underscores. For example, "My Flow-Name" becomes `OPENLAYER_PIPELINE_MY_FLOW_NAME`.
|
|
|
|
### JSON mapping
|
|
|
|
Alternatively, you can use a JSON mapping to configure multiple flows at once:
|
|
|
|
<Tabs>
|
|
<TabItem value="linux-macos" label="Linux or macOS" default>
|
|
|
|
```bash
|
|
export OPENLAYER_FLOW_MAPPING='{"Flow Name 1":"pipeline-id-1","Flow Name 2":"pipeline-id-2"}'
|
|
```
|
|
|
|
</TabItem>
|
|
<TabItem value="windows" label="Windows">
|
|
|
|
```cmd
|
|
set OPENLAYER_FLOW_MAPPING={"Flow Name 1":"pipeline-id-1","Flow Name 2":"pipeline-id-2"}
|
|
```
|
|
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
### Configuration priority
|
|
|
|
Openlayer configuration is resolved in the following order (highest priority first):
|
|
|
|
1. Flow-specific environment variable: `OPENLAYER_PIPELINE_<FLOW_NAME>`
|
|
2. JSON mapping: `OPENLAYER_FLOW_MAPPING`
|
|
3. Default environment variable: `OPENLAYER_INFERENCE_PIPELINE_ID`
|
|
|
|
This allows you to set a default pipeline for all flows and override it for specific flows as needed.
|
|
|
|
## Disable Openlayer tracing
|
|
|
|
To disable the Openlayer integration, remove the `OPENLAYER_API_KEY` environment variable, and then restart Hanzo Flow.
|
|
|
|
## Features
|
|
|
|
The Openlayer integration automatically captures:
|
|
|
|
- **Component hierarchy**: All flow components with parent-child relationships
|
|
- **LangChain callbacks**: Nested LLM calls and tool executions appear within their parent components
|
|
- **Timing metrics**: Start time, end time, and latency for each component
|
|
- **Inputs and outputs**: Component inputs and outputs with automatic type conversion
|
|
- **User context**: User ID and session ID propagation for better analytics
|
|
- **Error tracking**: Errors and logs captured in component metadata
|
|
|
|
## See also
|
|
|
|
* [Openlayer documentation](https://docs.openlayer.com/)
|
|
* [Openlayer GitHub repository](https://github.com/openlayer-ai/openlayer-python)
|
|
|