Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
- **Breaking change:** Reduce default HTTP client metric volume in ASP.NET Core and Worker Service on .NET 8+ while retaining request latency, count, and failure dimensions through `http.client.request.duration`. Other `System.Net.Http` metrics are now opt-in through OpenTelemetry `AddView`; dashboards and alerts using them must [explicitly enable collection](MigrationGuidance.md#enabling-additional-http-client-metrics). HTTP dependency tracing and server metrics are unchanged. No new public API is introduced. Addresses the HTTP metric-volume concern in [#3192](https://github.com/microsoft/ApplicationInsights-dotnet/issues/3192).
- [Fix #3197: `NullReferenceException` when using TelemetryClient APIs when no connection string is provided.](https://github.com/microsoft/ApplicationInsights-dotnet/pull/3199)
- [Fix #3211: `TelemetryClient.TrackDependency(DependencyTelemetry)` and `TelemetryClient.TrackRequest(RequestTelemetry)` now default an unset `Timestamp` to `DateTimeOffset.UtcNow` (restoring 2.x behavior) instead of emitting `0001-01-01T00:00:00Z`, which ingestion rejects.](https://github.com/microsoft/ApplicationInsights-dotnet/pull/3219)

- [Fix #3223: The WEB package's activity processors now write the tag keys the Azure Monitor exporter maps (`enduser.pseudo.id`, `microsoft.session.id`, `microsoft.synthetic_source`, `microsoft.user.account_id`), so `user_Id`, `session_Id`, `operation_SyntheticSource` and `user_AccountId` are populated again instead of the values landing in `customDimensions` as `ai.user.id`, `session.id`, `ai.operation.syntheticSource` and `enduser.account`. `user_AccountId` is also no longer skipped when the authenticated user cookie is present, and the unmapped `session.isFirst` custom dimension is no longer emitted.](https://github.com/microsoft/ApplicationInsights-dotnet/pull/3224)
## Version 3.1.2
- [Fix `HttpException: Request is not available in this context` in the WEB package when calling `TrackDependency` from `Application_Start` in classic ASP.NET. The WEB activity processors now safely handle the case where `HttpContext.Request` is not yet available.](https://github.com/microsoft/ApplicationInsights-dotnet/pull/3184)
- [Fix #3163: `TelemetryConfiguration.CreateDefault()` on classic ASP.NET now returns a configuration already populated from `ApplicationInsights.config` (connection string, sampling, storage, live metrics, request/dependency tracking, etc.). A new `PreApplicationStartMethod` (`WebApplicationInsightsInitializer`) materializes and populates the singleton before `Application_Start` runs, so customer code calling `TelemetryConfiguration.CreateDefault()` from `Global.asax.cs` no longer gets an empty configuration. The `ApplicationInsightsHttpModule` no longer carries the config-reading bookkeeping. `TelemetryConfiguration.PrependOpenTelemetryBuilderConfiguration` no longer throws if the configuration was already built — it silently skips, so a second `TelemetryClient` constructed against an already-built configuration no longer throws `InvalidOperationException`.](https://github.com/microsoft/ApplicationInsights-dotnet/pull/3183)
Expand Down
56 changes: 49 additions & 7 deletions WEB/Src/Web/Web.Tests/AccountIdActivityProcessorTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public void OnEnd_SetsAccountIdFromCookie()
}

// Assert
var accountId = activity.GetTagItem("enduser.account");
var accountId = activity.GetTagItem("microsoft.user.account_id");
Assert.NotNull(accountId);
Assert.Equal("account456", accountId.ToString());
}
Expand All @@ -65,7 +65,7 @@ public void OnEnd_DoesNotSetAccountIdWhenCookieIsNull()
}

// Assert
var accountId = activity.GetTagItem("enduser.account");
var accountId = activity.GetTagItem("microsoft.user.account_id");
Assert.Null(accountId);
}

Expand All @@ -85,7 +85,7 @@ public void OnEnd_DoesNotSetAccountIdWhenCookieIsEmpty()
}

// Assert
var accountId = activity.GetTagItem("enduser.account");
var accountId = activity.GetTagItem("microsoft.user.account_id");
Assert.Null(accountId);
}

