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

File metadata

File hashes

Hashes for openinference_instrumentation_agentspec-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b13c2436b9d4c6117555f3f7068457c824c7b75cad04211aca09627a1d5da317
MD5 5c28dc58e1f0fc2fba9e5fbd9efa973b
BLAKE2b-256 d3f77604d43f099be24d043b87ca0f67a3658aef92c693e8eacd0c7377fcd8c3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openinference_instrumentation_agentspec-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f1b582b09e774e34b7fc4da205b317380169e146ff1e7c08d970264be8af397e
MD5 7727eb343fd8efdefca36551fc817528
BLAKE2b-256 99cdb6472b182964301e4106c5e0b8286ba890d74b05210fca06294c87e966f8

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