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.11

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.11
File	Size	Uploaded
openinference_instrumentation_haystack-0.1.11.tar.gz	12.7 kB	Aug 23, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for openinference-instrumentation-haystack 0.1.11
File	Interpreter	ABI	Platform	Reset
openinference_instrumentation_haystack-0.1.11-py3-none-any.whl 13.8 kB Aug 23, 2024	Python 3	none	any	Details

Total release size: 26.5 kB

Release files / openinference_instrumentation_haystack-0.1.11.tar.gz

Download URL	openinference_instrumentation_haystack-0.1.11.tar.gz
Size	12.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`90d76ec45c068cff2e03ea9e1e76cccbcb6599501f147ffb2bdbb583b7bb71d6`
BLAKE2b-256 checksum How to use checksums	`71d41274af6bd8156b77afe1115ed37db24c42eccb4f59c6dbf3cf39aa0ab38a`
Upload date	Aug 23, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.12.5`

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

Download URL	openinference_instrumentation_haystack-0.1.11-py3-none-any.whl
Size	13.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`60dcf81f60806864c8d7a68090f983cd9e4b0bf9cca1685efa1165a51ecbbac7`
BLAKE2b-256 checksum How to use checksums	`ac492ac0a5f38074e20e88208993c2a8722ed77533e49f2e35e537d49bdd2061`
Upload date	Aug 23, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.12.5`