update conventions and address feedback

lmolkova · lmolkova · commit 533eab7d96f5 · 2025-04-11T17:37:50.000-07:00
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -58,6 +58,10 @@
     <PackageVersion Include="Moq" Version="4.20.72" />
     <PackageVersion Include="OpenTelemetry" Version="1.11.2" />
     <PackageVersion Include="OpenTelemetry.Exporter.InMemory" Version="1.11.2" />
+    <PackageVersion Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.11.2" />
+    <PackageVersion Include="OpenTelemetry.Instrumentation.Http " Version="1.11.0" />
+    <PackageVersion Include="OpenTelemetry.Extensions.Hosting" Version="1.11.2"  />
+    <PackageVersion Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.11.1"  />
     <PackageVersion Include="Serilog.Extensions.Hosting" Version="9.0.0" />
     <PackageVersion Include="Serilog.Extensions.Logging" Version="9.0.0" />
     <PackageVersion Include="Serilog.Sinks.Console" Version="6.0.0" />
@@ -67,10 +71,5 @@
     <PackageVersion Include="xunit.v3" Version="2.0.1" />
     <PackageVersion Include="xunit.runner.visualstudio" Version="3.0.2" />
     <PackageVersion Include="System.Net.Http" Version="4.3.4" />
-    <PackageVersion Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.11.2" />
-    <PackageVersion Include="OpenTelemetry.Instrumentation.Http " Version="1.11.0" />
-    <PackageVersion Include="OpenTelemetry.Extensions.Hosting" Version="1.11.2"  />
-    <PackageVersion Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.11.1"  />
-
   </ItemGroup>
 </Project>
diff --git a/samples/AspNetCoreSseServer/Program.cs b/samples/AspNetCoreSseServer/Program.cs
@@ -1,30 +1,22 @@
 using TestServerWithHosting.Tools;
-using OpenTelemetry.Logs;
 using OpenTelemetry.Metrics;
-using OpenTelemetry.Resources;
 using OpenTelemetry.Trace;
-using AspNetCoreSseServer.Tools;
+using OpenTelemetry;
 
 var builder = WebApplication.CreateBuilder(args);
 builder.Services.AddMcpServer()
     .WithTools<EchoTool>()
-    .WithTools<SampleLlmTool>()
-    .WithTools<LongRunningTool>();
+    .WithTools<SampleLlmTool>();
 
-var resource = ResourceBuilder.CreateEmpty().AddService("mcp.server");
 builder.Services.AddOpenTelemetry()
-    .WithTracing(b => b.SetResourceBuilder(resource)
-        .AddOtlpExporter()
-        .AddSource("*")
+    .WithTracing(b => b.AddSource("*")
         .AddAspNetCoreInstrumentation()
         .AddHttpClientInstrumentation())
-    .WithMetrics(b => b.SetResourceBuilder(resource)
-        .AddMeter("*")
-        .AddOtlpExporter()
+    .WithMetrics(b => b.AddMeter("*")
         .AddAspNetCoreInstrumentation()
         .AddHttpClientInstrumentation())
-    .WithLogging(b => b.SetResourceBuilder(resource)
-        .AddOtlpExporter());
+    .WithLogging()
+    .UseOtlpExporter();
 
 var app = builder.Build();
 
diff --git a/samples/AspNetCoreSseServer/Properties/launchSettings.json b/samples/AspNetCoreSseServer/Properties/launchSettings.json
@@ -6,15 +6,17 @@
       "dotnetRunMessages": true,
       "applicationUrl": "http://localhost:3001",
       "environmentVariables": {
-        "ASPNETCORE_ENVIRONMENT": "Development"
+        "ASPNETCORE_ENVIRONMENT": "Development",
+        "OTEL_SERVICE_NAME": "sse-server",
       }
     },
     "https": {
       "commandName": "Project",
       "dotnetRunMessages": true,
       "applicationUrl": "https://localhost:7133;http://localhost:3001",
       "environmentVariables": {
-        "ASPNETCORE_ENVIRONMENT": "Development"
+        "ASPNETCORE_ENVIRONMENT": "Development",
+        "OTEL_SERVICE_NAME": "sse-server",
       }
     }
   }
diff --git a/samples/ChatWithTools/Program.cs b/samples/ChatWithTools/Program.cs
@@ -5,11 +5,9 @@
 
 using OpenTelemetry;
 using OpenTelemetry.Trace;
-using System.Diagnostics;
 using Microsoft.Extensions.Logging;
 using OpenTelemetry.Logs;
 using OpenTelemetry.Metrics;
-using ModelContextProtocol.Protocol.Messages;
 using ModelContextProtocol.Protocol.Types;
 
 using var tracerProvider = Sdk.CreateTracerProviderBuilder()
@@ -22,32 +20,21 @@
     .AddMeter("*")
     .AddOtlpExporter()
     .Build();
