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.3.tar.gz.

File metadata

File hashes

Hashes for openinference_instrumentation_agentspec-0.1.3.tar.gz
Algorithm Hash digest
SHA256 ef44b7415cd73b8c233ea9d30975826d294d1b092b22ec15f6cd070feac1f360
MD5 6098363a0572bc91bd90131cfa6d2616
BLAKE2b-256 e89e2ee8e85d8c58cf1d2ef12db998805efbd37d1cdd7428701b54a042e6e007

See more details on using hashes here.

Provenance

The following attestation bundles were made for openinference_instrumentation_agentspec-0.1.3.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_agentspec-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for openinference_instrumentation_agentspec-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 185ce0ba7cb0e7f7e91ad397ebc9f5c1cf58cad944f515bfabf37cde984ad1e3
MD5 eb766ab1b2385ccde8bcf3456e97cbfe
BLAKE2b-256 811925ad1601b48f8c2af32975a43c423fd7076ea8c7b254665797cce9cc39c7

See more details on using hashes here.

Provenance

The following attestation bundles were made for openinference_instrumentation_agentspec-0.1.3-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.

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