enable-observability

Enabling observability for Agents

::: zone pivot="programming-language-csharp"

This tutorial shows how to enable OpenTelemetry on an agent so that interactions with the agent are automatically logged and exported. In this tutorial, output is written to the console using the OpenTelemetry console exporter.

[!NOTE] For more information about the standards followed by Microsoft Agent Framework, see Semantic Conventions for GenAI agent and framework spans from Open Telemetry.

Prerequisites

For prerequisites, see the Create and run a simple agent step in this tutorial.

Install NuGet packages

To use Microsoft Agent Framework with Azure OpenAI, you need to install the following NuGet packages:

dotnet add package Azure.AI.OpenAI --prerelease
dotnet add package Azure.Identity
dotnet add package Microsoft.Agents.AI.OpenAI --prerelease

To also add OpenTelemetry support, with support for writing to the console, install these additional packages:

dotnet add package OpenTelemetry
dotnet add package OpenTelemetry.Exporter.Console

Enable OpenTelemetry in your app

Enable Agent Framework telemetry and create an OpenTelemetry TracerProvider that exports to the console. The TracerProvider must remain alive while you run the agent so traces are exported.

using System;
using OpenTelemetry;
using OpenTelemetry.Trace;

// Create a TracerProvider that exports to the console
using var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .AddSource("agent-telemetry-source")
    .AddConsoleExporter()
    .Build();

Create and instrument the agent

Create an agent, and using the builder pattern, call UseOpenTelemetry to provide a source name. Note that the string literal agent-telemetry-source is the OpenTelemetry source name that you used when you created the tracer provider.

using System;
using Azure.AI.OpenAI;
using Azure.Identity;
using Microsoft.Agents.AI;
using OpenAI;

// Create the agent and enable OpenTelemetry instrumentation
AIAgent agent = new AzureOpenAIClient(
    new Uri("https://<myresource>.openai.azure.com"),
    new AzureCliCredential())
        .GetChatClient("gpt-4o-mini")
        .AsAIAgent(instructions: "You are good at telling jokes.", name: "Joker")
        .AsBuilder()
        .UseOpenTelemetry(sourceName: "agent-telemetry-source")
        .Build();