wehub-resource-sync
c56bef871b
CodeQL / Analyze (python) (push) Has been cancelled
Update Platform Components Table / update (push) Has been cancelled
Docker image release / Build base image (push) Has been cancelled
Sync docs with Docusaurus / sync (push) Has been cancelled
Tests / Check if changed (push) Has been cancelled
Tests / format (push) Has been cancelled
Tests / check-imports (push) Has been cancelled
Tests / Unit / macos-latest (push) Has been cancelled
Tests / Unit / ubuntu-latest (push) Has been cancelled
Tests / Unit / windows-latest (push) Has been cancelled
Tests / mypy (push) Has been cancelled
Tests / Integration / ubuntu-latest (push) Has been cancelled
Tests / Integration / macos-latest (push) Has been cancelled
Tests / Integration / windows-latest (push) Has been cancelled
Tests / notify-slack-on-failure (push) Has been cancelled
Tests / Mark tests as completed (push) Has been cancelled
111 lines
4.4 KiB
Plaintext
111 lines
4.4 KiB
Plaintext
---
|
|
title: "Langfuse"
|
|
id: langfuse
|
|
slug: "/tracing-langfuse"
|
|
description: "Learn how to trace your Haystack pipelines with Langfuse."
|
|
---
|
|
|
|
import ClickableImage from "@site/src/components/ClickableImage";
|
|
|
|
# Langfuse
|
|
|
|
Learn how to trace your Haystack pipelines with Langfuse.
|
|
|
|
<div className="key-value-table">
|
|
|
|
| | |
|
|
| --- | --- |
|
|
| **Tracer class** | `LangfuseTracer` |
|
|
| **How to enable** | Enable the tracer with `tracing.enable_tracing(LangfuseTracer(langfuse))`, or add the `LangfuseConnector` component to your pipeline |
|
|
| **Content tracing** | Required. Set `HAYSTACK_CONTENT_TRACING_ENABLED` to `true` |
|
|
| **Package** | `langfuse-haystack` |
|
|
| **API reference** | [langfuse](/reference/integrations-langfuse) |
|
|
| **GitHub link** | https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/langfuse |
|
|
|
|
</div>
|
|
|
|
## Overview
|
|
|
|
Trace your Haystack pipelines with the [Langfuse](https://langfuse.com/) UI. Langfuse captures detailed information about pipeline runs, like API calls, context data, prompts, and more. Use it to monitor model performance such as token usage and cost, find areas for improvement, and create datasets from your pipeline executions.
|
|
|
|
## Installation
|
|
|
|
Install the `langfuse-haystack` package:
|
|
|
|
```shell
|
|
pip install langfuse-haystack
|
|
```
|
|
|
|
## Prerequisites
|
|
|
|
1. An active Langfuse [account](https://cloud.langfuse.com/).
|
|
2. Set the `LANGFUSE_SECRET_KEY` and `LANGFUSE_PUBLIC_KEY` environment variables with your Langfuse secret and public keys, found in your account profile.
|
|
3. Set the `HAYSTACK_CONTENT_TRACING_ENABLED` environment variable to `true` to enable tracing.
|
|
|
|
:::info[Usage Notice]
|
|
To ensure proper tracing, always set environment variables before importing any Haystack components. This is crucial because Haystack initializes its internal tracing components during import. An even better practice is to set these environment variables in your shell before running the script.
|
|
:::
|
|
|
|
## Usage
|
|
|
|
Enable the `LangfuseTracer` directly to trace any Haystack pipeline, without adding a component to it.
|
|
|
|
```python
|
|
import os
|
|
|
|
os.environ["LANGFUSE_HOST"] = "https://cloud.langfuse.com"
|
|
os.environ["LANGFUSE_SECRET_KEY"] = "<your-secret-key>"
|
|
os.environ["LANGFUSE_PUBLIC_KEY"] = "<your-public-key>"
|
|
os.environ["HAYSTACK_CONTENT_TRACING_ENABLED"] = "true"
|
|
|
|
from langfuse import Langfuse
|
|
|
|
from haystack import Pipeline, tracing
|
|
from haystack.components.builders import ChatPromptBuilder
|
|
from haystack.components.generators.chat import OpenAIChatGenerator
|
|
from haystack.dataclasses import ChatMessage
|
|
|
|
from haystack_integrations.tracing.langfuse import LangfuseTracer
|
|
|
|
# Enable the Langfuse tracer. The client reads your keys from the environment.
|
|
langfuse = Langfuse()
|
|
langfuse_tracer = LangfuseTracer(langfuse, name="Chat example")
|
|
tracing.enable_tracing(langfuse_tracer)
|
|
|
|
pipe = Pipeline()
|
|
pipe.add_component("prompt_builder", ChatPromptBuilder())
|
|
pipe.add_component("llm", OpenAIChatGenerator())
|
|
pipe.connect("prompt_builder.prompt", "llm.messages")
|
|
|
|
messages = [
|
|
ChatMessage.from_system(
|
|
"Always respond in German even if some input data is in other languages.",
|
|
),
|
|
ChatMessage.from_user("Tell me about {{location}}"),
|
|
]
|
|
|
|
response = pipe.run(
|
|
data={
|
|
"prompt_builder": {
|
|
"template_variables": {"location": "Berlin"},
|
|
"template": messages,
|
|
},
|
|
},
|
|
)
|
|
print(response["llm"]["replies"][0])
|
|
|
|
# Flush any pending spans before the program exits
|
|
langfuse_tracer.flush()
|
|
```
|
|
|
|
Each pipeline run produces one trace that includes the entire execution context, including prompts, completions, and metadata. You can then view the trace in the Langfuse UI.
|
|
<ClickableImage src="/img/11cec4f-langfuse-generation-span.png" alt="Langfuse trace detail view showing generation span with input prompt, output, metadata, latency, and cost information for a language model call" />
|
|
|
|
## Alternative: the LangfuseConnector component
|
|
|
|
If you prefer to manage tracing as part of your pipeline definition, you can add the `LangfuseConnector` component instead. It enables the same Langfuse tracing, exposes the `trace_url` as an output, and supports a custom `SpanHandler` for advanced span processing.
|
|
|
|
:::info
|
|
See the [`LangfuseConnector` documentation page](../../pipeline-components/connectors/langfuseconnector.mdx) for full usage examples and advanced span customization, or read the [blog post](https://haystack.deepset.ai/blog/langfuse-integration) for a complete walkthrough.
|
|
:::
|