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,16 @@ 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>
+        /// <remarks>
+        /// <para><see cref="Activity"/>: the activity being enriched.</para>
+        /// <para>string: the name of the event.</para>
+        /// <para>object: the raw object from which additional information can be extracted to enrich the activity.
+        /// The type of this object depends on the event, which is given by the above parameter.</para>
+        /// </remarks>
+        public Action<Activity, string, object> Enrich { get; set; }
     }
 }

src/OpenTelemetry.Instrumentation.AspNet/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+* Instrumntation no longer store raw objects like `HttpRequest` in
+  Activity.CustomProperty. To enrich activity, use the Enrich action on the
+  instrumentation.
+  ([#1261](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1261))
+
 ## 0.6.0-beta.1
 
 Released 2020-Sep-15
@@ -10,8 +15,8 @@ Released 2020-Sep-15
 
 Released 2020-08-28
 
-* Added Filter public API on AspNetInstrumentationOptions to allow
-  filtering of instrumentation based on HttpContext.
+* Added Filter public API on AspNetInstrumentationOptions to allow filtering of
+  instrumentation based on HttpContext.
 
 * Asp.Net Instrumentation automatically populates HttpRequest, HttpResponse in
   Activity custom property

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

@@ -54,5 +54,20 @@ public void RequestFilterException(string exception)
         {
             this.WriteEvent(3, exception);
         }
+
+        [NonEvent]
+        public void EnrichmentException(Exception ex)
+        {
+            if (this.IsEnabled(EventLevel.Error, (EventKeywords)(-1)))
+            {
+                this.EnrichmentException(ex.ToInvariantString());
+            }
+        }
+
+        [Event(4, Message = "Enrichment threw exception. Exception {0}.", Level = EventLevel.Error)]
+        public void EnrichmentException(string exception)
+        {
+            this.WriteEvent(4, exception);
+        }
     }
 }

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

@@ -109,7 +109,15 @@ public override void OnStartActivity(Activity activity, object payload)
 
             if (activity.IsAllDataRequested)
             {
-                activity.SetCustomProperty(RequestCustomPropertyName, request);
+                try
+                {
+                    this.options.Enrich?.Invoke(activity, "OnStartActivity", request);
+                }
+                catch (Exception ex)
+                {
+                    AspNetInstrumentationEventSource.Log.EnrichmentException(ex);
+                }
+
                 if (request.Url.Port == 80 || request.Url.Port == 443)
                 {
                     activity.SetTag(SemanticConventions.AttributeHttpHost, request.Url.Host);
@@ -159,7 +167,15 @@ public override void OnStopActivity(Activity activity, object payload)
 
                 var response = context.Response;
 
-                activityToEnrich.SetCustomProperty(ResponseCustomPropertyName, response);
+                try
+                {
+                    this.options.Enrich?.Invoke(activity, "OnStopActivity", response);
+                }
+                catch (Exception ex)
+                {
+                    AspNetInstrumentationEventSource.Log.EnrichmentException(ex);
+                }
+
                 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,16 @@ 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>
+        /// <remarks>
+        /// <para><see cref="Activity"/>: the activity being enriched.</para>
+        /// <para>string: the name of the event.</para>
+        /// <para>object: the raw object from which additional information can be extracted to enrich the activity.
+        /// The type of this object depends on the event, which is given by the above parameter.</para>
+        /// </remarks>
+        public Action<Activity, string, object> Enrich { get; set; }
     }
 }

