mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Copilot
90964acd2d
* Initial plan * Add LoggingAgent class and UseLogging extension method Co-authored-by: rogerbarreto <19890735+rogerbarreto@users.noreply.github.com> * Add unit tests for LoggingAgent and fix JSON serialization error handling Co-authored-by: rogerbarreto <19890735+rogerbarreto@users.noreply.github.com> * Add comments explaining unreachable code in test async iterators Co-authored-by: rogerbarreto <19890735+rogerbarreto@users.noreply.github.com> * Fix file encoding - add UTF-8 BOM to all C# files Co-authored-by: rogerbarreto <19890735+rogerbarreto@users.noreply.github.com> * Address Format issues * Addres format * Break up extensions in dedicated files * Adjust class names * Add xmldoc info --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: rogerbarreto <19890735+rogerbarreto@users.noreply.github.com>
59 lines
2.8 KiB
C#
59 lines
2.8 KiB
C#
// Copyright (c) Microsoft. All rights reserved.
|
|
|
|
using System;
|
|
using Microsoft.Shared.Diagnostics;
|
|
|
|
namespace Microsoft.Agents.AI;
|
|
|
|
/// <summary>
|
|
/// Provides extension methods for adding OpenTelemetry instrumentation to <see cref="AIAgentBuilder"/> instances.
|
|
/// </summary>
|
|
public static class OpenTelemetryAgentBuilderExtensions
|
|
{
|
|
/// <summary>
|
|
/// Adds OpenTelemetry instrumentation to the agent pipeline, enabling comprehensive observability for agent operations.
|
|
/// </summary>
|
|
/// <param name="builder">The <see cref="AIAgentBuilder"/> to which OpenTelemetry support will be added.</param>
|
|
/// <param name="sourceName">
|
|
/// An optional source name that will be used to identify telemetry data from this agent.
|
|
/// If not specified, a default source name will be used.
|
|
/// </param>
|
|
/// <param name="configure">
|
|
/// An optional callback that provides additional configuration of the <see cref="OpenTelemetryAgent"/> instance.
|
|
/// This allows for fine-tuning telemetry behavior such as enabling sensitive data collection.
|
|
/// </param>
|
|
/// <returns>The <see cref="AIAgentBuilder"/> with OpenTelemetry instrumentation added, enabling method chaining.</returns>
|
|
/// <exception cref="ArgumentNullException"><paramref name="builder"/> is <see langword="null"/>.</exception>
|
|
/// <remarks>
|
|
/// <para>
|
|
/// This extension adds comprehensive telemetry capabilities to AI agents, including:
|
|
/// <list type="bullet">
|
|
/// <item><description>Distributed tracing of agent invocations</description></item>
|
|
/// <item><description>Performance metrics and timing information</description></item>
|
|
/// <item><description>Request and response payload logging (when enabled)</description></item>
|
|
/// <item><description>Error tracking and exception details</description></item>
|
|
/// <item><description>Usage statistics and token consumption metrics</description></item>
|
|
/// </list>
|
|
/// </para>
|
|
/// <para>
|
|
/// The implementation follows the OpenTelemetry Semantic Conventions for Generative AI systems as defined at
|
|
/// <see href="https://opentelemetry.io/docs/specs/semconv/gen-ai/"/>.
|
|
/// </para>
|
|
/// <para>
|
|
/// Note: The OpenTelemetry specification for Generative AI is still experimental and subject to change.
|
|
/// As the specification evolves, the telemetry output from this agent may also change to maintain compliance.
|
|
/// </para>
|
|
/// </remarks>
|
|
public static AIAgentBuilder UseOpenTelemetry(
|
|
this AIAgentBuilder builder,
|
|
string? sourceName = null,
|
|
Action<OpenTelemetryAgent>? configure = null) =>
|
|
Throw.IfNull(builder).Use((innerAgent, services) =>
|
|
{
|
|
var agent = new OpenTelemetryAgent(innerAgent, sourceName);
|
|
configure?.Invoke(agent);
|
|
|
|
return agent;
|
|
});
|
|
}
|