Syntax
NewRelic.setUserId(string $userId)Set a custom user identifier value to associate user sessions with analytics events and attributes.
Requirements
Agent version 5.0.0 or higher.
Description
This method sets a custom user identifier value to associate mobile user sessions with New Relic Insights events and attributes. This method can be called anytime after the New Relic Android agent starts.
A user identifier is useful for several reasons. Using the Crash Analysis UI, you can:
- Find crashes specific to a user. Focusing on one particular crash for one user is often enough to quickly resolve the issue.
- Filter all crashes to show the occurrences for a user (or group of users) for each crash type; inversely, filter the crash list to show those users affected by each crash type. If the user ID is represented as an email address, it's then easy to reach out and let them know when there is a solution available that addresses those crashes.
If you do not want to explicitly identify users because of privacy rules, this method is still useful when tracking user segments, such as paid vs. free end users, or registered vs. unregistered users. This allows you to filter or facet on the number and types of crashes experienced by each segment, and do outreach based on that segment.
For more context on how to use this API, see Send custom attributes and events to Insights.
Parameters
Parameter | Description |
|---|---|
string | Required. Sets user ID. |
Return values
Returns true if it succeeds, or false if it doesn't.
Examples
Set user ID
Set a user identifier to associate user session with New Relic Insights events and attributes:
boolean userIdWasSet = NewRelic.setUserId("SampleUserName");