Skip to content

Make BASE SDK Use W3C Correlation by default. #1193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 21 commits into from
Aug 21, 2019
Merged

Make BASE SDK Use W3C Correlation by default. #1193

Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
54235fc
wip1
cijothomas Aug 16, 2019
82f7f43
UnitTests for TelemetryClient StartOperation
cijothomas Aug 16, 2019
b80c994
Merge branch 'develop' into cithomas/w3c
cijothomas Aug 16, 2019
2970c71
comments.
cijothomas Aug 16, 2019
adff23c
Merge branch 'cithomas/w3c' of https://github.com/microsoft/Applicati…
cijothomas Aug 16, 2019
37bfc96
some refactorings
cijothomas Aug 16, 2019
a39d911
un-delete activityextension for w3c most methods are no op with some …
cijothomas Aug 19, 2019
dfb1f62
more changes
cijothomas Aug 19, 2019
2f9e039
build fix
cijothomas Aug 19, 2019
4754a70
more build fixes stylecop public api analyzers
cijothomas Aug 19, 2019
d04959e
StartOperation with Activity fixed
cijothomas Aug 19, 2019
69a638e
fix standalone usage of sdk
cijothomas Aug 19, 2019
56fa356
stylecop
cijothomas Aug 19, 2019
52cc851
fix space
cijothomas Aug 19, 2019
5fdc7a2
Address PR comments
cijothomas Aug 20, 2019
3dc2a2e
fixes
cijothomas Aug 20, 2019
fdbd571
call TraceId.gneraterandom where possible.
cijothomas Aug 20, 2019
b7d2f2c
style
cijothomas Aug 20, 2019
8769d75
review comments
cijothomas Aug 21, 2019
07f6958
remove unused
cijothomas Aug 21, 2019
5acae04
changelog
cijothomas Aug 21, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion PublicAPI/Microsoft.ApplicationInsights.dll/net45/PublicAPI.Unshipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Microsoft.ApplicationInsights.Extensibility.Implementation.Experimental.ExperimentalFeaturesExtension
Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.EnableW3CCorrelation.set -> void
Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.EnableW3CCorrelation.get -> bool
Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.ExperimentalFeatures.get -> System.Collections.Generic.IList<string>
static Microsoft.ApplicationInsights.Extensibility.Implementation.Experimental.ExperimentalFeaturesExtension.EvaluateExperimentalFeature(this Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration telemetryConfiguration, string featureName) -> bool
Microsoft.ApplicationInsights.Extensibility.Implementation.TelemetryConfigurationExtensions
Expand Down Expand Up @@ -45,7 +47,6 @@ Microsoft.ApplicationInsights.DataContracts.ExceptionTelemetry.IsSampledOutAtHea
Microsoft.ApplicationInsights.DataContracts.PageViewPerformanceTelemetry.IsSampledOutAtHead.set -> void
Microsoft.ApplicationInsights.DataContracts.PageViewTelemetry.IsSampledOutAtHead.set -> void
Microsoft.ApplicationInsights.DataContracts.RequestTelemetry.IsSampledOutAtHead.set -> void

Microsoft.ApplicationInsights.Extensibility.Implementation.TaskTimer.TaskTimer() -> void
Microsoft.ApplicationInsights.Extensibility.W3C.W3COperationCorrelationTelemetryInitializer.W3COperationCorrelationTelemetryInitializer() -> void
Microsoft.ApplicationInsights.Extensibility.Implementation.TelemetryDebugWriter.TelemetryDebugWriter() -> void
Expand Down
2 changes: 2 additions & 0 deletions PublicAPI/Microsoft.ApplicationInsights.dll/net46/PublicAPI.Unshipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Microsoft.ApplicationInsights.Extensibility.Implementation.Experimental.ExperimentalFeaturesExtension
Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.EnableW3CCorrelation.set -> void
Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.EnableW3CCorrelation.get -> bool
Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.ExperimentalFeatures.get -> System.Collections.Generic.IList<string>
static Microsoft.ApplicationInsights.Extensibility.Implementation.Experimental.ExperimentalFeaturesExtension.EvaluateExperimentalFeature(this Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration telemetryConfiguration, string featureName) -> bool
Microsoft.ApplicationInsights.Extensibility.Implementation.TelemetryConfigurationExtensions
Expand Down
2 changes: 2 additions & 0 deletions PublicAPI/Microsoft.ApplicationInsights.dll/netstandard1.3/PublicAPI.Unshipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Microsoft.ApplicationInsights.Extensibility.Implementation.Experimental.ExperimentalFeaturesExtension
Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.EnableW3CCorrelation.set -> void
Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.EnableW3CCorrelation.get -> bool
Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.ExperimentalFeatures.get -> System.Collections.Generic.IList<string>
static Microsoft.ApplicationInsights.Extensibility.Implementation.Experimental.ExperimentalFeaturesExtension.EvaluateExperimentalFeature(this Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration telemetryConfiguration, string featureName) -> bool
Microsoft.ApplicationInsights.Extensibility.Implementation.TelemetryConfigurationExtensions
Expand Down
2 changes: 2 additions & 0 deletions PublicAPI/Microsoft.ApplicationInsights.dll/netstandard2.0/PublicAPI.Shipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.EnableW3CCorrelation.set -> void
Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.EnableW3CCorrelation.get -> bool
abstract Microsoft.ApplicationInsights.Extensibility.Implementation.OperationTelemetry.Context.get -> Microsoft.ApplicationInsights.DataContracts.TelemetryContext
abstract Microsoft.ApplicationInsights.Extensibility.Implementation.OperationTelemetry.DeepClone() -> Microsoft.ApplicationInsights.Channel.ITelemetry
abstract Microsoft.ApplicationInsights.Extensibility.Implementation.OperationTelemetry.Duration.get -> System.TimeSpan
Expand Down
239 changes: 172 additions & 67 deletions ...cationInsights.Test/Shared/Extensibility/OperationCorrelationTelemetryInitializerTests.cs
View file
Open in desktop

