Skip to content

instrument_agent

autogen.opentelemetry.instrument_agent #

instrument_agent(agent, *, tracer_provider)

Instrument an agent with OpenTelemetry tracing.

Instruments various agent methods to emit OpenTelemetry spans for: - Agent invocations (generate_reply, a_generate_reply) - Conversations (initiate_chat, a_initiate_chat, resume) - Tool execution (execute_function, a_execute_function) - Code execution - Human input requests - Remote agent calls

PARAMETER DESCRIPTION
agent

The agent instance to instrument.

TYPE: Agent

tracer_provider

The OpenTelemetry tracer provider to use for creating spans.

TYPE: TracerProvider

RETURNS DESCRIPTION
Agent

The instrumented agent instance (same object, modified in place).
Usage

from opentelemetry import trace from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter from opentelemetry.sdk.resources import Resource from opentelemetry.sdk.trace import TracerProvider from opentelemetry.sdk.trace.export import BatchSpanProcessor from autogen.opentelemetry import instrument_agent

resource = Resource.create(attributes={"service.name": "my-service"}) tracer_provider = TracerProvider(resource=resource) exporter = OTLPSpanExporter(endpoint="http://127.0.0.1:4317") processor = BatchSpanProcessor(exporter) tracer_provider.add_span_processor(processor) trace.set_tracer_provider(tracer_provider)

agent = AssistantAgent("assistant") instrument_agent(agent, tracer_provider=tracer_provider)

Source code in autogen/opentelemetry/instrumentators/agent.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
@export_module("autogen.opentelemetry")
def instrument_agent(agent: Agent, *, tracer_provider: TracerProvider) -> Agent:
    """Instrument an agent with OpenTelemetry tracing.

    Instruments various agent methods to emit OpenTelemetry spans for:
    - Agent invocations (generate_reply, a_generate_reply)
    - Conversations (initiate_chat, a_initiate_chat, resume)
    - Tool execution (execute_function, a_execute_function)
    - Code execution
    - Human input requests
    - Remote agent calls

    Args:
        agent: The agent instance to instrument.
        tracer_provider: The OpenTelemetry tracer provider to use for creating spans.

    Returns:
        The instrumented agent instance (same object, modified in place).

    Usage:
        from opentelemetry import trace
        from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
        from opentelemetry.sdk.resources import Resource
        from opentelemetry.sdk.trace import TracerProvider
        from opentelemetry.sdk.trace.export import BatchSpanProcessor
        from autogen.opentelemetry import instrument_agent

        resource = Resource.create(attributes={"service.name": "my-service"})
        tracer_provider = TracerProvider(resource=resource)
        exporter = OTLPSpanExporter(endpoint="http://127.0.0.1:4317")
        processor = BatchSpanProcessor(exporter)
        tracer_provider.add_span_processor(processor)
        trace.set_tracer_provider(tracer_provider)

        agent = AssistantAgent("assistant")
        instrument_agent(agent, tracer_provider=tracer_provider)
    """
    tracer = get_tracer(tracer_provider)

    agent = instrument_initiate_chats(agent, tracer=tracer)
    agent = instrument_generate_reply(agent, tracer=tracer)
    agent = instrument_generate_oai_reply(agent, tracer=tracer)
    agent = instrument_initiate_chat(agent, tracer=tracer)
    agent = instrument_resume(agent, tracer=tracer)
    agent = instrument_run_chat(agent, tracer=tracer)
    agent = instrument_remote_reply(agent, tracer=tracer)
    agent = instrument_execute_function(agent, tracer=tracer)
    agent = instrument_create_or_get_executor(
        agent,
        instrumentator=partial(instrument_agent, tracer_provider=tracer_provider),
    )
    agent = instrument_human_input(agent, tracer=tracer)
    agent = instrument_code_execution(agent, tracer=tracer)

    return agent