Using Opik with Haystack
Haystack is an open-source framework for building production-ready LLM applications, retrieval-augmented generative pipelines and state-of-the-art search systems that work intelligently over large document collections.
In this guide, we will showcase how to integrate Opik with Haystack so that all the Haystack calls are logged as traces in Opik.
Creating an account on Comet.com
Comet provides a hosted version of the Opik platform, simply create an account and grab you API Key.
You can also run the Opik platform locally, see the installation guide for more information.
Creating the Haystack pipeline
In this example, we will create a simple pipeline that uses a prompt template to translate text to German.
To enable Opik tracing, we will:
- Enable content tracing in Haystack by setting the environment variable
HAYSTACK_CONTENT_TRACING_ENABLED=true
- Add the
OpikConnector
component to the pipeline
Note: The OpikConnector
component is a special component that will automatically log the traces of the pipeline as Opik traces, it should not be connected to any other component.
The trace is now logged to the Opik platform:
Advanced usage
Ensuring the trace is logged
By default the OpikConnector
will flush the trace to the Opik platform after each component in a thread blocking way. As a result, you may disable flushing the data after each component by setting the HAYSTACK_OPIK_ENFORCE_FLUSH
environent variable to false
.
Caution: Disabling this feature may result in data loss if the program crashes before the data is sent to Opik. Make sure you will call the flush()
method explicitly before the program exits:
Getting the trace ID
If you would like to log additional information to the trace you will need to get the trace ID. You can do this by the tracer
key in the response of the pipeline: