CustomProperty improvements

src/OpenTelemetry.Instrumentation.AspNet/AspNetInstrumentationOptions.cs

@@ -15,6 +15,7 @@
 // </copyright>
 
 using System;
+using System.Diagnostics;
 using System.Web;
 using OpenTelemetry.Context.Propagation;
 
@@ -41,5 +42,10 @@ public class AspNetInstrumentationOptions
         /// If Filter returns false or throw exception, the request is filtered out.
         /// </summary>
         public Func<HttpContext, bool> Filter { get; set; }
+
+        /// <summary>
+        /// Gets or sets an action to enrich an Activity.
+        /// </summary>
+        public Action<Activity, string, object> Enrich { get; set; }
     }
 }

src/OpenTelemetry.Instrumentation.AspNet/Implementation/HttpInListener.cs

@@ -109,7 +109,8 @@ public override void OnStartActivity(Activity activity, object payload)
 
             if (activity.IsAllDataRequested)
             {
-                activity.SetCustomProperty(RequestCustomPropertyName, request);
+                this.options.Enrich?.Invoke(activity, "OnStartActivity", request);
+
                 if (request.Url.Port == 80 || request.Url.Port == 443)
                 {
                     activity.SetTag(SemanticConventions.AttributeHttpHost, request.Url.Host);
@@ -159,7 +160,8 @@ public override void OnStopActivity(Activity activity, object payload)
 
                 var response = context.Response;
 
-                activityToEnrich.SetCustomProperty(ResponseCustomPropertyName, response);
+                this.options.Enrich?.Invoke(activity, "OnStopActivity", response);
+
                 activityToEnrich.SetTag(SemanticConventions.AttributeHttpStatusCode, response.StatusCode);
 
                 activityToEnrich.SetStatus(

src/OpenTelemetry.Instrumentation.AspNetCore/AspNetCoreInstrumentationOptions.cs

@@ -15,6 +15,7 @@
 // </copyright>
 
 using System;
+using System.Diagnostics;
 using Microsoft.AspNetCore.Http;
 using OpenTelemetry.Context.Propagation;
 
@@ -41,5 +42,10 @@ public class AspNetCoreInstrumentationOptions
         /// If Filter returns false or throw exception, the request is filtered out.
         /// </summary>
         public Func<HttpContext, bool> Filter { get; set; }
+
+        /// <summary>
+        /// Gets or sets an action to enrich an Activity.
+        /// </summary>
+        public Action<Activity, string, object> Enrich { get; set; }
     }
 }

src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInListener.cs

@@ -112,7 +112,7 @@ public override void OnStartActivity(Activity activity, object payload)
 
             if (activity.IsAllDataRequested)
             {
-                activity.SetCustomProperty(RequestCustomPropertyName, request);
+                this.options.Enrich?.Invoke(activity, "OnStartActivity", request);
 
                 var path = (request.PathBase.HasValue || request.Path.HasValue) ? (request.PathBase + request.Path).ToString() : "/";
                 activity.DisplayName = path;
@@ -152,7 +152,9 @@ public override void OnStopActivity(Activity activity, object payload)
                 }
 
                 var response = context.Response;
-                activity.SetCustomProperty(ResponseCustomPropertyName, response);
+
+                this.options.Enrich?.Invoke(activity, "OnStopActivity", response);
+
                 activity.SetTag(SemanticConventions.AttributeHttpStatusCode, response.StatusCode);
 
                 if (TryGetGrpcMethod(activity, out var grpcMethod))

src/OpenTelemetry.Instrumentation.GrpcNetClient/GrpcClientInstrumentationOptions.cs

@@ -14,6 +14,9 @@
 // limitations under the License.
 // </copyright>
 
+using System;
+using System.Diagnostics;
+
 namespace OpenTelemetry.Instrumentation.GrpcNetClient
 {
     /// <summary>
@@ -25,5 +28,10 @@ public class GrpcClientInstrumentationOptions
         /// Gets or sets a value indicating whether down stream instrumentation is suppressed (disabled).
         /// </summary>
         public bool SuppressDownstreamInstrumentation { get; set; }
+
+        /// <summary>
+        /// Gets or sets an action to enrich an Activity.
+        /// </summary>
+        public Action<Activity, string, object> Enrich { get; set; }
     }
 }

src/OpenTelemetry.Instrumentation.GrpcNetClient/Implementation/GrpcClientDiagnosticListener.cs

