Python APIag2

Core

Instrumentation

Python · Instrumentation

openinference-instrumentation-ag2

OpenInference instrumentation for AG2

Module
openinference.instrumentation.ag2
Version
0.1.19
Python
>=3.10, <3.16
Instruments
ag2>=0.14.0,<1.0.0

Install

pip install openinference-instrumentation-ag2

Usage

Instrument once, at startup, before the library is used. The AG2Instrumentor reference below lists the options.

from opentelemetry.sdk.trace import TracerProvider
from openinference.instrumentation import TraceConfig
from openinference.instrumentation.ag2 import AG2Instrumentor

tracer_provider = TracerProvider()
# ...add a span processor that exports to Phoenix or any OTLP backend.

AG2Instrumentor().instrument(
    tracer_provider=tracer_provider,
    config=TraceConfig(hide_inputs=True),  # optional
)

openinference.instrumentation.ag2

OpenInference instrumentation for AG2, which is imported as autogen.

AG2Instrumentor

classSource ↗
class AG2Instrumentor(BaseInstrumentor)

Traces the chat, reply, and tool execution methods of AG2’s ConversableAgent.

instrument

method
def instrument(
    *,
    tracer_provider: Optional[TracerProvider] = None,
    config: Optional[TraceConfig] = None,
    skip_dep_check: bool = False,
) -> None

Start tracing ag2: patch it so its calls make OpenInference spans. Calling it again does nothing. Inherited from OpenTelemetry’s BaseInstrumentor.

Parameters

NameDescription
tracer_provider

The tracer provider the spans are made with. Defaults to the global one, opentelemetry.trace.get_tracer_provider().

config

What the spans record: hide inputs, outputs or messages, or limit image sizes. Defaults to TraceConfig(), which reads the OPENINFERENCE_* environment variables. See TraceConfig.

skip_dep_check

Instrument even if the installed version of ag2 is outside the supported range.

uninstrument

method
def uninstrument() -> None

Stop tracing: undo the patches instrument() made. Inherited from OpenTelemetry’s BaseInstrumentor.

instrumentation_dependencies

methodSource ↗
def instrumentation_dependencies() -> Collection[str]

Ag2Instrumentor

attributeSource ↗
Ag2Instrumentor = AG2Instrumentor