Skip to main content

OpenInference Open Agent Spec Instrumentation

Project description

OpenInference Agent Spec Instrumentation

Python auto-instrumentation library for Agent Spec.

Open Agent Spec (Agent Spec) is a portable, platform-agnostic configuration language that allows Agents and Agentic Systems to be described with high fidelity. It defines the conceptual building blocks—called components—that make up agents in typical agent-based systems. This includes the properties that configure each component and the semantics that govern their behavior.

Agent Spec Tracing is an extension of Agent Spec that standardizes how agent and flow executions emit traces. It enables:

  • Runtime adapters to emit consistent traces across different frameworks.
  • Consumers (observability backends, UIs, developer tooling) to ingest one standardized format regardless of the producer.

You can find more information about Agent Spec and Agent Spec Tracing at:

The traces emitted by this instrumentation are fully OpenTelemetry compatible and can be sent to an OpenTelemetry collector for viewing, such as arize-phoenix

Installation

pip install openinference-instrumentation-agentspec

Quickstart

In this example we will instrument a small program that uses Agent Spec Tracing and observe the traces via arize-phoenix.

Install packages.

pip install openinference-instrumentation-agentspec pyagentspec[langgraph] arize-phoenix opentelemetry-sdk opentelemetry-exporter-otlp

Start the phoenix server so that it is ready to collect traces. The Phoenix server runs entirely on your machine and does not send data over the internet.

phoenix serve

In a python file (e.g., agentspec_agent.py) , set up the AgentSpecInstrumentor and configure the tracer to send traces to Phoenix.

from pyagentspec.adapters.langgraph import AgentSpecLoader
from pyagentspec.agent import Agent
from pyagentspec.llms import OpenAiConfig

agent = Agent(
    name="assistant",
    description="An general purpose agent without tools",
    llm_config=OpenAiConfig(name="openai-gpt-5-mini", model_id="gpt-5-mini"),
    system_prompt="You are a helpful assistant. Help the user answering politely.",
)

langgraph_agent = AgentSpecLoader().load_component(agent)

from phoenix.otel import register

from openinference.instrumentation.agentspec import AgentSpecInstrumentor

tracer_provider = register(batch=True, project_name="hello-world-app")
AgentSpecInstrumentor().instrument(tracer_provider=tracer_provider)

while True:
    user_input = input("USER  >>> ")
    if user_input.lower() in ["exit", "quit"]:
        break
    response = langgraph_agent.invoke(
        input={"messages": [{"role": "user", "content": user_input}]},
        config={"configurable": {"thread_id": "1"}},
    )
    print("AGENT >>>", response['messages'][-1].content.strip())

Now simply run the python file and observe the traces in Phoenix.

python agentspec_agent.py

Project details


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_agentspec-0.1.1.tar.gz.

File metadata

File hashes

Hashes for openinference_instrumentation_agentspec-0.1.1.tar.gz
Algorithm Hash digest
SHA256 26b842f7b86695e34ad7a29b3cf90f50958e9955d2d2326a1d58cc5a13148b94
MD5 1f5d42fa3c477599382c3aea8dc900ce
BLAKE2b-256 15c742fd16cddab758280825c2a4ef0f56b0ab621218c0381716da27f50c6219

See more details on using hashes here.

File details

Details for the file openinference_instrumentation_agentspec-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for openinference_instrumentation_agentspec-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 14471b9f000b55be02e61c367a81d31515d2bba1defe98540bf9845e4621195e
MD5 75ed2ac43b1e0846bd16a231aafd8337
BLAKE2b-256 e4ebf4589bab6c5223776b7d8ad409c765858136d869dd78d3696c3d632f9f2e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page