Add guid correlation support and change activity processing

Dependencies.props

@@ -36,6 +36,7 @@
     <Microsoft_Extensions_Logging_Version>3.1.2</Microsoft_Extensions_Logging_Version>
     <Microsoft_Extensions_DependencyInjection_Version>3.1.2</Microsoft_Extensions_DependencyInjection_Version>
     <Microsoft_Extensions_Options_Version>3.1.2</Microsoft_Extensions_Options_Version>
+    <System_Threading_Tasks_Extensions_Version>4.5.3</System_Threading_Tasks_Extensions_Version>
     <System_Diagnostics_DiagnosticSource_Version>4.7.0</System_Diagnostics_DiagnosticSource_Version>
     <MSTest_TestFramework_Version>2.1.0</MSTest_TestFramework_Version>
     <MSTest_TestAdapter_Version>2.1.0</MSTest_TestAdapter_Version>

src/Extensions/Abstractions/Activities/ActivityExtensions.cs

@@ -0,0 +1,93 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+using System;
+using System.Diagnostics;
+
+namespace Microsoft.Omex.Extensions.Abstractions.Activities
+{
+	/// <summary>
+	/// Extensions for Activity
+	/// </summary>
+	public static class ActivityExtensions
+	{
+		/// <summary>
+		/// Get user hash from activity
+		/// </summary>
+		public static string GetUserHash(this Activity activity) =>
+			activity.GetBaggageItem(UserHashKey) ?? string.Empty;
+
+
+		/// <summary>
+		/// Returns true if activity is transaction
+		/// </summary>
+		public static bool IsTransaction(this Activity activity) =>
+			string.Equals(
+				activity.GetBaggageItem(TransactionMarkerKey),
+				TransactionMarkerValue,
+				StringComparison.OrdinalIgnoreCase);
+
+
+		/// <summary>
+		/// Set user hash for the activity
+		/// </summary>
+		/// <remarks>This property would be transfered to child activity and via web requests</remarks>
+		public static Activity SetUserHash(this Activity activity, string userHash) =>
+			activity.AddBaggage(UserHashKey, userHash);
+
+
+		/// <summary>
+		/// Mark activity as transaction
+		/// </summary>
+		/// <remarks>This property would be transfered to child activity and via web requests</remarks>
+		public static Activity MarkAsTransaction(this Activity activity) =>
+			activity.AddBaggage(TransactionMarkerKey, TransactionMarkerValue);
+
+
+		/// <summary>
+		/// Get correlation guid that is used by old Omex services
+		/// </summary>
+		[Obsolete(CorrelationIdObsoleteMessage, false)]
+		public static Guid? GetObsoleteCorrelationId(this Activity activity) =>
+			Guid.TryParse(activity.GetBaggageItem(ObsoleteCorrelationId), out Guid correlation)
+				? correlation
+				: (Guid?)null;
+
+
+		/// <summary>
+		/// Set correlation guid that is used by old Omex services
+		/// </summary>
+		/// <remarks>This property would be transfered to child activity and via web requests</remarks>
+		[Obsolete(CorrelationIdObsoleteMessage, false)]
+		public static Activity SetObsoleteCorrelationId(this Activity activity, Guid correlation) =>
+			activity.AddBaggage(ObsoleteCorrelationId, correlation.ToString());
+
+
+		/// <summary>
+		/// Get transaction id that is used by old Omex services
+		/// </summary>
+		[Obsolete(TransactionIdObsoleteMessage, false)]
+		public static uint? GetObsolteteTransactionId(this Activity activity) =>
+			uint.TryParse(activity.GetBaggageItem(ObsoleteTransactionId), out uint transactionId)
+				? transactionId
+				: (uint?)null;
+
+
+		/// <summary>
+		/// Set transaction id that is used by old Omex services
+		/// </summary>
+		/// <remarks>This property would be transfered to child activity and via web requests</remarks>
+		[Obsolete(TransactionIdObsoleteMessage, false)]
+		public static Activity SetObsoleteTransactionId(this Activity activity, uint transactionId) =>
+			activity.AddBaggage(ObsoleteTransactionId, transactionId.ToString());
+
+
+		private const string UserHashKey = "UserHash";
+		private const string TransactionMarkerKey = "TransactionMarkerKey";
+		private const string TransactionMarkerValue = "true";
+		private const string ObsoleteCorrelationId = "ObsoleteCorrelationId";
+		private const string ObsoleteTransactionId = "ObsoleteTransactionId";
+		private const string CorrelationIdObsoleteMessage = "Please use Activity.Id for new services instead";
+		private const string TransactionIdObsoleteMessage = "Please use Activity.TraceId for new services instead";
+	}
+}

