Observability for Microsoft Agent Framework (.NET) with Opik

1
using Microsoft.Agents.AI;
2
using Microsoft.Extensions.AI;
3
using Microsoft.Extensions.DependencyInjection;
4
using Microsoft.Extensions.Hosting;
5
using OpenAI;
6
using OpenTelemetry;
7
using OpenTelemetry.Resources;
8
using OpenTelemetry.Trace;
9
10
#pragma warning disable OPENAI001
11
12
const string SourceName = "AgentFramework";
13
14
// Create host with OpenTelemetry configuration
15
var builder = Host.CreateApplicationBuilder(args);
16
17
// Configure OpenTelemetry
18
builder.Services.AddOpenTelemetry()
19
    .ConfigureResource(resource => resource
20
        .AddService(serviceName: "agent-framework-demo", serviceVersion: "1.0.0"))
21
    .WithTracing(tracing => tracing
22
        .AddSource(SourceName)                      // Our custom spans
23
        .AddSource("*Microsoft.Extensions.AI")      // Chat client telemetry
24
        .AddSource("*Microsoft.Extensions.Agents*") // Agent telemetry
25
        .AddHttpClientInstrumentation()             // HTTP calls
26
        .AddOtlpExporter());                        // Reads OTEL_EXPORTER_OTLP_* env vars automatically
27
28
var host = builder.Build();
29
await host.StartAsync();
30
31
// Create instrumented chat client
32
// Note: OpenAI SDK requires explicit API key, but you can read from env var
33
var apiKey = Environment.GetEnvironmentVariable("OPENAI_API_KEY") 
34
    ?? throw new InvalidOperationException("OPENAI_API_KEY environment variable is required");
35
36
using var instrumentedChatClient = new OpenAIClient(apiKey)
37
    .GetChatClient("gpt-4o-mini")
38
    .AsIChatClient()                    // Convert to Microsoft.Extensions.AI.IChatClient
39
    .AsBuilder()
40
    .UseOpenTelemetry(                  // Enable telemetry on chat client
41
        sourceName: SourceName,
42
        configure: (cfg) => cfg.EnableSensitiveData = true)
43
    .Build();
44
45
// Create instrumented agent
46
var agent = new ChatClientAgent(
47
    instrumentedChatClient,
48
    name: "Assistant",
49
    instructions: "You are a helpful assistant.")
50
    .AsBuilder()
51
    .UseOpenTelemetry(SourceName)       // Enable telemetry on agent
52
    .Build();
53
54
// Run agent - telemetry is automatic!
55
Console.WriteLine(await agent.RunAsync("Write a haiku about AI agents."));
56
57
// Ensure traces are flushed
58
var tracerProvider = host.Services.GetService<TracerProvider>();
59
tracerProvider?.ForceFlush();
60
await Task.Delay(2000);
61
62
await host.StopAsync();