-
-using var loggerFactory = LoggerFactory.Create(builder =>
-    {
-        builder.AddOpenTelemetry(opt =>
-        {
-            opt.IncludeFormattedMessage = true;
-            opt.IncludeScopes = true;
-            opt.AddOtlpExporter();
-        });
-    });
+using var loggerFactory = LoggerFactory.Create(builder => builder.AddOpenTelemetry(opt => opt.AddOtlpExporter()));
 
 // Connect to an MCP server
-Console.WriteLine("Connecting client to MCP 'aspnetcore' server");
+Console.WriteLine("Connecting client to MCP 'everything' server");
 
-
-// Create an IChatClient. (This shows using OpenAIClient, but it could be any other IChatClient implementation.)
+// Create OpenAI client (or any other compatible with IChatClient)
 // Provide your own OPENAI_API_KEY via an environment variable.
-using IChatClient chatClient =
-    new OpenAIClient(Environment.GetEnvironmentVariable("OPENAI_API_KEY")).GetChatClient("gpt-4o-mini").AsIChatClient()
+var openAIClient = new OpenAIClient(Environment.GetEnvironmentVariable("OPENAI_API_KEY")).GetChatClient("gpt-4o-mini");
+
+// Create a sampling client.
+using IChatClient samplingClient = openAIClient.AsIChatClient()
     .AsBuilder()
-    .UseFunctionInvocation()
     .UseOpenTelemetry(loggerFactory: loggerFactory, configure: o => o.EnableSensitiveData = true)
     .Build();
 