src/Extensions/TimedScopes/ITimedScopeProvider.cs → src/Extensions/Abstractions/Activities/ITimedScopeProvider.cs

@@ -1,9 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
-using Microsoft.Omex.Extensions.Abstractions;
-
-namespace Microsoft.Omex.Extensions.TimedScopes
+namespace Microsoft.Omex.Extensions.Abstractions.Activities
 {
 	/// <summary>
 	/// Interface to create TimedScope
@@ -13,12 +11,12 @@ public interface ITimedScopeProvider
 		/// <summary>
 		/// Creates and start TimedScope
 		/// </summary>
-		TimedScope CreateAndStart(TimedScopeDefinition name, TimedScopeResult result);
+		TimedScope CreateAndStart(TimedScopeDefinition name, TimedScopeResult result = TimedScopeResult.SystemError);
 
 
 		/// <summary>
 		/// Creates TimedScope
 		/// </summary>
-		TimedScope Create(TimedScopeDefinition name, TimedScopeResult result);
+		TimedScope Create(TimedScopeDefinition name, TimedScopeResult result = TimedScopeResult.SystemError);
 	}
 }

src/Extensions/Abstractions/Activities/Processing/ActivityResultStrings.cs

@@ -0,0 +1,52 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+using System;
+
+namespace Microsoft.Omex.Extensions.Abstractions.Activities.Processing
+{
+	/// <summary>
+	/// Class with activity result enum string values to avoid alocations
+	/// </summary>
+	public static class ActivityResultStrings
+	{
+		/// <summary>
+		/// Activity SystemError result string
+		/// </summary>
+		public static string SystemError { get; } = "SystemError";
+
+
+		/// <summary>
+		/// Activity ExpectedError result string
+		/// </summary>
+		public static string ExpectedError { get; } = "ExpectedError";
+
+
+		/// <summary>
+		/// Activity Success result string
+		/// </summary>
+		public static string Success { get; } = "Success";
+
+
+		/// <summary>
+		/// Activity Unknown result string
+		/// </summary>
+		public static string Unknown { get; } = "Unknown";
+
+
+		/// <summary>
+		/// Returns corresponding to enum string value with creating new string
+		/// </summary>
+		public static string ResultToString(TimedScopeResult result) =>
+			result switch
+			{
+				TimedScopeResult.SystemError => SystemError,
+				TimedScopeResult.ExpectedError => ExpectedError,
+				TimedScopeResult.Success => Success,
+#pragma warning disable CS0618 // need to handle all enum values
+				TimedScopeResult.Unknown => Unknown,
+#pragma warning restore CS0618
+				_ => throw new ArgumentException(FormattableString.Invariant($"Unsupported enum value '{result}'"))
+			};
+	}
+}

src/Extensions/Abstractions/Activities/Processing/ActivityTagKeys.cs

@@ -0,0 +1,27 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+namespace Microsoft.Omex.Extensions.Abstractions.Activities.Processing
+{
+	/// <summary>
+	/// Activity does not have methods to extract tags efficiently, so we need to expose keys to provide ability of extracting tags
+	/// </summary>
+	public static class ActivityTagKeys
+	{
+		/// <summary>
+		/// Activity result tag key
+		/// </summary>
+		public static string Result { get; } = "Result";
+
+		/// <summary>
+		/// Activity sub type tag key
+		/// </summary>
+		public static string SubType { get; } = "SubType";
+
+
+		/// <summary>
+		/// Activity metadata tag key
+		/// </summary>
+		public static string Metadata { get; } = "Metadata";
+	}
+}

src/Extensions/Abstractions/ReplayableLogs/IActivityProvider.cs → src/Extensions/Abstractions/Activities/Processing/IActivityProvider.cs

@@ -3,11 +3,12 @@
 
 using System.Diagnostics;
 
