Custom Keys

Custom keys help you get the specific state of your app leading up to a crash. You can associate arbitrary key/value pairs with your crash reports, viewable right from the Fabric dashboard.

Setting Keys

Start with [Crashlytics setObjectValue:forKey:] or one of the related methods:

	+ (void)setObjectValue:(id)value forKey:(NSString *)key;
	// calls -description on value, perfect for NSStrings! 
	+ (void)setIntValue:(int)value forKey:(NSString *)key; 

	+ (void)setBoolValue:(BOOL)value forKey:(NSString *)key; 

	+ (void)setFloatValue:(float)value forKey:(NSString *)key; 

Update existing key value

Sometimes you need to change the existing key value. Call the same key, but replace the value. Examples:

	[Crashlytics setIntValue:3 forKey:@"current_level"];
	[Crashlytics setObjectValue:@"logged_in" 
		forKey:@"last_UI_action"];

Note: Crashlytics supports a maximum of 64 key/value pairs. Once you reach this threshold, additional values are not saved. Each key/value pair can be up to 1 KB.

Custom Logging

With CLS_LOG, you can leave bread crumbs in your code in the form of logged messages that will give you insight into what is going on in your app leading up to a crash. These messages are associated with your crash data and are visible in the Fabric dashboard if you look at the specific crash.

CLS_LOG was built to help pinpoint issues. It automatically includes information about the Objective-C class, method and line number where the log line came from.

CLS_LOG(format, ...) is the recommended way to add custom logging to your app.

• In Debug builds, CLS_LOG passes through to NSLog so you can see the output in Xcode and on the device or simulator.
• In Release builds, however, CLS_LOG silences all other output, resulting in logging that is about 10X faster than NSLog

Example:

CLS_LOG(@"Higgs-Boson detected! Bailing out... %@", 
		attributesDict);

Browse the Crashlytics/Crashlytics.h header file for more details.

Advanced

For more control, you can directly leverage CLSLog(format, ...) and CLSNSLog(format, ...). The latter passes through to NSLog so you can see the output in Xcode or on the device or simulator. CLSLog(format, ...) and CLSNSLog(format, ...) are thread safe. CLSLog is meant for logging information important to solving crashes. It should not be used to track in-app events.

Using Swift:

To use custom logging in Swift, just use CLSLogv or CLSNSLogv?. You need to make an array and then call getVaList function on that array.

User Identifiers

It’s often helpful to know which of your users experienced a given crash. After initializing Fabric, you can use [Crashlytics setUserIdentifier:] to provide an ID number, token, or hashed value that uniquely identifies the end-user of your application without disclosing or transmitting any of their personal information. You can also clear the value by setting it to a blank string. This value is displayed right in the Fabric dashboard.

	+ (void)setUserIdentifier:(NSString *)identifier; 

If you would like to take advantage of advanced user identifier features, you can additionally use both:

	+ (void)setUserName:(NSString *)name; 
			
	+ (void)setUserEmail:(NSString *)email;