Add OperationDetails object bag to DependencyTelemtry for Initializers

.gitignore

@@ -113,6 +113,7 @@ AppPackages/
 
 # Others
 sql/
+[Vv]swhere/
 *.Cache
 ClientBin/
 [Ss]tyle[Cc]op.*

CHANGELOG.md

@@ -2,10 +2,13 @@
 
 This changelog will be used to generate documentation on [release notes page](http://azure.microsoft.com/en-us/documentation/articles/app-insights-release-notes-dotnet/).
 
-## Version 2.6.0
- - [Fix: changed namespace SamplingPercentageEstimatorSettings](https://github.com/Microsoft/ApplicationInsights-dotnet/issues/727)
- - [Extend the Beta period for Metrics Pre-Aggregation features shipped in 2.6.0-beta3.](https://github.com/Microsoft/ApplicationInsights-dotnet/issues/785)
+## Version 2.7.0-beta1
+- [New: Added TryGetOperationDetail to DependencyTelemetry to facilitate advanced ITelemetryInitializer scenarios.  Allows ITelemetryInitializer implementations to specify fields that would otherwise not be sent automatically to the backend.] (https://github.com/Microsoft/ApplicationInsights-dotnet-server/issues/900)
+
 
+## Version 2.6.0
+- [Fix: changed namespace SamplingPercentageEstimatorSettings](https://github.com/Microsoft/ApplicationInsights-dotnet/issues/727)
+- [Extend the Beta period for Metrics Pre-Aggregation features shipped in 2.6.0-beta3.](https://github.com/Microsoft/ApplicationInsights-dotnet/issues/785)
 
 ## Version 2.6.0-beta4
 - [New: Enable ExceptionTelemetry.SetParsedStack for .Net Standard](https://github.com/Microsoft/ApplicationInsights-dotnet/issues/763)

PublicAPI/Microsoft.ApplicationInsights.dll/net45/PublicAPI.Unshipped.txt

@@ -1,3 +1,5 @@
+Microsoft.ApplicationInsights.DataContracts.DependencyTelemetry.TryGetOperationDetail(string key, out object detail) -> bool
+Microsoft.ApplicationInsights.DataContracts.DependencyTelemetry.SetOperationDetail(string key, object detail) -> void
 Microsoft.ApplicationInsights.DataContracts.PageViewTelemetry.Id.get -> string
 Microsoft.ApplicationInsights.DataContracts.PageViewTelemetry.Id.set -> void
 Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.ApplicationIdProvider.get -> Microsoft.ApplicationInsights.Extensibility.IApplicationIdProvider

PublicAPI/Microsoft.ApplicationInsights.dll/net46/PublicAPI.Unshipped.txt

@@ -1,3 +1,5 @@
+Microsoft.ApplicationInsights.DataContracts.DependencyTelemetry.TryGetOperationDetail(string key, out object detail) -> bool
+Microsoft.ApplicationInsights.DataContracts.DependencyTelemetry.SetOperationDetail(string key, object detail) -> void
 Microsoft.ApplicationInsights.DataContracts.PageViewTelemetry.Id.get -> string
 Microsoft.ApplicationInsights.DataContracts.PageViewTelemetry.Id.set -> void
 Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.ApplicationIdProvider.get -> Microsoft.ApplicationInsights.Extensibility.IApplicationIdProvider

PublicAPI/Microsoft.ApplicationInsights.dll/netstandard1.3/PublicAPI.Unshipped.txt

@@ -1,3 +1,5 @@
+Microsoft.ApplicationInsights.DataContracts.DependencyTelemetry.TryGetOperationDetail(string key, out object detail) -> bool
+Microsoft.ApplicationInsights.DataContracts.DependencyTelemetry.SetOperationDetail(string key, object detail) -> void
 Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.ApplicationIdProvider.get -> Microsoft.ApplicationInsights.Extensibility.IApplicationIdProvider
 Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.ApplicationIdProvider.set -> void
 Microsoft.ApplicationInsights.Extensibility.IApplicationIdProvider

Test/Microsoft.ApplicationInsights.Test/Shared/DataContracts/DependencyTelemetryTest.cs

@@ -167,6 +167,36 @@ public void DependencyTelemetryHasCorrectValueOfSamplingPercentageAfterSerializa
             Assert.AreEqual(10, item.sampleRate);
         }
 
+        [TestMethod]
+        public void DependencyTelemetrySetGetOperationDetail()
+        {
+            const string key = "foo";
+            const string detail = "bar";
+
+            var telemetry = this.CreateRemoteDependencyTelemetry("mycommand");
+            telemetry.SetOperationDetail(key, detail);
+            Assert.IsTrue(telemetry.TryGetOperationDetail(key, out object retrievedValue));
+            Assert.IsNotNull(retrievedValue);
+            Assert.AreEqual(detail, retrievedValue.ToString());
+
+            // Clear and verify the detail is no longer present
+            telemetry.ClearOperationDetails();
+            Assert.IsFalse(telemetry.TryGetOperationDetail(key, out retrievedValue));
+        }
+
+        [TestMethod]
+        public void DependencyTelemetryGetUnsetOperationDetail()
+        {
+            const string key = "foo";
+
+            var telemetry = this.CreateRemoteDependencyTelemetry("mycommand");
+            Assert.IsFalse(telemetry.TryGetOperationDetail(key, out object retrievedValue));
+            Assert.IsNull(retrievedValue);
+
+            // should not throw
+            telemetry.ClearOperationDetails();
+        }
+
 #if !NETCOREAPP1_1
         [TestMethod]
         public void DependencyTelemetryDeepCloneCopiesAllProperties()
@@ -185,7 +215,7 @@ public void DependencyTelemetryDeepCloneCopiesAllProperties()
         private DependencyTelemetry CreateRemoteDependencyTelemetry()
         {
             DependencyTelemetry item = new DependencyTelemetry
-                                            {                                              
+                                            {
                                                 Timestamp = DateTimeOffset.Now,
                                                 Sequence = "4:2",
                                                 Name = "MyWebServer.cloudapp.net",

src/Microsoft.ApplicationInsights/DataContracts/DependencyTelemetry.cs

@@ -1,12 +1,16 @@
 namespace Microsoft.ApplicationInsights.DataContracts
 {
     using System;
+    using System.Collections.Concurrent;
     using System.Collections.Generic;
     using System.ComponentModel;
     using Microsoft.ApplicationInsights.Channel;
+    using Microsoft.ApplicationInsights.Extensibility;
     using Microsoft.ApplicationInsights.Extensibility.Implementation;
     using Microsoft.ApplicationInsights.Extensibility.Implementation.External;
 
+    using static System.Threading.LazyInitializer;
+
     /// <summary>
     /// The class that represents information about the collected dependency.
     /// <a href="https://go.microsoft.com/fwlink/?linkid=839889">Learn more.</a>
@@ -19,6 +23,7 @@ public sealed class DependencyTelemetry : OperationTelemetry, ITelemetry, ISuppo
 
         internal readonly RemoteDependencyData InternalData;
         private readonly TelemetryContext context;
+        private IDictionary<string, object> operationDetails;
 
         private double? samplingPercentage;
 
@@ -93,6 +98,12 @@ private DependencyTelemetry(DependencyTelemetry source)
             this.Timestamp = source.Timestamp;
             this.samplingPercentage = source.samplingPercentage;
             this.successFieldSet = source.successFieldSet;
+
+            // Only clone the details if the source has had details initialized
+            if (source.operationDetails != null)
+            {
+                this.operationDetails = new ConcurrentDictionary<string, object>(source.operationDetails);
+            }
         }
 
         /// <summary>
@@ -272,6 +283,11 @@ public string DependencyKind
             set { this.samplingPercentage = value; }
         }
 
+        /// <summary>
+        /// Gets the dependency operation details, if any.
+        /// </summary>
+        private IDictionary<string, object> OperationDetails => EnsureInitialized(ref this.operationDetails, () => new ConcurrentDictionary<string, object>());
+
         /// <summary>
         /// Deeply clones a <see cref="DependencyTelemetry"/> object.
         /// </summary>
@@ -281,6 +297,38 @@ public override ITelemetry DeepClone()
             return new DependencyTelemetry(this);
         }
 
+        /// <summary>
+        /// In specific collectors, objects are added to the dependency telemetry which may be useful
+        /// to enhance DependencyTelemetry telemetry by <see cref="ITelemetryInitializer" /> implementations.
+        /// Objects retrieved here are not automatically serialized and sent to the backend.
+        /// </summary>
+        /// <param name="key">The key of the value to get.</param>
+        /// <param name="detail">When this method returns, contains the object that has the specified key, or the default value of the type if the operation failed.</param>
+        /// <returns>true if the key was found; otherwise, false.</returns>
+        public bool TryGetOperationDetail(string key, out object detail)
+        {
+            // Avoid initializing the dictionary if it has not been initialized
+            if (this.operationDetails == null)
+            {
+                detail = null;
+                return false;
+            }
+
+            return this.OperationDetails.TryGetValue(key, out detail);
+        }
+
+        /// <summary>
+        /// Sets the operation detail specific against the key specified. Objects set through this method
+        /// are not automatically serialized and sent to the backend.
+        /// </summary>
+        /// <param name="key">The key to store the detail against.</param>
+        /// <param name="detail">Detailed information collected by the tracked operation.</param>
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public void SetOperationDetail(string key, object detail)
+        {
+            this.OperationDetails[key] = detail;
+        }
+
         /// <summary>
         /// Sanitizes the properties based on constraints.
         /// </summary>
@@ -294,5 +342,19 @@ void ITelemetry.Sanitize()
             this.Data = this.Data.SanitizeData();
             this.Properties.SanitizeProperties();
         }
+
+        /// <summary>
+        /// Clears any stored operational data for the dependency operation, if any.
+        /// </summary>
+        internal void ClearOperationDetails()
+        {
+            // Avoid initializing the dictionary if it has not been initialized
+            if (this.operationDetails == null)
+            {
+                return;
+            }
+
+            this.OperationDetails.Clear();
+        }
     }
 }

src/Microsoft.ApplicationInsights/TelemetryClient.cs

@@ -375,6 +375,8 @@ public void TrackDependency(DependencyTelemetry telemetry)
             }
 
             this.Track(telemetry);
+
+            telemetry.ClearOperationDetails();
         }
 
         /// <summary>