Fixes: Identifying Users with OpenTelemetry doesn't work

[jamescrosswell]

Fixes Identifying Users with OpenTelemetry doesn't work #2616.

Key implementation details

• The addition of:

  sentry-dotnet/src/Sentry.AspNetCore/Extensions/DependencyInjection/ServiceCollectionExtensions.cs

  Line 25 in ad6968c

  services.AddHttpContextAccessor();

• Added ISentryUserFactory to the DefaultUserFactory (eventually this should replace IUserFactory). This enables us to get the user data without having to add any dependencies to the Sentry.OpenTelemetry package. See:

  sentry-dotnet/src/Sentry.AspNetCore/IUserFactory.cs

  Lines 10 to 11 in ad6968c

  	/// Note: This interface is tightly coupled to AspNetCore and Will be removed in version 4.0.0. Please consider using
  	/// <see cref="ISentryUserFactory"/> with <see cref="IHttpContextAccessor"/> instead.

• Introduced an AspNetCoreEnricher:

  sentry-dotnet/src/Sentry.OpenTelemetry/TracerProviderBuilderExtensions.cs

  Lines 37 to 42 in ad6968c

  	// AspNetCoreEnricher
  	var userFactory = services.GetService<ISentryUserFactory>();
  	if (userFactory != null)
  	{
  	enrichers.Add(new AspNetCoreEnricher(userFactory));
  	}

[bruno-garcia]

Awesome work! Happy you found a way around without having to introduce a new package or add AspNetCore as a dep to Sentry.OTel!!

[bitsandfoxes]

Fantastic!

[github-actions]

	Fails
🚫	Please consider adding a changelog entry for the next release.

Instructions and example for changelog

Please add an entry to CHANGELOG.md to the "Unreleased" section. Make sure the entry includes this PR's number.

Example:

## Unreleased

- Identifying Users with OpenTelemetry doesn't work ([#2618](https://github.com/getsentry/sentry-dotnet/pull/2618))

If none of the above apply, you can opt out of this check by adding #skip-changelog to the PR description.

Generated by 🚫 dangerJS against b833430

[yudielcurbelo]

ISentryUserFactory is an internal interface, so how are we supposed to use it?

internal interface ISentryUserFactory
{
    public User? Create();
}

public class UserFactory : ISentryUserFactory
{
    public User Create()
    {
        ...
    }
}

[jamescrosswell]

ISentryUserFactory is an internal interface, so how are we supposed to use it?

Hey @yudielcurbelo, ISentryUserFactory is just an implementation detail that let's the SentrySdk access this information when using OpenTelemetry. Under the hood, all it does is let us get at the HttpContext.User:

sentry-dotnet/src/Sentry.AspNetCore/DefaultUserFactory.cs

Line 24 in b833430

var principal = context.User;

So you shouldn't need to use this directly. You'd use whatever Authorization scheme you're using already and Sentry will be able to pull details for the user from the HttpContext.

[ErlendSB]

How should we rewrite the example stated here: https://docs.sentry.io/platforms/dotnet/guides/aspnetcore/#capturing-the-affected-user

public void ConfigureServices(IServiceCollection services) { services.AddSingleton<IUserFactory, MyUserFactory>(); }

[jamescrosswell]

How should we rewrite the example stated here: https://docs.sentry.io/platforms/dotnet/guides/aspnetcore/#capturing-the-affected-user

public void ConfigureServices(IServiceCollection services) { services.AddSingleton<IUserFactory, MyUserFactory>(); }

Ah, I see. You want to create your own User Factory that gets used by the OpenTelemetry integration? In that case you're right... we'd need to makeISentryUserFactory public.

Thanks for calling this out.

I've created a new ticket to track this: #2714

[jeremy-allocate]

@jamescrosswell I'm hitting the IUserFactory warning in our builds but when I went to do the cutover to ISentryUserFactory to silence them I discovered this interface is marked internal so I can't implement it in my projects. Was this unintentional? If intentional, how are we supposed to proceed here?

[jamescrosswell]

Hey @jeremy-allocate , see #2618 (comment) above.

If it's an emergency and you just need to get a build out, you can disable the warning with a pragma, as we've done here:

sentry-dotnet/src/Sentry.AspNetCore/Extensions/DependencyInjection/ServiceCollectionExtensions.cs

Lines 26 to 28 in bbe4fa9

	#pragma warning disable CS0618
	services.TryAddSingleton<IUserFactory, DefaultUserFactory>();
	#pragma warning restore CS0618

[jeremy-allocate]

All good, thanks @jamescrosswell. We'll live with the warnings until #2714 is released.

[jamescrosswell]

As an FYI, we just made Release 3.40.1 that addresses this:

• ISentryUserFactory is now public so users can register their own implementations via DI (Make ISentryUserFactory public #2719)

[jeremy-allocate]

Awesome, many thanks!