@@ -61,7 +61,8 @@ public override void OnStartActivity(Activity activity, object payload)
 
             if (activity.IsAllDataRequested)
             {
-                activity.SetCustomProperty(RequestCustomPropertyName, request);
+                this.options.Enrich?.Invoke(activity, "OnStartActivity", request);
+
                 activity.SetTag(SemanticConventions.AttributeRpcSystem, GrpcTagHelper.RpcSystemGrpc);
 
                 if (GrpcTagHelper.TryParseRpcServiceAndRpcMethod(grpcMethod, out var rpcService, out var rpcMethod))

src/OpenTelemetry.Instrumentation.Http/HttpClientInstrumentationOptions.cs

@@ -15,6 +15,7 @@
 // </copyright>
 
 using System;
+using System.Diagnostics;
 using System.Net.Http;
 using System.Runtime.CompilerServices;
 using OpenTelemetry.Context.Propagation;
@@ -50,6 +51,11 @@ public class HttpClientInstrumentationOptions
         /// </summary>
         public Func<HttpRequestMessage, bool> Filter { get; set; }
 
+        /// <summary>
+        /// Gets or sets an action to enrich an Activity.
+        /// </summary>
+        public Action<Activity, string, object> Enrich { get; set; }
+
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         internal bool EventFilter(string activityName, object arg1)
         {

src/OpenTelemetry.Instrumentation.Http/Implementation/HttpHandlerDiagnosticListener.cs

@@ -99,7 +99,8 @@ public override void OnStartActivity(Activity activity, object payload)
 
             if (activity.IsAllDataRequested)
             {
-                activity.SetCustomProperty(RequestCustomPropertyName, request);
+                this.options.Enrich?.Invoke(activity, "OnStartActivity", request);
+
                 activity.SetTag(SemanticConventions.AttributeHttpMethod, HttpTagHelper.GetNameForHttpMethod(request.Method));
                 activity.SetTag(SemanticConventions.AttributeHttpHost, HttpTagHelper.GetHostTagValueFromRequestUri(request.RequestUri));
                 activity.SetTag(SemanticConventions.AttributeHttpUrl, request.RequestUri.OriginalString);
@@ -139,7 +140,7 @@ public override void OnStopActivity(Activity activity, object payload)
 
                 if (this.stopResponseFetcher.Fetch(payload) is HttpResponseMessage response)
                 {
-                    activity.SetCustomProperty(ResponseCustomPropertyName, response);
+                    this.options.Enrich?.Invoke(activity, "OnStopActivity", response);
 
                     activity.SetTag(SemanticConventions.AttributeHttpStatusCode, (int)response.StatusCode);
 
@@ -163,7 +164,7 @@ public override void OnException(Activity activity, object payload)
                     return;
                 }
 
-                activity.SetCustomProperty(ExceptionCustomPropertyName, exc);
+                this.options.Enrich?.Invoke(activity, "OnException", exc);
 
                 if (exc is HttpRequestException)
                 {

src/OpenTelemetry.Instrumentation.SqlClient/Implementation/SqlClientDiagnosticListener.cs

@@ -89,7 +89,8 @@ public override void OnCustom(string name, Activity activity, object payload)
                             var database = this.databaseFetcher.Fetch(connection);
 
                             activity.DisplayName = (string)database;
-                            activity.SetCustomProperty(CommandCustomPropertyName, command);
+                            this.options.Enrich?.Invoke(activity, "OnCustom", command);
+
                             var dataSource = this.dataSourceFetcher.Fetch(connection);
                             var commandText = this.commandTextFetcher.Fetch(command);
 

src/OpenTelemetry.Instrumentation.SqlClient/SqlClientInstrumentationOptions.cs

@@ -13,6 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 // </copyright>
+
 using System;
 using System.Collections.Concurrent;
 using System.Data;
@@ -56,6 +57,11 @@ public class SqlClientInstrumentationOptions
         /// </remarks>
         public bool EnableConnectionLevelAttributes { get; set; }
 
+        /// <summary>
+        /// Gets or sets an action to enrich an Activity.
+        /// </summary>
+        public Action<Activity, string, object> Enrich { get; set; }
+
         internal static SqlConnectionDetails ParseDataSource(string dataSource)
         {
             Match match = DataSourceRegex.Match(dataSource);

src/OpenTelemetry.Instrumentation.StackExchangeRedis/StackExchangeRedisCallsInstrumentationOptions.cs

@@ -13,6 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 // </copyright>
+
 using System;
 using System.Diagnostics;
 

src/OpenTelemetry/Trace/ActivityProcessor.cs

@@ -15,8 +15,10 @@
 // </copyright>
 
 using System;
+using System.Collections.Generic;
 using System.Diagnostics;
 using System.Threading;
+using OpenTelemetry.Context;
 using OpenTelemetry.Internal;
 
 namespace OpenTelemetry.Trace

test/OpenTelemetry.Instrumentation.AspNet.Tests/HttpInListenerTests.cs

@@ -58,7 +58,6 @@ public void Dispose()
         [InlineData("http://localhost/api/value", 0, null, "TraceContext", "/api/value")] // Request will be filtered
         [InlineData("http://localhost/api/value", 0, null, "TraceContext", "{ThrowException}")] // Filter user code will throw an exception
         [InlineData("http://localhost/api/value/2", 0, null, "CustomContext", "/api/value")] // Request will not be filtered
-        [InlineData("http://localhost/api/value/2", 0, null, "CustomContext", "/api/value", true)] // Request will not be filtered
         public void AspNetRequestsAreCollectedSuccessfully(
             string url,
             int routeType,
@@ -162,6 +161,8 @@ public void AspNetRequestsAreCollectedSuccessfully(
                     {
                         options.Propagator = propagator.Object;
                     }
+
+                    options.Enrich = ActivityEnrichment;
                 })
             .SetResource(expectedResource)
             .AddProcessor(activityProcessor.Object).Build())
@@ -251,13 +252,23 @@ public void AspNetRequestsAreCollectedSuccessfully(
             Assert.Equal(HttpContext.Current.Request.UserAgent, span.GetTagValue(SemanticConventions.AttributeHttpUserAgent) as string);
 
             Assert.Equal(expectedResource, span.GetResource());
-            var request = span.GetCustomProperty(HttpInListener.RequestCustomPropertyName);
-            Assert.NotNull(request);
-            Assert.True(request is HttpRequest);
+        }
+
+        private static void ActivityEnrichment(Activity activity, string method, object obj)
+        {
+            switch (method)
+            {
+                case "OnStartActivity":
+                    Assert.True(obj is HttpRequest);
+                    break;
 
-            var response = span.GetCustomProperty(HttpInListener.ResponseCustomPropertyName);
-            Assert.NotNull(response);
-            Assert.True(response is HttpResponse);
+                case "OnStopActivity":
+                    Assert.True(obj is HttpResponse);
+                    break;
+
+                default:
+                    break;
+            }
         }
 
         private class FakeAspNetDiagnosticSource : IDisposable

test/OpenTelemetry.Instrumentation.AspNetCore.Tests/BasicTests.cs

@@ -58,15 +58,23 @@ public void AddAspNetCoreInstrumentation_BadArgs()
             Assert.Throws<ArgumentNullException>(() => builder.AddAspNetCoreInstrumentation());
         }
 
-        [Fact]
-        public async Task SuccessfulTemplateControllerCallGeneratesASpan()
+        [Theory]
+        [InlineData(true)]
+        [InlineData(false)]
+        public async Task SuccessfulTemplateControllerCallGeneratesASpan(bool shouldEnrich)
         {
             var expectedResource = Resources.Resources.CreateServiceResource("test-service");
             var activityProcessor = new Mock<ActivityProcessor>();
             void ConfigureTestServices(IServiceCollection services)
             {
                 this.openTelemetrySdk = Sdk.CreateTracerProviderBuilder()
-                    .AddAspNetCoreInstrumentation()
+                    .AddAspNetCoreInstrumentation(options =>
+                    {
+                        if (shouldEnrich)
+                        {
+                            options.Enrich = ActivityEnrichment;
+                        }
+                    })
                     .SetResource(expectedResource)
                     .AddProcessor(activityProcessor.Object)
                     .Build();
@@ -309,13 +317,23 @@ private static void ValidateAspNetCoreActivity(Activity activityToValidate, stri
             Assert.Equal(ActivityKind.Server, activityToValidate.Kind);
             Assert.Equal(expectedHttpPath, activityToValidate.GetTagValue(SpanAttributeConstants.HttpPathKey) as string);
             Assert.Equal(expectedResource, activityToValidate.GetResource());
-            var request = activityToValidate.GetCustomProperty(HttpInListener.RequestCustomPropertyName);
-            Assert.NotNull(request);
-            Assert.True(request is HttpRequest);
+        }
 
-            var response = activityToValidate.GetCustomProperty(HttpInListener.ResponseCustomPropertyName);
-            Assert.NotNull(response);
-            Assert.True(response is HttpResponse);
+        private static void ActivityEnrichment(Activity activity, string method, object obj)
+        {
+            switch (method)
+            {
+                case "OnStartActivity":
+                    Assert.True(obj is HttpRequest);
+                    break;
+
+                case "OnStopActivity":
+                    Assert.True(obj is HttpResponse);
+                    break;
+
+                default:
+                    break;
+            }
         }
     }
 }