-var samplingHandler = chatClient.CreateSamplingHandler();
-
 var mcpClient = await McpClientFactory.CreateAsync(
     new StdioClientTransport(new()
     {
@@ -59,10 +46,7 @@
     {
         Capabilities = new ClientCapabilities()
         {
-            Sampling = new SamplingCapability() { SamplingHandler = (param, progress, ct) => {
-                Console.WriteLine(param?.Meta?.ProgressToken);
-                return samplingHandler(param, progress, ct);
-            } }
+            Sampling = new SamplingCapability() { SamplingHandler = samplingClient.CreateSamplingHandler() }
         },
     },
     loggerFactory: loggerFactory);
@@ -77,6 +61,13 @@
 
 Console.WriteLine();
 
+// Create an IChatClient that can use the tools.
+using IChatClient chatClient = openAIClient.AsIChatClient()
+    .AsBuilder()
+    .UseFunctionInvocation()
+    .UseOpenTelemetry(loggerFactory: loggerFactory, configure: o => o.EnableSensitiveData = true)
+    .Build();
+
 // Have a conversation, making all tools available to the LLM.
 List<ChatMessage> messages = [];
 while (true)
diff --git a/samples/EverythingServer/EverythingServer.csproj b/samples/EverythingServer/EverythingServer.csproj
@@ -11,7 +11,6 @@
     <PackageReference Include="Microsoft.Extensions.Hosting" />
     <PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" />
     <PackageReference Include="OpenTelemetry.Extensions.Hosting" />
-    <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" />
     <PackageReference Include="OpenTelemetry.Instrumentation.Http" />
   </ItemGroup>
 
diff --git a/samples/EverythingServer/Program.cs b/samples/EverythingServer/Program.cs
@@ -8,6 +8,7 @@
 using ModelContextProtocol;
 using ModelContextProtocol.Protocol.Types;
 using ModelContextProtocol.Server;
+using OpenTelemetry;
 using OpenTelemetry.Logs;
 using OpenTelemetry.Metrics;
 using OpenTelemetry.Resources;
@@ -190,21 +191,12 @@ await ctx.Server.RequestSamplingAsync([
         return new EmptyResult();
     });
 
-
-var resource = ResourceBuilder.CreateEmpty().AddService("mcp.server");
+ResourceBuilder resource = ResourceBuilder.CreateDefault().AddService("everything-server");
 builder.Services.AddOpenTelemetry()
-    .WithTracing(b => b.SetResourceBuilder(resource)
-        .AddOtlpExporter()
-        .AddSource("*")
-        .AddAspNetCoreInstrumentation()
-        .AddHttpClientInstrumentation())
-    .WithMetrics(b => b.SetResourceBuilder(resource)
-        .AddMeter("*")
-        .AddOtlpExporter()
-        .AddAspNetCoreInstrumentation()
-        .AddHttpClientInstrumentation())
-    .WithLogging(b => b.SetResourceBuilder(resource)
-        .AddOtlpExporter());
+    .WithTracing(b => b.AddSource("*").AddHttpClientInstrumentation().SetResourceBuilder(resource))
+    .WithMetrics(b => b.AddMeter("*").AddHttpClientInstrumentation().SetResourceBuilder(resource))
+    .WithLogging(b => b.SetResourceBuilder(resource))
+    .UseOtlpExporter();
 
 builder.Services.AddSingleton(subscriptions);
 builder.Services.AddHostedService<SubscriptionMessageSender>();
diff --git a/src/ModelContextProtocol/Diagnostics.cs b/src/ModelContextProtocol/Diagnostics.cs
@@ -1,5 +1,8 @@
 ﻿using System.Diagnostics;
 using System.Diagnostics.Metrics;
+using System.Text.Json;
+using System.Text.Json.Nodes;
+using ModelContextProtocol.Protocol.Messages;
 
 namespace ModelContextProtocol;
 
@@ -34,4 +37,79 @@ internal static Histogram<double> CreateDurationHistogram(string name, string de
         HistogramBucketBoundaries = [0.01, 0.02, 0.05, 0.1, 0.2, 0.5, 1, 2, 5, 10, 30, 60, 120, 300],
     };
 #endif
+
+    internal static ActivityContext ExtractActivityContext(this DistributedContextPropagator propagator, IJsonRpcMessage message)
+    {
+        string? traceparent = null;
+        string? tracestate = null;
+        propagator?.ExtractTraceIdAndState(message, ExtractContext, out traceparent, out tracestate);
+        ActivityContext.TryParse(traceparent, tracestate, true, out var activityContext);
+        return activityContext;
+    }
+
+    private static void ExtractContext(object? message, string fieldName, out string? fieldValue, out IEnumerable<string>? fieldValues)
+    {
+        fieldValues = null;
+        fieldValue = null;
+
+        JsonNode? parameters = null;
+        switch (message)
+        {
+            case JsonRpcRequest request:
+                parameters = request.Params;
+                break;
+
+            case JsonRpcNotification notification:
+                parameters = notification.Params;
+                break;
+
+            default:
+                break;
+        }
+
+        if (parameters?[fieldName] is JsonValue value && value.GetValueKind() == JsonValueKind.String)
+        {
+            fieldValue = value.GetValue<string>();
+        }
+    }
+
+    internal static void InjectActivityContext(this DistributedContextPropagator propagator, Activity? activity, IJsonRpcMessage message)
+    {
+        // noop if activity is null
+        propagator?.Inject(activity, message, InjectContext);
+    }
+
+    private static void InjectContext(object? message, string key, string value)
+    {
+        JsonNode? parameters = null;
+        switch (message)
+        {
+            case JsonRpcRequest request:
+                parameters = request.Params;
+                break;
+
+            case JsonRpcNotification notification:
+                parameters = notification.Params;
+                break;
+
+            default:
+                break;
+        }
+
+        if (parameters is JsonObject jsonObject && jsonObject[key] == null)
+        {
+            jsonObject[key] = value;
+        }
+    }
+
+    internal static bool ShouldInstrumentMessage(IJsonRpcMessage message) =>
+        ActivitySource.HasListeners() &&
+        message switch
+        {
+            JsonRpcRequest => true,
+            JsonRpcNotification notification => notification.Method != NotificationMethods.LoggingMessageNotification,
+            _ => false
+        };
+
+    internal static ActivityLink[] ActivityLinkFromCurrent() => Activity.Current is null ? [] : [new ActivityLink(Activity.Current.Context)];
 }
diff --git a/src/ModelContextProtocol/Shared/McpSession.cs b/src/ModelContextProtocol/Shared/McpSession.cs
diff --git a/tests/ModelContextProtocol.Tests/DiagnosticTests.cs b/tests/ModelContextProtocol.Tests/DiagnosticTests.cs

Original file line number	Diff line number	Diff line change
`@@ -6,15 +6,17 @@`
`6`	`6`	`"dotnetRunMessages": true,`
`7`	`7`	`"applicationUrl": "http://localhost:3001",`
`8`	`8`	`"environmentVariables": {`
`9`		`- "ASPNETCORE_ENVIRONMENT": "Development"`
	`9`	`+ "ASPNETCORE_ENVIRONMENT": "Development",`
	`10`	`+ "OTEL_SERVICE_NAME": "sse-server",`
`10`	`11`	`}`
`11`	`12`	`},`
`12`	`13`	`"https": {`
`13`	`14`	`"commandName": "Project",`
`14`	`15`	`"dotnetRunMessages": true,`
`15`	`16`	`"applicationUrl": "https://localhost:7133;http://localhost:3001",`
`16`	`17`	`"environmentVariables": {`
`17`		`- "ASPNETCORE_ENVIRONMENT": "Development"`
	`18`	`+ "ASPNETCORE_ENVIRONMENT": "Development",`
	`19`	`+ "OTEL_SERVICE_NAME": "sse-server",`
`18`	`20`	`}`
`19`	`21`	`}`
`20`	`22`	`}`