Monitor custom attributes

With Performance Monitoring, you can use attributes to segment performance data and focus on your app's performance in different real-world scenarios.

Performance Monitoring provides a variety of default attributes:

For iOS and Android apps, default attributes include app version, country, operating system information, device, radio, and carrier.
For web apps, default attributes include browser, country, effective connection type, page URL, service worker status, and visibility state.

In addition to these default attributes, you can also create custom attributes on your custom traces to segment data by categories specific to your app. For example, in a game, you can segment data by game level.

Collecting user data

Collecting user data: Performance Monitoring does not itself collect any personally identifiable information (PII), such as names, email addresses, or phone numbers. Developers can collect additional data using Performance Monitoring by attaching custom attributes. Such data collected through Performance Monitoring should not contain information that personally identifies an individual to Google.

Here's an example of a log message that does not contain personally identifiable information:

trace.putAttribute("experiment", "A");

Here's an example that does contain personally identifiable information (do not use this type of custom attribute in your app):

trace.putAttribute("email", user.getEmailAddress());

Data that exposes any personally identifiable information is subject to deletion without notice.

Create custom attributes

You can use custom attributes on specific traces. You can then use custom attributes as filters for your performance data in the Firebase console.

To use custom attributes, add code to your app defining the attribute and applying it to a specific trace. You can set the custom attribute anytime between when the trace starts and when the trace stops.

Note the following:

You're limited to 5 custom attributes per trace.
Names for custom attributes must meet the following requirements: no leading or trailing whitespace, no leading underscore (_) character, and max length is 32 characters.

Swift

var trace = Performance.sharedInstance().trace(name:"myTrace")
trace.setValue("A", forAttribute: "experiment")

// Update scenario.
trace.setValue("B", forAttribute: "experiment")

// Reading scenario.
let experimentValue:String? = trace.valueForAttribute("experiment")

// Delete scenario.
trace.removeAttribute("experiment")

// Read attributes.
let attributes:[String, String] = trace.attributes;

Objective-C

FIRTrace *trace = [[FIRPerformance sharedInstance] traceWithName:@"myTrace"];
[trace setValue:@"A" forAttribute:@"experiment"];

// Update scenario.
[trace setValue:@"B" forAttribute:@"experiment"];

// Reading scenario.
NSString *experimentValue = [trace valueForAttribute:@"experiment"];

// Delete scenario.
[trace removeAttribute:@"experiment"];

// Read attributes.
NSDictionary <NSString *, NSString *> *attributes = [trace attributes];

Java

Trace trace = FirebasePerformance.getInstance().newTrace("test_trace");

// Update scenario.
trace.putAttribute("experiment", "A");

// Reading scenario.
String experimentValue = trace.getAttribute("experiment");

// Delete scenario.
trace.removeAttribute("experiment");

// Read attributes.
Map<String, String> traceAttributes = trace.getAttributes();MainActivity.java

Kotlin+KTX

val trace = FirebasePerformance.getInstance().newTrace("test_trace")

// Update scenario.
trace.putAttribute("experiment", "A")

// Reading scenario.
val experimentValue = trace.getAttribute("experiment")

// Delete scenario.
trace.removeAttribute("experiment")

// Read attributes.
val traceAttributes = trace.attributesMainActivity.kt

Web

const trace = performance.trace('test_trace');
trace.putAttribute('experiment', 'A');

// Update scenario
trace.putAttribute('experiment', 'B');

// Reading scenario
const experimentValue = trace.getAttribute('experiment');

// Delete scenario
trace.removeAttribute('experiment');

// Read attributes
const traceAttributes = trace.getAttributes();

Monitor custom attributes

In the Firebase console, go to the Performance dashboard.
Click the Traces tab.
Each of your custom attributes has a card showing performance data for that segment. You can also filter by custom attributes.