Identify Users
Users consist of a few critical pieces of information that construct a unique identity in Sentry. Each of these is optional, but one must be present for the Sentry SDK to capture the user:
id
Your internal identifier for the user.
username
The username. Typically used as a better label than the internal id.
name
The user's first and/or last name.
email
An alternative, or addition, to the username. Sentry is aware of email addresses and can display things such as Gravatars and unlock messaging capabilities.
ip_address
The user's IP address. If the user is unauthenticated, Sentry uses the IP address as a unique identifier for the user.
Serverside SDKs that instrument incoming requests will attempt to pull the IP address from the HTTP request data (request.env.REMOTE_ADDR
field in JSON), if available. That might require sendDefaultPii
set to `true` in the SDK options.
If the user's ip_address
is set to "{{auto}}"
, Sentry will infer the IP address from the connection between your app and Sentry's server.
If the field is omitted, the default value is null
. However, due to backwards compatibility concerns, certain platforms (in particular JavaScript) have a different default value for "{{auto}}"
. SDKs and other clients should not rely on this behavior and should set IP addresses or "{{auto}}"
explicitly.
To opt out of storing users' IP addresses in your event data, you can go to your
$user.ip_address
. Adding such a rule ultimately overrules any other logic.Additionally, you can provide arbitrary key/value pairs beyond the reserved names, and the Sentry SDK will store those with the user.
To identify the user:
import 'package:sentry/sentry.dart';
Sentry.configureScope(
(scope) => scope.setUser(SentryUser(id: '1234', email: 'jane.doe@example.com')),
);
You can also clear the currently set user:
import 'package:sentry/sentry.dart';
Sentry.configureScope((scope) => scope.setUser(null));
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").
- Package:
- pub:sentry
- Version:
- 7.13.2
- Repository:
- https://github.com/getsentry/sentry-dart
- API Documentation:
- https://pub.dev/documentation/sentry/latest/