Sentry-laravel: The option "user_context" does not exist.

[zhernosekim]

I used "sentry/sentry-laravel": "^0.12.0@dev" earlier and it worked with user_context correctly. How to resolve this error for version 1.0-beta?

[stayallive]

Look for user_context in the upgrade documentation of the sentry-php the Laravel integration uses.

I see the user context documentation is currently missing from the Laravel documentation so that will be added back later.

The gist is to do instead of $client->user_context(['email' => '[email protected]']); this:

use Sentry\Hub;
use Sentry\Scope;

Hub::getCurrent()->configureScope(function (Scope $scope): void {
    $scope->setUser(['email' => '[email protected]']);
});

[LeoColomb]

Indeed. Would be great to update examples configs as well.

[stayallive]

We never had ik documented in the example since there is no user context in a clean Laravel setup, but it is documented correctly now!

https://docs.sentry.io/platforms/php/laravel/#user-context

[LeoColomb]

no user context in a clean Laravel setup

Well, yes, but examples do contain user_context:

https://github.com/getsentry/sentry-laravel/blob/4cf6852fd38c8cbd0a52179cfdc74b156866ade4/examples/laravel-5.4/config/sentry.php#L13

https://github.com/getsentry/sentry-laravel/blob/39e918a8f2c9d06c7408d275095e36ad4258886d/examples/laravel-5.5/config/sentry.php#L13

[LeoColomb]

Ah, OK, these old examples are supposed to stick at the version < 1.
But they are partly been updated, that why it raises some confusions.

[stayallive]

@LeoColomb good point, totally missed those :( Thanks for letting me know!

I updated those example to reflect the config option changes here: #197

[CharlieEtienne]

For those who had cache config on remote server and are now trapped in a loop with that error, you must uninstall sentry/sentry-laravel by removing it from composer.json, deploy and do composer install, clear config, reinstall sentry, and deploy again.

[stayallive]

Alternatively you can remove the config cache file manually: bootstrap/cache/config.php.

[dwightwatson]

It's a real shame that this package stopped supporting sending user details out of the box. It feels incredibly lazy that I need to create a middleware to configure Sentry myself because the Laravel-specific Sentry bridge doesn't do it by itself.

[stayallive]

Sorry you feel this way so strongly.

However, the option to add the user context is not gone but it’s called differently now.

You might have missed it in the new docs:

Starting with Laravel 5.3 we can automatically add the authenticated user id to the scope if send_default_pii option is set to true in your config/sentry.php.

[pierrocknroll]

So this option send_default_pii should be documented in the config/sentry.php

[stayallive]

I think we shouldn't because then where do we stop with documenting options in there and syncing their defaults with the base package, there are quite a few and more may be added later at any time. Better to keep that in the documentation IMHO.

For reference, they are all documented here: https://docs.sentry.io/error-reporting/configuration/?platform=php