Few fixes (#16)

* add event register package

* added the stylecop

* add all misc files

Author: Sergey Kanzhelev

CONTRIBUTING.md

@@ -0,0 +1,4 @@
+Contributing
+======
+
+Information on contributing to this repo is in the [Contributing Guide](https://github.com/aspnet/Home/blob/dev/CONTRIBUTING.md) in the Home repo.

LICENSE.txt

@@ -0,0 +1,12 @@
+Copyright (c) .NET Foundation. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+these files except in compliance with the License. You may obtain a copy of the
+License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.

README.md

@@ -0,0 +1,13 @@
+# Telemetry correlation http module
+
+Telemetry correlation http module enables cross tier telemetry tracking. 
+
+- Reads http headers
+- Start/Stops Activity for the http request
+- Ensure the Activity ambient state is transferred thru the IIS callbacks
+
+See http protocol [specifications](https://github.com/lmolkova/corefx/blob/80e8a8d767a71f413fd7b2f11b507cd395110e8d/src/System.Diagnostics.DiagnosticSource/src/FlatRequestId.md) for details.
+
+
+This http module is used by Application Insights. See [documentation](https://docs.microsoft.com/en-us/azure/application-insights/application-insights-correlation) and [code](https://github.com/Microsoft/ApplicationInsights-dotnet-server).
+

src/Microsoft.AspNet.TelemetryCorrelation/ActivityExtensions.cs

@@ -1,4 +1,7 @@
-using System;
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
 using System.Collections.Specialized;
 using System.ComponentModel;
 using System.Diagnostics;
@@ -12,31 +15,39 @@ namespace Microsoft.AspNet.TelemetryCorrelation
     [EditorBrowsable(EditorBrowsableState.Never)]
     public static class ActivityExtensions
     {
+        /// <summary>
+        /// Http header name to carry the Request ID.
+        /// </summary>
         internal const string RequestIDHeaderName = "Request-Id";
+
+        /// <summary>
+        /// Http header name to carry the correlation context.
+        /// </summary>
         internal const string CorrelationContextHeaderName = "Correlation-Context";
 
         /// <summary>
         /// Reads Request-Id and Correlation-Context headers and sets ParentId and Baggage on Activity.
         /// </summary>
         /// <param name="activity">Instance of activity that has not been started yet.</param>
         /// <param name="requestHeaders">Request headers collection.</param>
+        /// <returns>true if request was parsed successfully, false - otherwise.</returns>
         public static bool Extract(this Activity activity, NameValueCollection requestHeaders)
         {
             if (activity == null)
             {
-                AspNetTelemetryCorrelaitonEventSource.Log.ActvityExtractionError("activity is null");
+                AspNetTelemetryCorrelationEventSource.Log.ActvityExtractionError("activity is null");
                 return false;
             }
 
             if (activity.ParentId != null)
             {
-                AspNetTelemetryCorrelaitonEventSource.Log.ActvityExtractionError("ParentId is already set on activity");
+                AspNetTelemetryCorrelationEventSource.Log.ActvityExtractionError("ParentId is already set on activity");
                 return false;
             }
 
             if (activity.Id != null)
             {
-                AspNetTelemetryCorrelaitonEventSource.Log.ActvityExtractionError("Activity is already started");
+                AspNetTelemetryCorrelationEventSource.Log.ActvityExtractionError("Activity is already started");
                 return false;
             }
 
@@ -46,23 +57,22 @@ public static bool Extract(this Activity activity, NameValueCollection requestHe
                 // there may be several Request-Id header, but we only read the first one
                 activity.SetParentId(requestIDs[0]);
 
-                // Header format - Correlation-Context: key1=value1, key2=value2 
+                // Header format - Correlation-Context: key1=value1, key2=value2
                 var baggages = requestHeaders.GetValues(CorrelationContextHeaderName);
                 if (baggages != null)
                 {
-                    // there may be several Correlation-Context header 
+                    // there may be several Correlation-Context header
                     foreach (var item in baggages)
                     {
                         foreach (var pair in item.Split(','))
                         {
-                            NameValueHeaderValue baggageItem;
-                            if (NameValueHeaderValue.TryParse(pair, out baggageItem))
+                            if (NameValueHeaderValue.TryParse(pair, out NameValueHeaderValue baggageItem))
                             {
                                 activity.AddBaggage(baggageItem.Name, baggageItem.Value);
                             }
                             else
                             {
-                                AspNetTelemetryCorrelaitonEventSource.Log.HeaderParsingError(CorrelationContextHeaderName, pair);
+                                AspNetTelemetryCorrelationEventSource.Log.HeaderParsingError(CorrelationContextHeaderName, pair);
                             }
                         }
                     }
@@ -74,10 +84,12 @@ public static bool Extract(this Activity activity, NameValueCollection requestHe
             return false;
         }
 
-
         /// <summary>
-        /// 
+        /// Reads Request-Id and Correlation-Context headers and sets ParentId and Baggage on Activity.
         /// </summary>
+        /// <param name="activity">Instance of activity that has not been started yet.</param>
+        /// <param name="requestHeaders">Request headers collection.</param>
+        /// <returns>true if request was parsed successfully, false - otherwise.</returns>
         [Obsolete("Method is obsolete, use Extract method instead", true)]
         [EditorBrowsable(EditorBrowsableState.Never)]
         public static bool TryParse(this Activity activity, NameValueCollection requestHeaders)

src/Microsoft.AspNet.TelemetryCorrelation/ActivityHelper.cs

@@ -1,4 +1,7 @@
-using System.Diagnostics;
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System.Diagnostics;
 using System.Web;
 
 namespace Microsoft.AspNet.TelemetryCorrelation
@@ -8,20 +11,40 @@ namespace Microsoft.AspNet.TelemetryCorrelation
     /// </summary>
     internal static class ActivityHelper
     {
+        /// <summary>
+        /// Listener name.
+        /// </summary>
         public const string AspNetListenerName = "Microsoft.AspNet.TelemetryCorrelation";
+
+        /// <summary>
+        /// Activity name for http request.
+        /// </summary>
         public const string AspNetActivityName = "Microsoft.AspNet.HttpReqIn";
+
+        /// <summary>
+        /// Event name for the activity start event.
+        /// </summary>
         public const string AspNetActivityStartName = "Microsoft.AspNet.HttpReqIn.Start";
+
+        /// <summary>
+        /// Event name for the activity stop event.
+        /// </summary>
         public const string AspNetActivityLostStopName = "Microsoft.AspNet.HttpReqIn.ActivityLost.Stop";
 
+        /// <summary>
+        /// Key to store the activity in HttpContext.
+        /// </summary>
         public const string ActivityKey = "__AspnetActivity__";
-        private static readonly DiagnosticListener s_aspNetListener = new DiagnosticListener(AspNetListenerName);
+
+        private static readonly DiagnosticListener AspNetListener = new DiagnosticListener(AspNetListenerName);
 
         /// <summary>
         /// It's possible that a request is executed in both native threads and managed threads,
         /// in such case Activity.Current will be lost during native thread and managed thread switch.
         /// This method is intended to restore the current activity in order to correlate the child
         /// activities with the root activity of the request.
         /// </summary>
+        /// <param name="root">Root activity id for the current request.</param>
         /// <returns>If it returns an activity, it will be silently stopped with the parent activity</returns>
         public static Activity RestoreCurrentActivity(Activity root)
         {
@@ -32,13 +55,14 @@ public static Activity RestoreCurrentActivity(Activity root)
             var childActivity = new Activity(root.OperationName);
             childActivity.SetParentId(root.Id);
             childActivity.SetStartTime(root.StartTimeUtc);
-            foreach(var item in root.Baggage)
+            foreach (var item in root.Baggage)
             {
                 childActivity.AddBaggage(item.Key, item.Value);
             }
+
             childActivity.Start();
 
-            AspNetTelemetryCorrelaitonEventSource.Log.ActivityStarted(childActivity.Id);
+            AspNetTelemetryCorrelationEventSource.Log.ActivityStarted(childActivity.Id);
             return childActivity;
         }
 
@@ -55,9 +79,9 @@ public static bool StopAspNetActivity(Activity activity, HttpContext context)
                 // if activity is in the stack, stop it with Stop event
                 if (Activity.Current != null)
                 {
-                    s_aspNetListener.StopActivity(Activity.Current, new { });
+                    AspNetListener.StopActivity(Activity.Current, new { });
                     RemoveCurrentActivity(context);
-                    AspNetTelemetryCorrelaitonEventSource.Log.ActivityStopped(activity.Id);
+                    AspNetTelemetryCorrelationEventSource.Log.ActivityStopped(activity.Id);
                     return true;
                 }
             }
@@ -69,51 +93,54 @@ public static void StopLostActivity(Activity activity, HttpContext context)
         {
             if (activity != null)
             {
-                s_aspNetListener.Write(AspNetActivityLostStopName, new { activity });
+                AspNetListener.Write(AspNetActivityLostStopName, new { activity });
                 RemoveCurrentActivity(context);
-                AspNetTelemetryCorrelaitonEventSource.Log.ActivityStopped(activity.Id, true);
+                AspNetTelemetryCorrelationEventSource.Log.ActivityStopped(activity.Id, true);
             }
         }
 
         public static Activity CreateRootActivity(HttpContext context)
         {
-            if (s_aspNetListener.IsEnabled() && s_aspNetListener.IsEnabled(AspNetActivityName))
+            if (AspNetListener.IsEnabled() && AspNetListener.IsEnabled(AspNetActivityName))
             {
                 var rootActivity = new Activity(ActivityHelper.AspNetActivityName);
 
                 rootActivity.Extract(context.Request.Unvalidated.Headers);
                 if (StartAspNetActivity(rootActivity))
                 {
                     SaveCurrentActivity(context, rootActivity);
-                    AspNetTelemetryCorrelaitonEventSource.Log.ActivityStarted(rootActivity.Id);
+                    AspNetTelemetryCorrelationEventSource.Log.ActivityStarted(rootActivity.Id);
                     return rootActivity;
                 }
             }
+
             return null;
         }
 
         private static bool StartAspNetActivity(Activity activity)
         {
-            if (s_aspNetListener.IsEnabled(AspNetActivityName, activity, new { }))
+            if (AspNetListener.IsEnabled(AspNetActivityName, activity, new { }))
             {
-                if (s_aspNetListener.IsEnabled(AspNetActivityStartName))
+                if (AspNetListener.IsEnabled(AspNetActivityStartName))
                 {
-                    s_aspNetListener.StartActivity(activity, new { });
+                    AspNetListener.StartActivity(activity, new { });
                 }
                 else
                 {
                     activity.Start();
                 }
+
                 return true;
             }
 
             return false;
         }
 
         /// <summary>
-        /// This should be called after the Activity starts
-        /// and only for root activity of a request
+        /// This should be called after the Activity starts and only for root activity of a request.
         /// </summary>
+        /// <param name="context">Context to save context to.</param>
+        /// <param name="activity">Activity to save.</param>
         private static void SaveCurrentActivity(HttpContext context, Activity activity)
         {
             Debug.Assert(context != null);

…relation/AspNetDiagnosticsEventSource.cs …AspNetTelemetryCorrelationEventSource.cssrc/Microsoft.AspNet.TelemetryCorrelation/AspNetDiagnosticsEventSource.cs renamed to src/Microsoft.AspNet.TelemetryCorrelation/AspNetTelemetryCorrelationEventSource.cs src/Microsoft.AspNet.TelemetryCorrelation/AspNetDiagnosticsEventSource.cs renamed to src/Microsoft.AspNet.TelemetryCorrelation/AspNetTelemetryCorrelationEventSource.cs

@@ -1,17 +1,20 @@
-using System.Diagnostics.Tracing;
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System.Diagnostics.Tracing;
 
 namespace Microsoft.AspNet.TelemetryCorrelation
 {
     /// <summary>
     /// ETW EventSource tracing class.
     /// </summary>
     [EventSource(Name = "Microsoft-AspNet-Telemetry-Correlation", Guid = "ace2021e-e82c-5502-d81d-657f27612673")]
-    internal sealed class AspNetTelemetryCorrelaitonEventSource : EventSource
+    internal sealed class AspNetTelemetryCorrelationEventSource : EventSource
     {
         /// <summary>
         /// Instance of the PlatformEventSource class.
         /// </summary>
-        public static readonly AspNetTelemetryCorrelaitonEventSource Log = new AspNetTelemetryCorrelaitonEventSource();
+        public static readonly AspNetTelemetryCorrelationEventSource Log = new AspNetTelemetryCorrelationEventSource();
 
         [Event(1, Message = "Callback='{0}'", Level = EventLevel.Verbose)]
         public void TraceCallback(string callback)

src/Microsoft.AspNet.TelemetryCorrelation/Microsoft.AspNet.TelemetryCorrelation.csproj

@@ -23,6 +23,8 @@
     <SolutionDir Condition="$(SolutionDir) == '' Or $(SolutionDir) == '*Undefined*'">..\..\</SolutionDir>
     <RestorePackages>true</RestorePackages>
     <TargetFrameworkProfile />
+    <NuGetPackageImportStamp>
+    </NuGetPackageImportStamp>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <DebugSymbols>true</DebugSymbols>
@@ -31,13 +33,17 @@
     <DefineConstants>DEBUG;TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <CodeAnalysisRuleSet>Microsoft.AspNet.TelemetryCorrelation.ruleset</CodeAnalysisRuleSet>
+    <RunCodeAnalysis>true</RunCodeAnalysis>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>
     <Optimize>true</Optimize>
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <CodeAnalysisRuleSet>Microsoft.AspNet.TelemetryCorrelation.ruleset</CodeAnalysisRuleSet>
+    <RunCodeAnalysis>true</RunCodeAnalysis>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="System" />
@@ -55,11 +61,24 @@
     <Compile Include="ActivityExtensions.cs" />
     <Compile Include="ActivityHelper.cs" />
     <Compile Include="TelemetryCorrelationHttpModule.cs" />
-    <Compile Include="AspNetDiagnosticsEventSource.cs" />
+    <Compile Include="AspNetTelemetryCorrelationEventSource.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>
   <ItemGroup>
+    <None Include="Microsoft.AspNet.TelemetryCorrelation.ruleset" />
     <None Include="packages.config" />
   </ItemGroup>
+  <ItemGroup>
+    <Analyzer Include="..\..\packages\StyleCop.Analyzers.1.0.0\analyzers\dotnet\cs\Newtonsoft.Json.dll" />
+    <Analyzer Include="..\..\packages\StyleCop.Analyzers.1.0.0\analyzers\dotnet\cs\StyleCop.Analyzers.CodeFixes.dll" />
+    <Analyzer Include="..\..\packages\StyleCop.Analyzers.1.0.0\analyzers\dotnet\cs\StyleCop.Analyzers.dll" />
+  </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
+  <Import Project="..\..\packages\Microsoft.Diagnostics.Tracing.EventRegister.1.1.28\build\Microsoft.Diagnostics.Tracing.EventRegister.targets" Condition="Exists('..\..\packages\Microsoft.Diagnostics.Tracing.EventRegister.1.1.28\build\Microsoft.Diagnostics.Tracing.EventRegister.targets')" />
+  <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
+    <PropertyGroup>
+      <ErrorText>This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them.  For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
+    </PropertyGroup>
+    <Error Condition="!Exists('..\..\packages\Microsoft.Diagnostics.Tracing.EventRegister.1.1.28\build\Microsoft.Diagnostics.Tracing.EventRegister.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\Microsoft.Diagnostics.Tracing.EventRegister.1.1.28\build\Microsoft.Diagnostics.Tracing.EventRegister.targets'))" />
+  </Target>
 </Project>