src/OpenTelemetry.Instrumentation.AspNetCore/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+* Instrumntation no longer store raw objects like `HttpRequest` in
+  Activity.CustomProperty. To enrich activity, use the Enrich action on the
+  instrumentation.
+  ([#1261](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1261))
+
 ## 0.6.0-beta.1
 
 Released 2020-Sep-15
@@ -16,11 +21,11 @@ Released 2020-Sep-15
 
 Released 2020-08-28
 
-* Added Filter public API on AspNetCoreInstrumentationOptions to allow
-  filtering of instrumentation based on HttpContext.
+* Added Filter public API on AspNetCoreInstrumentationOptions to allow filtering
+  of instrumentation based on HttpContext.
 
-* Asp.Net Core Instrumentation automatically populates HttpRequest,
-  HttpResponse in Activity custom property
+* Asp.Net Core Instrumentation automatically populates HttpRequest, HttpResponse
+  in Activity custom property
 
 * Changed the default propagation to support W3C Baggage
   ([#1048](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1048))

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

@@ -54,5 +54,20 @@ public void RequestFilterException(string exception)
         {
             this.WriteEvent(3, exception);
         }
+
+        [NonEvent]
+        public void EnrichmentException(Exception ex)
+        {
+            if (this.IsEnabled(EventLevel.Error, (EventKeywords)(-1)))
+            {
+                this.EnrichmentException(ex.ToInvariantString());
+            }
+        }
+
+        [Event(4, Message = "Enrichment threw exception. Exception {0}.", Level = EventLevel.Error)]
+        public void EnrichmentException(string exception)
+        {
+            this.WriteEvent(4, exception);
+        }
     }
 }

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

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

src/OpenTelemetry.Instrumentation.GrpcNetClient/CHANGELOG.md

@@ -2,22 +2,26 @@
 
 ## Unreleased
 
+* Instrumntation no longer store raw objects like `HttpRequestMessage` in
+  Activity.CustomProperty. To enrich activity, use the Enrich action on the
+  instrumentation.
+  ([#1261](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1261))
+
 ## 0.6.0-beta.1
 
 Released 2020-Sep-15
 
-* The `grpc.method` and `grpc.status_code` attributes
-  added by the library are removed from the span. The information from these
-  attributes is contained in other attributes that follow the conventions of
-  OpenTelemetry.
+* The `grpc.method` and `grpc.status_code` attributes added by the library are
+  removed from the span. The information from these attributes is contained in
+  other attributes that follow the conventions of OpenTelemetry.
   ([#1260](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1260)).
 
 ## 0.5.0-beta.2
 
 Released 2020-08-28
 
-* NuGet package renamed to OpenTelemetry.Instrumentation.GrpcNetClient to
-  more clearly indicate that this package is specifically for gRPC client
+* NuGet package renamed to OpenTelemetry.Instrumentation.GrpcNetClient to more
+  clearly indicate that this package is specifically for gRPC client
   instrumentation. The package was previously named
   OpenTelemetry.Instrumentation.Grpc.
   ([#1136](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1136))

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,16 @@ 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>
+        /// <remarks>
+        /// <para><see cref="Activity"/>: the activity being enriched.</para>
+        /// <para>string: the name of the event.</para>
+        /// <para>object: the raw object from which additional information can be extracted to enrich the activity.
+        /// The type of this object depends on the event, which is given by the above parameter.</para>
+        /// </remarks>
+        public Action<Activity, string, object> Enrich { get; set; }
     }
 }

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

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

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

@@ -14,7 +14,9 @@
 // limitations under the License.
 // </copyright>
 
+using System;
 using System.Diagnostics.Tracing;
+using OpenTelemetry.Internal;
 
 namespace OpenTelemetry.Instrumentation.GrpcNetClient.Implementation
 {
@@ -31,5 +33,20 @@ public void NullPayload(string handlerName, string eventName)
         {
             this.WriteEvent(1, handlerName, eventName);
         }
+
+        [NonEvent]
+        public void EnrichmentException(Exception ex)
+        {
+            if (this.IsEnabled(EventLevel.Error, (EventKeywords)(-1)))
+            {
+                this.EnrichmentException(ex.ToInvariantString());
+            }
+        }
+
+        [Event(2, Message = "Enrichment thrw exception. Exception {0}.", Level = EventLevel.Error)]
+        public void EnrichmentException(string exception)
+        {
+            this.WriteEvent(2, exception);
+        }
     }
 }

src/OpenTelemetry.Instrumentation.GrpcNetClient/OpenTelemetry.Instrumentation.GrpcNetClient.csproj

@@ -6,6 +6,7 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <Compile Include="$(RepoRoot)\src\OpenTelemetry.Api\Internal\ExceptionExtensions.cs" Link="Internal\ExceptionExtensions.cs" />
     <Compile Include="$(RepoRoot)\src\OpenTelemetry.Api\Trace\SemanticConventions.cs" />
   </ItemGroup>
 

src/OpenTelemetry.Instrumentation.Http/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+* Instrumntation no longer store raw objects like `HttpRequestMessage` in
+  Activity.CustomProperty. To enrich activity, use the Enrich action on the
+  instrumentation.
+  ([#1261](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1261))
+
 ## 0.6.0-beta.1
 
 Released 2020-Sep-15

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,17 @@ public class HttpClientInstrumentationOptions
         /// </summary>
         public Func<HttpRequestMessage, bool> Filter { get; set; }
 
+        /// <summary>
+        /// Gets or sets an action to enrich an Activity.
+        /// </summary>
+        /// <remarks>
+        /// <para><see cref="Activity"/>: the activity being enriched.</para>
+        /// <para>string: the name of the event.</para>
+        /// <para>object: the raw object from which additional information can be extracted to enrich the activity.
+        /// The type of this object depends on the event, which is given by the above parameter.</para>
+        /// </remarks>
+        public Action<Activity, string, object> Enrich { get; set; }
+
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         internal bool EventFilter(string activityName, object arg1)
         {