openinference-instrumentation-instructor package, alongside the underlying LLM client’s instrumentor.
Prerequisites
- Python 3.9+
- An Arize AX account (sign up)
- An
OPENAI_API_KEYfrom the OpenAI Platform
Launch Arize AX
- Sign in to your Arize AX account.
- From Space Settings, copy your Space ID and API Key. You will set them as
ARIZE_SPACE_IDandARIZE_API_KEYbelow.
Install
instructor is pinned below 1.15.3 because that release removed the internal instructor.patch module that openinference-instrumentation-instructor (≤0.1.17) wraps to emit spans — newer versions instrument without error but produce no Instructor spans. 1.15.1 is the latest compatible release. Remove the pin once a version of openinference-instrumentation-instructor that supports Instructor’s newer patch path ships.Configure credentials
Setup tracing
Run Instructor
Expected output
Verify in Arize AX
- Open your Arize AX space and select project
instructor-tracing-example. - You should see a new trace within ~30 seconds containing an
instructor.patchparent span plus nested OpenAIChatCompletionLLM spans with the prompt, response, and token usage attached. Instructor emits multiple child spans per call when it validates and (where applicable) retries. - If no traces appear, see Troubleshooting.
Check from the skill, CLI, or SDK
Confirm spans are actually reaching your Arize AX project. Use whichever fits your workflow — the skill and CLI work for any framework; the SDK check is shown for each language.- Arize skill (agent)
- AX CLI
- SDK
Install the Arize Skills plugin and let your coding agent check for you:Then prompt your agent:
Use the arize-trace skill to export and analyze recent traces from my project. Confirm spans are arriving, and summarize any errors or latency issues.
Troubleshooting
- No traces in Arize AX. Confirm
ARIZE_SPACE_IDandARIZE_API_KEYare set in the same shell that runsexample.py. Enable OpenTelemetry debug logs withexport OTEL_LOG_LEVEL=debugand re-run. - Instructor spans missing but OpenAI spans present.
InstructorInstrumentor().instrument(...)must run beforeinstructor.from_openai(...). Make sureinstrumentation.pyis the first import in your entry point. 401from OpenAI. VerifyOPENAI_API_KEYis set and has access togpt-5.5. Swap for a model your key can call.- Pydantic
ValidationErrorretries. Instructor retries on validation failure (default 1); each retry is a separate child span. Increasemax_retries=on the call to see them surface, or tighten the prompt to avoid the retry.