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.

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. Sentry will attempt to pull this 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 collecting users' IP addresses, you can use Sentry's server-side data scrubbing to remove $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.

You'll first need to import the SDK, as usual:

Copied
import * as Sentry from "@sentry/nextjs";

To identify the user:

Copied
Sentry.setUser({ email: "john.doe@example.com" });

You can also clear the currently set user:

Copied
Sentry.configureScope(scope => scope.setUser(null));
Help improve this content
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").