-namespace Microsoft.Omex.Extensions.Abstractions.ReplayableLogs
+namespace Microsoft.Omex.Extensions.Abstractions.Activities.Processing
 {
 	/// <summary>
 	/// Provides activities
 	/// </summary>
+	/// <remarks>This interface would be deleted after move to net 5.0, since inheritance won't be a supported extension model for Activity</remarks>
 	public interface IActivityProvider
 	{
 		/// <summary>

src/Extensions/Abstractions/Activities/Processing/IActivityStartObserver.cs

@@ -0,0 +1,18 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+using System.Diagnostics;
+
+namespace Microsoft.Omex.Extensions.Abstractions.Activities.Processing
+{
+	/// <summary>
+	/// Interface to monitor activity start
+	/// </summary>
+	public interface IActivityStartObserver
+	{
+		/// <summary>
+		/// Method will be called after activity start
+		/// </summary>
+		void OnStart(Activity activity, object? payload);
+	}
+}

src/Extensions/Abstractions/Activities/Processing/IActivityStopObserver.cs

@@ -0,0 +1,18 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+using System.Diagnostics;
+
+namespace Microsoft.Omex.Extensions.Abstractions.Activities.Processing
+{
+	/// <summary>
+	/// Interface to monitor activity stop
+	/// </summary>
+	public interface IActivityStopObserver
+	{
+		/// <summary>
+		/// Method will be called after activity stop
+		/// </summary>
+		void OnStop(Activity activity, object? payload);
+	}
+}

src/Extensions/TimedScopes/TaskExtensions.cs → src/Extensions/Abstractions/Activities/TaskExtensions.cs

@@ -2,9 +2,8 @@
 // Licensed under the MIT license.
 
 using System.Threading.Tasks;
-using Microsoft.Omex.Extensions.Abstractions;
 
-namespace Microsoft.Omex.Extensions.TimedScopes
+namespace Microsoft.Omex.Extensions.Abstractions.Activities
 {
 	/// <summary>
 	/// Extensions for Task to wrap them in TimedScope
@@ -18,7 +17,7 @@ public static async ValueTask<TResult> WithTimedScope<TResult>(this ValueTask<TR
 		{
 			using TimedScope timedScope = provider.CreateAndStart(definition, TimedScopeResult.SystemError);
 			TResult result = await task.ConfigureAwait(false);
-			timedScope.Result = TimedScopeResult.Success; // set TimedScope result to success in case if task completed properly (without exception)
+			timedScope.SetResult(TimedScopeResult.Success); // set TimedScope result to success in case if task completed properly (without exception)
 			return result;
 		}
 

src/Extensions/Abstractions/Activities/TimedScope.cs

@@ -0,0 +1,51 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+using System;
+using System.Diagnostics;
+
+namespace Microsoft.Omex.Extensions.Abstractions.Activities
+{
+	/// <summary>
+	/// Logs duration of activity
+	/// </summary>
+	/// <remarks>This class will be replaced with Activity after move to net 5, since it will be trackable and disposable</remarks>
+	public class TimedScope : IDisposable
+	{
+		/// <summary>
+		/// Creates TimedScope instance
+		/// </summary>
+		/// <param name="activity">activity connected to this timedscope</param>
+		/// <param name="result">TimedScope initial result</param>
+		public TimedScope(Activity activity, TimedScopeResult result)
+		{
+			Activity = activity;
+			this.SetResult(result);
+		}
+
+
+		/// <summary>
+		/// Starts TimedScope activity
+		/// </summary>
+		public TimedScope Start()
+		{
+			s_listener.StartActivity(Activity, this);
+			return this;
+		}
+
+
+		/// <summary>
+		/// Stop TimedScope and log informations about it
+		/// </summary>
+		public void Stop() => s_listener.StopActivity(Activity, this);
+
+
+		internal Activity Activity { get; }
+
+
+		void IDisposable.Dispose() => Stop();
+
+
+		private static readonly DiagnosticListener s_listener = new DiagnosticListener("TimedScopesListener");
+	}
+}

src/Extensions/Abstractions/TimedScopeDefinition.cs → src/Extensions/Abstractions/Activities/TimedScopeDefinition.cs

@@ -3,7 +3,7 @@
 
 using System;
 
-namespace Microsoft.Omex.Extensions.Abstractions
+namespace Microsoft.Omex.Extensions.Abstractions.Activities
 {
 	/// <summary>
 	/// Store Timed Scope name

src/Extensions/TimedScopes/TimedScopeResult.cs → src/Extensions/Abstractions/Activities/TimedScopeResult.cs

@@ -4,7 +4,7 @@
 using System;
 using System.Runtime.Serialization;
 
-namespace Microsoft.Omex.Extensions.TimedScopes
+namespace Microsoft.Omex.Extensions.Abstractions.Activities
 {
 	/// <summary>
 	/// Defines the possible scope results
@@ -21,7 +21,7 @@ public enum TimedScopeResult : int
 		/// </summary>
 		/// <remarks>Result should always be set to one of the other values explicitly. Unknown causes an error to be logged, and the scope is assumed failed.</remarks>
 		[EnumMember]
-		[Obsolete("Default value, not to be used explicitly", error: true)]
+		[Obsolete("Default value, not to be used explicitly", error: false)]
 		Unknown = 0,