Skip to main content

OpenInference Haystack Instrumentation

Python auto-instrumentation library for LLM applications implemented with Haystack.

Haystack Pipelines and Components (ex. PromptBuilder, OpenAIGenerator, etc.) are fully OpenTelemetry-compatible and can be sent to an OpenTelemetry collector for monitoring, such as arize-phoenix.

Installation

pip install openinference-instrumentation-haystack

Quickstart

This quickstart shows you how to instrument your Haystack-orchestrated LLM application

Through your terminal, install required packages.

pip install openinference-instrumentation-haystack haystack-ai arize-phoenix opentelemetry-sdk opentelemetry-exporter-otlp

You can install Phoenix and start it with the following terminal commands:

pip install arize-phoenix
python -m phoenix.server.main serve

Start Phoenix in the background as a collector. By default, it listens on http://localhost:6006. You can visit the app via a browser at the same address. (Phoenix does not send data over the internet. It only operates locally on your machine.)

Try the following in a Python file.

Set up HaystackInstrumentor to trace your application and sends the traces to Phoenix at the endpoint defined below.

from openinference.instrumentation.haystack import HaystackInstrumentor
from opentelemetry import trace as trace_api
from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
from opentelemetry.sdk import trace as trace_sdk
from opentelemetry.sdk.trace.export import SimpleSpanProcessor
import os

# Set your OpenAI API key
os.environ["OPENAI_API_KEY"] = "YOUR_KEY_HERE"

# Set up the tracer, using Arize Phoenix as the endpoint
endpoint = "http://127.0.0.1:6006/v1/traces"
tracer_provider = trace_sdk.TracerProvider()
trace_api.set_tracer_provider(tracer_provider)
tracer_provider.add_span_processor(SimpleSpanProcessor(OTLPSpanExporter(endpoint)))

# Instrument the Haystack application
HaystackInstrumentor().instrument()

Set up a simple Pipeline with a template using OpenAIGenerator.

from haystack import Pipeline
from haystack.components.generators import OpenAIGenerator

# Initialize the pipeline
pipeline = Pipeline()

# Initialize the OpenAI generator component
llm = OpenAIGenerator(model="gpt-3.5-turbo")

# Add the generator component to the pipeline
pipeline.add_component("llm", llm)

# Define the question
question = "What is the location of the Hanging Gardens of Babylon?"

# Run the pipeline with the question
response = pipeline.run({"llm": {"prompt": question}})

print(response)

Now, on the Phoenix UI on your browser, you should see the traces from your Haystack application. Specifically, you can see attributes from the execution of the OpenAIGenerator.

More Info

Metadata

Release files for openinference-instrumentation-haystack 0.1.29

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openinference-instrumentation-haystack 0.1.29
File Size Uploaded
openinference_instrumentation_haystack-0.1.29.tar.gz 15.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for openinference-instrumentation-haystack 0.1.29
File Interpreter ABI Platform
openinference_instrumentation_haystack-0.1.29-py3-none-any.whl Python 3 none any Details

Total release size: 32.9 kB

Release files / openinference_instrumentation_haystack-0.1.29.tar.gz

Download URL openinference_instrumentation_haystack-0.1.29.tar.gz
Size 15.6 kB
Tags Source
SHA-256 checksum
How to use checksums
36ae7648422c02cd6a02a9342ba34ca6e16ac014e22162513e2116af99423132
BLAKE2b-256 checksum
How to use checksums
b90968d593f54cf376de56c5bb3f2b50986f06debfa70229fc9d704359f20a8f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.0

Release files / openinference_instrumentation_haystack-0.1.29-py3-none-any.whl

Download URL openinference_instrumentation_haystack-0.1.29-py3-none-any.whl
Size 17.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
96dfa0f467564d3ab0b69fd8c322afb9d74babeb0362cefd4ecb0505c7758471
BLAKE2b-256 checksum
How to use checksums
ddaa41c21fa9affa233f6e1d307bfbbacd421b8feeaba6991af4b074f04f5b3a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.0

Release history Release notifications | RSS feed

0.1.42

2 release files

0.1.39

2 release files

0.1.38

2 release files

0.1.37

2 release files

0.1.35

2 release files

0.1.34

2 release files

0.1.33

2 release files

0.1.32

2 release files

0.1.31

2 release files

0.1.30

2 release files

This release

0.1.29 This release

2 release files

0.1.28

2 release files

0.1.27

2 release files

0.1.26

2 release files

0.1.25

2 release files

0.1.24

2 release files

0.1.23

2 release files

0.1.22

2 release files

0.1.21

2 release files

0.1.20

2 release files

0.1.19

2 release files

0.1.18

2 release files

0.1.17

2 release files

0.1.16

2 release files

0.1.14

2 release files

0.1.13

2 release files

0.1.12

2 release files

0.1.11

2 release files

0.1.10

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page