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 or Arize AX.

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file openinference_instrumentation_haystack-0.1.35.tar.gz.

File metadata

File hashes

Hashes for openinference_instrumentation_haystack-0.1.35.tar.gz
Algorithm Hash digest
SHA256 f0f70a68d0433dc4f5eb03427909165cfa238b3ec74b4d017cbd3aca29ceabee
MD5 22e0ffe98674e532a1acbc1ae3ba0f32
BLAKE2b-256 d91dbfe84a0a942758300d2c8233c25c5ae5a6960584d8e08412a63e1be14a01

See more details on using hashes here.

Provenance

The following attestation bundles were made for openinference_instrumentation_haystack-0.1.35.tar.gz:

Publisher: publish.yaml on Arize-ai/openinference

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openinference_instrumentation_haystack-0.1.35-py3-none-any.whl.

File metadata

File hashes

Hashes for openinference_instrumentation_haystack-0.1.35-py3-none-any.whl
Algorithm Hash digest
SHA256 dadd3aabb8cd79b83ff33797fbb540bff8a7614b97ac1bb056c06920159cc435
MD5 0cea66ae92fd206995afc7067be6faec
BLAKE2b-256 630b274ced225644844aca87577fa5e1a7c9c306c147a53b3a6b064e972b8a87

See more details on using hashes here.

Provenance

The following attestation bundles were made for openinference_instrumentation_haystack-0.1.35-py3-none-any.whl:

Publisher: publish.yaml on Arize-ai/openinference

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.1.39

2 files

0.1.38

2 files

0.1.37

2 files

0.1.36

2 files

This release

0.1.35 This release

2 files

0.1.34

2 files

0.1.33

2 files

0.1.32

2 files

0.1.31

2 files

0.1.30

2 files

0.1.29

2 files

0.1.28

2 files

0.1.27

2 files

0.1.26

2 files

0.1.25

2 files

0.1.24

2 files

0.1.23

2 files

0.1.22

2 files

0.1.21

2 files

0.1.20

2 files

0.1.19

2 files

0.1.18

2 files

0.1.17

2 files

0.1.16

2 files

0.1.15

2 files

0.1.14

2 files

0.1.13

2 files

0.1.12

2 files

0.1.11

2 files

0.1.10

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 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