Expand All @@ -105,7 +105,7 @@ public void OnEnd_DoesNotSetAccountIdWhenCookieDoesNotHaveIt()
}

// Assert
var accountId = activity.GetTagItem("enduser.account");
var accountId = activity.GetTagItem("microsoft.user.account_id");
Assert.Null(accountId);
}

Expand All @@ -125,7 +125,7 @@ public void OnEnd_DoesNotSetAccountIdWhenCookieIsMalformed()
}

// Assert
var accountId = activity.GetTagItem("enduser.account");
var accountId = activity.GetTagItem("microsoft.user.account_id");
Assert.Null(accountId);
}

Expand All @@ -145,7 +145,7 @@ public void OnEnd_HandlesNonAsciiCharactersInCookie()
}

// Assert
var accountId = activity.GetTagItem("enduser.account");
var accountId = activity.GetTagItem("microsoft.user.account_id");
Assert.NotNull(accountId);
Assert.Equal("account456א", accountId.ToString());
}
Expand All @@ -166,9 +166,51 @@ public void OnEnd_HandlesSpecialCharactersInCookie()
}

// Assert
var accountId = activity.GetTagItem("enduser.account");
var accountId = activity.GetTagItem("microsoft.user.account_id");
Assert.NotNull(accountId);
Assert.Equal("$#@!!!!", accountId.ToString());
}

[Fact]
public void OnEnd_SetsAccountIdWhenAuthenticatedUserIdIsAlreadySet()
{
// Arrange - AuthenticatedUserIdActivityProcessor runs first and sets enduser.id from the same cookie
var context = HttpModuleHelper.GetFakeHttpContext();
context.WithAuthCookie("authUser123|account456");
SetupTracerProvider(new AccountIdActivityProcessor());

// Act
Activity activity;
using (activity = StartTestActivity())
{
Assert.NotNull(activity);
activity.SetTag("enduser.id", "authUser123");
}

// Assert
Assert.Equal("account456", activity.GetTagItem("microsoft.user.account_id")?.ToString());
Assert.Equal("authUser123", activity.GetTagItem("enduser.id")?.ToString());
Assert.Null(activity.GetTagItem("enduser.account"));
}