Large diffs are not rendered by default.

30 changes: 29 additions & 1 deletion Test/Microsoft.ApplicationInsights.Test/Shared/Extensibility/TelemetryConfigurationTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,38 @@
using Microsoft.ApplicationInsights.Extensibility.Implementation;
using Microsoft.ApplicationInsights.TestFramework;
using Microsoft.VisualStudio.TestTools.UnitTesting;

using System.Diagnostics;

[TestClass]
public class TelemetryConfigurationTest
{
#region W3C
[TestMethod]
public void TelemetryConfigurationConstructorSetsW3CToTrueByDefault()
{
var tc = new TelemetryConfiguration();
Assert.IsTrue(tc.EnableW3CCorrelation);
}

[TestMethod]
public void TelemetryConfigurationEnableW3CCorrelationSetsActivityDefaultFormatToW3C()
{
var tc = new TelemetryConfiguration();
tc.EnableW3CCorrelation = true;
Assert.AreEqual(ActivityIdFormat.W3C, Activity.DefaultIdFormat);
}

[TestMethod]
public void TelemetryConfigurationDisableW3CCorrelationRestoresActivityDefaultFormat()
{
Activity.DefaultIdFormat = ActivityIdFormat.Hierarchical;
var tc = new TelemetryConfiguration();
// DisablingW3C should reset default id format to Hierrachical
tc.EnableW3CCorrelation = false;
Assert.AreEqual(ActivityIdFormat.Hierarchical, Activity.DefaultIdFormat);
}
#endregion

[TestMethod]
public void TelemetryConfigurationIsPublicToAllowUsersManipulateConfigurationProgrammatically()
{
Expand Down
2 changes: 0 additions & 2 deletions ...soft.ApplicationInsights.Test/Shared/Microsoft.ApplicationInsights.Shared.Tests.projitems
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,6 @@
<Compile Include="$(MSBuildThisFileDirectory)Metrics\TestUtility\StubApplicationInsightsTelemetryChannel.cs" />
<Compile Include="$(MSBuildThisFileDirectory)Metrics\TestUtility\TestCategoryNames.cs" />
<Compile Include="$(MSBuildThisFileDirectory)Metrics\TestUtility\TestUtil.cs" />
<Compile Include="$(MSBuildThisFileDirectory)W3C\W3CActivityExtensionsTests.cs" />
<Compile Include="$(MSBuildThisFileDirectory)W3C\W3COperationCorrelationTelemetryInitializerTests.cs" />
<Compile Include="$(MSBuildThisFileDirectory)W3C\W3CUtilitiesTests.cs" />
<None Include="$(MSBuildThisFileDirectory)Metrics\TestUtility\Materials\StdDev Test Tool.xlsx" />
<Compile Include="$(MSBuildThisFileDirectory)Properties\AssemblyInfo.cs" />
Expand Down
15 changes: 12 additions & 3 deletions Test/Microsoft.ApplicationInsights.Test/Shared/StartOperationActivityTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Extensibility.Implementation;
using TestFramework;
using Microsoft.ApplicationInsights.Extensibility.W3C;

/// <summary>
/// This class tests TelemetryClientEzxtensions.StartOperation<T>(TelemetryClient c, Activity a) overload
/// This class tests TelemetryClientExtensions.StartOperation<T>(TelemetryClient c, Activity a) overload
/// </summary>
[TestClass]
public class StartOperationActivityTests
Expand Down Expand Up @@ -272,10 +273,18 @@ private async Task ProcessAsync(Activity activity, Activity parentActivity)
return telemetry;
}

private void ValidateTelemetry<T>(T telemetry, Activity activity) where T : OperationTelemetry
private void ValidateTelemetry<T>(T telemetry, Activity activity, bool isW3C = true) where T : OperationTelemetry
{
Assert.AreEqual(activity.OperationName, telemetry.Name);
Assert.AreEqual(activity.Id, telemetry.Id);
if (isW3C)
{
Assert.AreEqual(W3CUtilities.FormatTelemetryId(activity.TraceId.ToHexString(), activity.SpanId.ToHexString()), telemetry.Id);
}
else
{
Assert.AreEqual(activity.Id, telemetry.Id);
}

Assert.AreEqual(activity.ParentId, telemetry.Context.Operation.ParentId);
Assert.AreEqual(activity.RootId, telemetry.Context.Operation.Id);

Expand Down
Loading