.NET: Add otel file logging and switch samples to projects client with store=true (#5924)

* Add otel file logging and switch samples to projects client with store=true * Fix formatting and remove rogue file
2026-06-16 21:04:09 +08:00 · 2026-05-18 18:39:29 +01:00
parent 7cea5e162a
commit eff36b504e
13 changed files with 216 additions and 46 deletions
@@ -0,0 +1,67 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using System.Diagnostics;
+using System.Globalization;
+using OpenTelemetry;
+
+namespace Harness.Shared.Console;
+
+/// <summary>
+/// A simple OpenTelemetry span exporter that writes completed activities (spans) to a text file.
+/// Each span is formatted as a human-readable block with timestamps, operation name, duration,
+/// status, and any tags/events.
+/// </summary>
+public sealed class FileSpanExporter : BaseExporter<Activity>
+{
+    private readonly string _filePath;
+    private readonly object _lock = new();
+
+    public FileSpanExporter(string filePath)
+    {
+        this._filePath = filePath;
+        Directory.CreateDirectory(Path.GetDirectoryName(filePath)!);
+    }
+
+    public override ExportResult Export(in Batch<Activity> batch)
+    {
+        lock (this._lock)
+        {
+            using var writer = new StreamWriter(this._filePath, append: true);
+            foreach (var activity in batch)
+            {
+                WriteActivity(writer, activity);
+            }
+        }
+
+        return ExportResult.Success;
+    }
+
+    private static void WriteActivity(StreamWriter writer, Activity activity)
+    {
+        var start = activity.StartTimeUtc.ToString("yyyy-MM-dd HH:mm:ss.fff", CultureInfo.InvariantCulture);
+        var duration = activity.Duration.TotalMilliseconds.ToString("F1", CultureInfo.InvariantCulture);
+
+        writer.WriteLine($"[{start}] {activity.OperationName} ({duration}ms) [{activity.Status}]");
+
+        if (!string.IsNullOrEmpty(activity.DisplayName) && activity.DisplayName != activity.OperationName)
+        {
+            writer.WriteLine($"  DisplayName: {activity.DisplayName}");
+        }
+
+        foreach (var tag in activity.Tags)
+        {
+            writer.WriteLine($"  {tag.Key}: {tag.Value}");
+        }
+
+        foreach (var ev in activity.Events)
+        {
+            writer.WriteLine($"  Event: {ev.Name} @ {ev.Timestamp:HH:mm:ss.fff}");
+            foreach (var tag in ev.Tags)
+            {
+                writer.WriteLine($"    {tag.Key}: {tag.Value}");
+            }
+        }
+
+        writer.WriteLine();
+    }
+}
@@ -0,0 +1,55 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+#pragma warning disable VSTHRD002 // Synchronous waits are required by OpenTelemetry enrichment callbacks.
+
+using OpenTelemetry;
+using OpenTelemetry.Trace;
+
+namespace Harness.Shared.Console;
+
+/// <summary>
+/// Provides factory methods for creating pre-configured OpenTelemetry tracing for harness samples.
+/// </summary>
+public static class HarnessTracing
+{
+    /// <summary>
+    /// Creates a <see cref="TracerProvider"/> that captures spans from the specified source and HTTP client activity,
+    /// enriching HTTP spans with full request/response headers and bodies, and exports all spans to a timestamped
+    /// text file in the application base directory.
+    /// </summary>
+    /// <param name="sourceName">The activity source name to subscribe to (e.g., "Harness.Research").</param>
+    /// <returns>A configured <see cref="TracerProvider"/>, or <see langword="null"/> if the builder returns null.</returns>
+    public static TracerProvider? CreateFileTracerProvider(string sourceName)
+    {
+        var traceLogPath = Path.Combine(AppContext.BaseDirectory, $"traces_{DateTime.UtcNow:yyyyMMdd_HHmmss}_{Guid.NewGuid()}.log");
+
+        return Sdk.CreateTracerProviderBuilder()
+            .AddSource(sourceName)
+            .AddHttpClientInstrumentation((options) =>
+            {
+                options.EnrichWithHttpRequestMessage = (activity, request) =>
+                {
+                    activity.SetTag("http.request.headers", request.Headers.ToString());
+                    if (request.Content != null)
+                    {
+                        activity.SetTag("http.request.content.headers", request.Content.Headers.ToString());
+                        var content = request.Content.ReadAsStringAsync().GetAwaiter().GetResult();
+                        activity.SetTag("http.request.content.body", content);
+                    }
+                };
+
+                options.EnrichWithHttpResponseMessage = (activity, response) =>
+                {
+                    activity.SetTag("http.response.headers", response.Headers.ToString());
+                    if (response.Content != null)
+                    {
+                        activity.SetTag("http.response.content.headers", response.Content.Headers.ToString());
+                        var content = response.Content.ReadAsStringAsync().GetAwaiter().GetResult();
+                        activity.SetTag("http.response.content.body", content);
+                    }
+                };
+            })
+            .AddProcessor(new SimpleActivityExportProcessor(new FileSpanExporter(traceLogPath)))
+            .Build();
+    }
+}
@@ -7,6 +7,11 @@
    <ImplicitUsings>enable</ImplicitUsings>
  </PropertyGroup>

+  <ItemGroup>
+    <PackageReference Include="OpenTelemetry" />
+    <PackageReference Include="OpenTelemetry.Instrumentation.Http" />
+  </ItemGroup>
+
  <ItemGroup>
    <ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI\Microsoft.Agents.AI.csproj" />
    <ProjectReference Include="..\ConsoleReactiveFramework\ConsoleReactiveFramework.csproj" />
@@ -13,8 +13,8 @@
  </ItemGroup>

  <ItemGroup>
+    <ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI.Foundry\Microsoft.Agents.AI.Foundry.csproj" />
    <ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI.Harness\Microsoft.Agents.AI.Harness.csproj" />
-    <ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI.OpenAI\Microsoft.Agents.AI.OpenAI.csproj" />
    <ProjectReference Include="..\Harness_Shared_Console\Harness_Shared_Console.csproj" />
  </ItemGroup>

@@ -16,20 +16,25 @@
 #pragma warning disable MAAI001  // Suppress experimental API warnings for Agents AI experiments.

 using System.ClientModel.Primitives;
+using Azure.AI.Projects;
 using Azure.Identity;
 using Harness.Shared.Console;
 using Harness.Shared.Console.ToolFormatters;
 using Microsoft.Agents.AI;
 using Microsoft.Extensions.AI;
-using OpenAI;
-using OpenAI.Responses;
 using SampleApp;

-var endpoint = Environment.GetEnvironmentVariable("AZURE_FOUNDRY_OPENAI_ENDPOINT") ?? throw new InvalidOperationException("AZURE_FOUNDRY_OPENAI_ENDPOINT is not set.");
+var endpoint = Environment.GetEnvironmentVariable("AZURE_AI_PROJECT_ENDPOINT") ?? throw new InvalidOperationException("AZURE_AI_PROJECT_ENDPOINT is not set.");
 var deploymentName = Environment.GetEnvironmentVariable("AZURE_AI_MODEL_DEPLOYMENT_NAME") ?? "gpt-5.4";

 const int MaxContextWindowTokens = 1_050_000;
 const int MaxOutputTokens = 128_000;
+const string TracingSourceName = "Harness.Research";
+
+// Set up OpenTelemetry tracing that writes spans to a text file.
+// This captures all agent activity (tool calls, model invocations, compaction, etc.)
+// as well as HTTP requests made by the underlying HttpClient transport.
+using var tracerProvider = HarnessTracing.CreateFileTracerProvider(TracingSourceName);

 // Create a HarnessAgent with the Harness providers (TodoProvider and AgentModeProvider)
 // and research-focused instructions including the mandatory planning workflow.
@@ -63,23 +68,22 @@ var instructions =
 // Only custom instructions, a WebBrowsingTool, and FileAccess opt-out are needed.
 AIAgent agent =
    // Create an OpenAIClient that communicates with the Foundry responses service.
-    new OpenAIClient(
+    new AIProjectClient(
+        new Uri(endpoint),
        // WARNING: DefaultAzureCredential is convenient for development but requires careful consideration in production.
        // In production, consider using a specific credential (e.g., ManagedIdentityCredential) to avoid
        // latency issues, unintended credential probing, and potential security risks from fallback mechanisms.
-        new BearerTokenPolicy(new DefaultAzureCredential(), "https://ai.azure.com/.default"),
-        new OpenAIClientOptions()
-        {
-            Endpoint = new Uri(endpoint),
-            RetryPolicy = new ClientRetryPolicy(3)          // Enable retries to improve resiliency.
-        })
+        new DefaultAzureCredential(),
+        new AIProjectClientOptions { RetryPolicy = new ClientRetryPolicy(3) })  // Enable retries to improve resiliency.
+    .GetProjectOpenAIClient()
    .GetResponsesClient()
-    .AsIChatClientWithStoredOutputDisabled(deploymentName)  // We want to manage chat history locally (not stored in the responses service), so that we can manage compaction ourselves.
+    .AsIChatClient(deploymentName)
    .AsHarnessAgent(MaxContextWindowTokens, MaxOutputTokens, new HarnessAgentOptions
    {
        Name = "ResearchAgent",
        Description = "A research assistant that plans and executes research tasks.",
-        DisableFileMemory = true,                           // If enabled, this would allow the agent to store memories as files in a directory associated with the current session
+        DisableFileAccess = true,                           // If enabled, this would allow the agent to read/write files in a working directory
+        OpenTelemetrySourceName = TracingSourceName,        // Use our custom source name so spans are captured by the TracerProvider above.
        FileMemoryStore = new FileSystemAgentFileStore(     // Configure the file memory provider to store files in a local folder called "agent-files".
            Path.Combine(AppContext.BaseDirectory, "agent-files")),
        ChatOptions = new ChatOptions
@@ -13,8 +13,8 @@
  </ItemGroup>

  <ItemGroup>
+    <ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI.Foundry\Microsoft.Agents.AI.Foundry.csproj" />
    <ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI.Harness\Microsoft.Agents.AI.Harness.csproj" />
-    <ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI.OpenAI\Microsoft.Agents.AI.OpenAI.csproj" />
    <ProjectReference Include="..\Harness_Shared_Console\Harness_Shared_Console.csproj" />
  </ItemGroup>

@@ -13,36 +13,41 @@
 #pragma warning disable MAAI001  // Suppress experimental API warnings for Agents AI experiments.

 using System.ClientModel.Primitives;
+using Azure.AI.Projects;
 using Azure.Identity;
 using Harness.Shared.Console;
 using Microsoft.Agents.AI;
 using Microsoft.Extensions.AI;
-using OpenAI;
-using OpenAI.Responses;

-var endpoint = Environment.GetEnvironmentVariable("AZURE_FOUNDRY_OPENAI_ENDPOINT") ?? throw new InvalidOperationException("AZURE_FOUNDRY_OPENAI_ENDPOINT is not set.");
+var endpoint = Environment.GetEnvironmentVariable("AZURE_AI_PROJECT_ENDPOINT") ?? throw new InvalidOperationException("AZURE_AI_PROJECT_ENDPOINT is not set.");
 var deploymentName = Environment.GetEnvironmentVariable("AZURE_AI_MODEL_DEPLOYMENT_NAME") ?? "gpt-5.4";

 const int MaxContextWindowTokens = 1_050_000;
 const int MaxOutputTokens = 128_000;
+const string TracingSourceName = "Harness.SubAgents";
+
+// Set up OpenTelemetry tracing that writes spans to a text file.
+using var tracerProvider = HarnessTracing.CreateFileTracerProvider(TracingSourceName);
+
+// Create the AIProjectClient for communicating with the Foundry responses service.
+var projectClient = new AIProjectClient(
+    new Uri(endpoint),
+    new DefaultAzureCredential(),
+    new AIProjectClientOptions { RetryPolicy = new ClientRetryPolicy(3) });

 // --- Background agent: Web Search Agent ---
 // This agent uses the HarnessAgent's built-in HostedWebSearchTool to search the web.
 // Features not needed by this sub-agent are disabled.
 AIAgent webSearchAgent =
-    new OpenAIClient(
-        new BearerTokenPolicy(new DefaultAzureCredential(), "https://ai.azure.com/.default"),
-        new OpenAIClientOptions()
-        {
-            Endpoint = new Uri(endpoint),
-            RetryPolicy = new ClientRetryPolicy(3)
-        })
+    projectClient
+    .GetProjectOpenAIClient()
    .GetResponsesClient()
-    .AsIChatClientWithStoredOutputDisabled(deploymentName)
+    .AsIChatClient(deploymentName)
    .AsHarnessAgent(MaxContextWindowTokens, MaxOutputTokens, new HarnessAgentOptions
    {
        Name = "WebSearchAgent",
        Description = "An agent that can search the web to find information.",
+        OpenTelemetrySourceName = TracingSourceName,
        DisableTodoProvider = true,
        DisableAgentModeProvider = true,
        DisableFileMemory = true,   // If enabled, this would allow the agent to store memories as files in a directory associated with the current session
@@ -82,19 +87,15 @@ var parentInstructions =
 // This agent orchestrates the sub-agent to look up stock prices in parallel.
 // Most features are disabled since the parent only needs SubAgentsProvider.
 AIAgent parentAgent =
-    new OpenAIClient(
-        new BearerTokenPolicy(new DefaultAzureCredential(), "https://ai.azure.com/.default"),
-        new OpenAIClientOptions()
-        {
-            Endpoint = new Uri(endpoint),
-            RetryPolicy = new ClientRetryPolicy(3)
-        })
+    projectClient
+    .GetProjectOpenAIClient()
    .GetResponsesClient()
-    .AsIChatClientWithStoredOutputDisabled(deploymentName)
+    .AsIChatClient(deploymentName)
    .AsHarnessAgent(MaxContextWindowTokens, MaxOutputTokens, new HarnessAgentOptions
    {
        Name = "StockPriceResearcher",
        Description = "An agent that researches stock prices using background agents.",
+        OpenTelemetrySourceName = TracingSourceName,
        DisableTodoProvider = true,
        DisableAgentModeProvider = true,
        DisableFileMemory = true,   // If enabled, this would allow the agent to store memories as files in a directory associated with the current session
@@ -13,8 +13,8 @@
  </ItemGroup>

  <ItemGroup>
+    <ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI.Foundry\Microsoft.Agents.AI.Foundry.csproj" />
    <ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI.Harness\Microsoft.Agents.AI.Harness.csproj" />
-    <ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI.OpenAI\Microsoft.Agents.AI.OpenAI.csproj" />
    <ProjectReference Include="..\Harness_Shared_Console\Harness_Shared_Console.csproj" />
  </ItemGroup>

@@ -16,18 +16,21 @@
 #pragma warning disable MAAI001  // Suppress experimental API warnings for Agents AI experiments.

 using System.ClientModel.Primitives;
+using Azure.AI.Projects;
 using Azure.Identity;
 using Harness.Shared.Console;
 using Microsoft.Agents.AI;
 using Microsoft.Extensions.AI;
-using OpenAI;
-using OpenAI.Responses;

-var endpoint = Environment.GetEnvironmentVariable("AZURE_FOUNDRY_OPENAI_ENDPOINT") ?? throw new InvalidOperationException("AZURE_FOUNDRY_OPENAI_ENDPOINT is not set.");
+var endpoint = Environment.GetEnvironmentVariable("AZURE_AI_PROJECT_ENDPOINT") ?? throw new InvalidOperationException("AZURE_AI_PROJECT_ENDPOINT is not set.");
 var deploymentName = Environment.GetEnvironmentVariable("AZURE_AI_MODEL_DEPLOYMENT_NAME") ?? "gpt-5.4";

 const int MaxContextWindowTokens = 1_050_000;
 const int MaxOutputTokens = 128_000;
+const string TracingSourceName = "Harness.DataProcessing";
+
+// Set up OpenTelemetry tracing that writes spans to a text file.
+using var tracerProvider = HarnessTracing.CreateFileTracerProvider(TracingSourceName);

 var instructions =
    """
@@ -58,19 +61,18 @@ var instructions =
 // sample's working/ folder (copied to the output directory) so it works regardless of cwd.
 // Unused features are disabled.
 AIAgent agent =
-    new OpenAIClient(
-        new BearerTokenPolicy(new DefaultAzureCredential(), "https://ai.azure.com/.default"),
-        new OpenAIClientOptions()
-        {
-            Endpoint = new Uri(endpoint),
-            RetryPolicy = new ClientRetryPolicy(3)
-        })
+    new AIProjectClient(
+        new Uri(endpoint),
+        new DefaultAzureCredential(),
+        new AIProjectClientOptions { RetryPolicy = new ClientRetryPolicy(3) })
+    .GetProjectOpenAIClient()
    .GetResponsesClient()
-    .AsIChatClientWithStoredOutputDisabled(deploymentName)
+    .AsIChatClient(deploymentName)
    .AsHarnessAgent(MaxContextWindowTokens, MaxOutputTokens, new HarnessAgentOptions
    {
        Name = "DataAnalyst",
        Description = "A data analyst assistant that reads, analyzes, and processes data files.",
+        OpenTelemetrySourceName = TracingSourceName,
        FileAccessStore = new FileSystemAgentFileStore(Path.Combine(AppContext.BaseDirectory, "working")),
        DisableTodoProvider = true,
        DisableAgentModeProvider = true,
@@ -130,7 +130,7 @@ public sealed class HarnessAgent : DelegatingAIAgent

        if (options?.DisableOpenTelemetry is not true)
        {
-            builder.UseOpenTelemetry();
+            builder.UseOpenTelemetry(sourceName: options?.OpenTelemetrySourceName);
        }

        return builder.Build();
@@ -183,6 +183,8 @@ public sealed class HarnessAgent : DelegatingAIAgent
                AIContextProviders = contextProviders,
                UseProvidedChatClientAsIs = true,
                RequirePerServiceCallChatHistoryPersistence = true,
+                WarnOnChatHistoryProviderConflict = false,
+                ThrowOnChatHistoryProviderConflict = false,
            });
    }

@@ -206,4 +206,16 @@ public sealed class HarnessAgentOptions
    /// following the Semantic Conventions for Generative AI systems.
    /// </remarks>
    public bool DisableOpenTelemetry { get; set; }
+
+    /// <summary>
+    /// Gets or sets the OpenTelemetry source name used by the <see cref="OpenTelemetryAgent"/> wrapper.
+    /// </summary>
+    /// <remarks>
+    /// When <see langword="null"/> (the default), the framework's default source name
+    /// (<c>"Experimental.Microsoft.Agents.AI"</c>) is used.
+    /// Set this to a custom value to enable filtering spans from a specific <see cref="System.Diagnostics.ActivitySource"/>
+    /// in your <c>TracerProvider</c> configuration.
+    /// This property is ignored when <see cref="DisableOpenTelemetry"/> is <see langword="true"/>.
+    /// </remarks>
+    public string? OpenTelemetrySourceName { get; set; }
 }
@@ -31,6 +31,7 @@ public class HarnessAgentOptionsTests
        Assert.False(options.DisableAgentModeProvider);
        Assert.False(options.DisableAgentSkillsProvider);
        Assert.False(options.DisableOpenTelemetry);
+        Assert.Null(options.OpenTelemetrySourceName);
        Assert.Null(options.MaximumIterationsPerRequest);
        Assert.Null(options.FileMemoryStore);
        Assert.Null(options.FileAccessStore);
@@ -75,6 +76,7 @@ public class HarnessAgentOptionsTests
            DisableAgentSkillsProvider = true,
            AgentSkillsSource = skillsSource,
            DisableOpenTelemetry = true,
+            OpenTelemetrySourceName = "custom-source",
        };

        // Assert
@@ -100,5 +102,6 @@ public class HarnessAgentOptionsTests
        Assert.True(options.DisableAgentSkillsProvider);
        Assert.Same(skillsSource, options.AgentSkillsSource);
        Assert.True(options.DisableOpenTelemetry);
+        Assert.Equal("custom-source", options.OpenTelemetrySourceName);
    }
 }
@@ -678,6 +678,25 @@ public class HarnessAgentTests
        Assert.Null(agent.GetService<OpenTelemetryAgent>());
    }

+    /// <summary>
+    /// Verify that a custom OpenTelemetrySourceName is accepted without error.
+    /// </summary>
+    [Fact]
+    public void OpenTelemetry_CustomSourceNameIsAccepted()
+    {
+        // Arrange
+        var chatClient = new Mock<IChatClient>().Object;
+        var options = CreateAllDisabledOptions();
+        options.DisableOpenTelemetry = false;
+        options.OpenTelemetrySourceName = "MyApp.AgentTracing";
+
+        // Act
+        var agent = new HarnessAgent(chatClient, TestMaxContextWindowTokens, TestMaxOutputTokens, options);
+
+        // Assert
+        Assert.NotNull(agent.GetService<OpenTelemetryAgent>());
+    }
+
    #endregion

    #region Feature: WebSearch