Python · Instrumentation
openinference-instrumentation-haystack
OpenInference Haystack Instrumentation
- Module
openinference.instrumentation.haystack- Version
- 0.1.53
- Python
- >=3.10, <3.16
- Instruments
haystack-ai >= 2.18.0
Install
pip install openinference-instrumentation-haystackUsage
Instrument once, at startup, before the library is used. The HaystackInstrumentor reference below lists the options.
from opentelemetry.sdk.trace import TracerProvider
from openinference.instrumentation import TraceConfig
from openinference.instrumentation.haystack import HaystackInstrumentor
tracer_provider = TracerProvider()
# ...add a span processor that exports to Phoenix or any OTLP backend.
HaystackInstrumentor().instrument(
tracer_provider=tracer_provider,
config=TraceConfig(hide_inputs=True), # optional
)openinference.instrumentation.haystack
HaystackInstrumentor
classSource ↗class HaystackInstrumentor(BaseInstrumentor)An instrumentor for the Haystack framework.
instrument
methoddef instrument(
*,
tracer_provider: Optional[TracerProvider] = None,
config: Optional[TraceConfig] = None,
skip_dep_check: bool = False,
) -> NoneStart tracing haystack-ai: patch it so its calls make OpenInference spans. Calling it again does nothing. Inherited from OpenTelemetry’s BaseInstrumentor.
Parameters
| Name | Description |
|---|---|
tracer_provider | The tracer provider the spans are made with. Defaults to the global one, |
config | What the spans record: hide inputs, outputs or messages, or limit image sizes. Defaults to |
skip_dep_check | Instrument even if the installed version of |
uninstrument
methoddef uninstrument() -> NoneStop tracing: undo the patches instrument() made. Inherited from OpenTelemetry’s BaseInstrumentor.
instrumentation_dependencies
methodSource ↗def instrumentation_dependencies() -> Collection[str]