[Fact]
public void OnEnd_DoesNotOverrideExistingAccountId()
{
// Arrange
var context = HttpModuleHelper.GetFakeHttpContext();
context.WithAuthCookie("authUser123|account456");
SetupTracerProvider(new AccountIdActivityProcessor());

// Act
Activity activity;
using (activity = StartTestActivity())
{
Assert.NotNull(activity);
activity.SetTag("microsoft.user.account_id", "existingAccount");
}

// Assert
Assert.Equal("existingAccount", activity.GetTagItem("microsoft.user.account_id")?.ToString());
}
}
}
272 changes: 272 additions & 0 deletions WEB/Src/Web/Web.Tests/ActivityProcessorExportTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,272 @@
namespace Microsoft.ApplicationInsights.Web.Tests
{
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Globalization;
using System.IO;
using System.IO.Compression;
using System.Linq;
using System.Text;
using System.Text.Json;
using System.Threading;
using System.Threading.Tasks;
using System.Web;
using Azure;
using Azure.Core;
using Azure.Core.Pipeline;
using Azure.Monitor.OpenTelemetry.Exporter;
using Microsoft.ApplicationInsights.Web.Helpers;
using OpenTelemetry;
using OpenTelemetry.Trace;
using Xunit;

/// <summary>
/// Runs the Web activity processors through the Azure Monitor exporter and asserts on the exported envelope,
/// so that tags written under keys the exporter does not map (which would land in customDimensions) are caught.
/// </summary>
public class ActivityProcessorExportTests : IDisposable
{
private const string SourceName = "Microsoft.ApplicationInsights.Web.Tests.Export";
private const string AvailabilityMonitoringSource = "Application Insights Availability Monitoring";

private static readonly ActivitySource Source = new ActivitySource(SourceName);

private static readonly string[] KeysThatMustNotBeProperties =
{
"ai.user.id",
"session.id",
"session.isFirst",
"ai.operation.syntheticSource",
"enduser.account",
"microsoft.session.id",
"microsoft.synthetic_source",
"microsoft.user.account_id",
"enduser.pseudo.id",
};

public ActivityProcessorExportTests()
{
HttpContext.Current = null;
}

public void Dispose()
{
HttpContext.Current = null;
}

[Fact]
public void ExportedRequestHasUserSessionSyntheticSourceAndAccountContextTags()
{
// Arrange
string now = DateTimeOffset.Now.ToString("O", CultureInfo.InvariantCulture);
var context = HttpModuleHelper.GetFakeHttpContext(new Dictionary<string, string> { { "User-Agent", "YandexBot 123" } });
context.AddRequestCookie(new HttpCookie("ai_user", "anonUser|" + now) { HttpOnly = true, Secure = true });
context.AddRequestCookie(new HttpCookie("ai_session", "session123|" + now + "|" + now) { HttpOnly = true, Secure = true });
context.WithAuthCookie("authUser123|account456");

// Act
var envelope = ExportSingleRequest();

// Assert
var tags = envelope.GetProperty("tags");
Assert.Equal("anonUser", GetString(tags, "ai.user.id"));
Assert.Equal("session123", GetString(tags, "ai.session.id"));
Assert.Equal("Bot", GetString(tags, "ai.operation.syntheticSource"));
Assert.Equal("authUser123", GetString(tags, "ai.user.authUserId"));
Assert.Equal("account456", GetString(tags, "ai.user.accountId"));
AssertNoContextKeysInProperties(envelope);
}

[Fact]
public void ExportedRequestFromAvailabilityTestTakesPrecedenceOverBotAndCookies()
{
// Arrange
string now = DateTimeOffset.Now.ToString("O", CultureInfo.InvariantCulture);
var context = HttpModuleHelper.GetFakeHttpContext(new Dictionary<string, string>
{
{ "User-Agent", "YandexBot 123" },
{ "SyntheticTest-Location", "LOCATION" },
{ "SyntheticTest-RunId", "RUNID" },
});
context.AddRequestCookie(new HttpCookie("ai_user", "anonUser|" + now) { HttpOnly = true, Secure = true });
context.AddRequestCookie(new HttpCookie("ai_session", "session123|" + now + "|" + now) { HttpOnly = true, Secure = true });

// Act
var envelope = ExportSingleRequest();

// Assert
var tags = envelope.GetProperty("tags");
Assert.Equal(AvailabilityMonitoringSource, GetString(tags, "ai.operation.syntheticSource"));
Assert.Equal("LOCATION_RUNID", GetString(tags, "ai.user.id"));
Assert.Equal("RUNID", GetString(tags, "ai.session.id"));
AssertNoContextKeysInProperties(envelope);
}

private static JsonElement ExportSingleRequest()
{
var transport = new CapturingTransport();

// Processors are registered in the same order as ApplicationInsightsExtensions.
using (var tracerProvider = Sdk.CreateTracerProviderBuilder()
.AddSource(SourceName)
.AddProcessor(new WebTestActivityProcessor())
.AddProcessor(new SyntheticUserAgentActivityProcessor())
.AddProcessor(new SessionActivityProcessor())
.AddProcessor(new UserActivityProcessor())
.AddProcessor(new AuthenticatedUserIdActivityProcessor())
.AddProcessor(new AccountIdActivityProcessor())
.AddProcessor(new ClientIpHeaderActivityProcessor())
.AddAzureMonitorTraceExporter(o =>
{
// The exporter caches its transmitter (and transport) per connection string, so use a unique one per test.
o.ConnectionString = "InstrumentationKey=" + Guid.NewGuid().ToString();
o.Transport = transport;
o.DisableOfflineStorage = true;
o.SamplingRatio = 1.0F;
o.TracesPerSecond = null;
})
.Build())
{
using (var activity = Source.StartActivity("GET /test", ActivityKind.Server))
{
Assert.NotNull(activity);
activity.SetTag("http.request.method", "GET");
activity.SetTag("url.scheme", "http");
activity.SetTag("server.address", "localhost");
activity.SetTag("url.path", "/test");
activity.SetTag("http.response.status_code", 200);
}

Assert.True(tracerProvider.ForceFlush(10000));
}

return transport.Envelopes.Single(e => e.GetProperty("name").GetString() == "Request");
}

private static string GetString(JsonElement element, string propertyName)
{
return element.TryGetProperty(propertyName, out var value) ? value.GetString() : null;
}

private static void AssertNoContextKeysInProperties(JsonElement envelope)
{
var baseData = envelope.GetProperty("data").GetProperty("baseData");
if (!baseData.TryGetProperty("properties", out var properties))
{
return;
}

foreach (var key in KeysThatMustNotBeProperties)
{
Assert.False(properties.TryGetProperty(key, out _), $"'{key}' was exported as a custom property instead of a context tag.");
}
}

/// <summary>
/// Captures the Azure Monitor exporter payloads instead of sending them to the ingestion endpoint.
/// </summary>
private sealed class CapturingTransport : HttpPipelineTransport
{
private readonly object gate = new object();
private readonly List<JsonElement> envelopes = new List<JsonElement>();

public IReadOnlyList<JsonElement> Envelopes
{
get
{
lock (this.gate)
{
return this.envelopes.ToList();
}
}
}

public override Request CreateRequest()
{
return HttpClientTransport.Shared.CreateRequest();
}

public override void Process(HttpMessage message)
{
this.Capture(message.Request);
message.Response = new OkResponse();
}

public override ValueTask ProcessAsync(HttpMessage message)
{
this.Process(message);
return default;
}

private void Capture(Request request)
{
if (request.Content == null)
{
return;
}

using (var buffer = new MemoryStream())
{
request.Content.WriteTo(buffer, CancellationToken.None);
buffer.Position = 0;

Stream payload = buffer;
if (request.Headers.TryGetValue("Content-Encoding", out var encoding) &&
encoding.IndexOf("gzip", StringComparison.OrdinalIgnoreCase) >= 0)
{
payload = new GZipStream(buffer, CompressionMode.Decompress, leaveOpen: true);
}

string text;
using (var reader = new StreamReader(payload, Encoding.UTF8))
{
text = reader.ReadToEnd();
}

lock (this.gate)
{
foreach (var line in text.Split(new[] { '\n' }, StringSplitOptions.RemoveEmptyEntries))
{
using (var document = JsonDocument.Parse(line))
{
this.envelopes.Add(document.RootElement.Clone());
}
}
}
}
}
}

private sealed class OkResponse : Response
{
public override int Status => 200;

public override string ReasonPhrase => "OK";

public override Stream ContentStream { get; set; }

public override string ClientRequestId { get; set; } = Guid.NewGuid().ToString();

public override void Dispose()
{
}

protected override bool ContainsHeader(string name) => false;

protected override IEnumerable<HttpHeader> EnumerateHeaders() => Enumerable.Empty<HttpHeader>();

protected override bool TryGetHeader(string name, out string value)
{
value = null;
return false;
}

protected override bool TryGetHeaderValues(string name, out IEnumerable<string> values)
{
values = null;
return false;
}
}
}
}
Loading
Loading