Instrumentation and Event Collection

Mobile SDK 5.0 introduces a new framework that adds analytical instrumentation to Mobile SDK apps. Through this instrumentation, apps collect event data that describe how consuming apps use Mobile SDK. Mobile SDK periodically uploads logs of these events to the Salesforce cloud. This information helps us focus on the features that matter most to your customers. We do not collect any data specific to users or their Salesforce organizations.

Mobile SDK app users and developers do not have access to the information Salesforce gathers. Salesforce collects it solely for its own use. The software that collects the data is maintained in Mobile SDK open source repos at github.com/forcedotcom.

Mobile SDK 5.0 and later enable instrumentation by default. Mobile SDK automatically publishes collected framework events to the Salesforce cloud on the following schedule:

iOS: When the app goes to the background.
Android: Every 8 hours.

Your app can toggle event logging on or off. On Android, your app can also change the collection upload frequency.

To manage the event logging service, use the following APIs. You call each API on an instance of an analytics manager object, which you initialize with your app’s current user account.

Toggle Event Logging

Android

For Android, call the enableLogging(boolean enabled) method.

1final UserAccount curAccount = UserAccountManager.getInstance().getCurrentUser();
2final SalesforceAnalyticsManager sfAnalyticsManager = 
3    SalesforceAnalyticsManager.getInstance(curAccount);
4sfAnalyticsManager.enableLogging(false);

iOS

For iOS, set the BOOL loggingEnabled property.

1SFUserAccount *account = [SFUserAccountManager
2sharedInstance].currentUser;
3SFSDKSalesforceAnalyticsManager *sfAnalyticsManager =
4    [SFSDKSalesforceAnalyticsManager
5sharedInstanceWithUser:account];
6sfAnalyticsManager.loggingEnabled = NO;

Check Event Logging Status

Android

For Android, call the isLoggingEnabled(boolean enabled) method.

1final UserAccount curAccount = UserAccountManager.getInstance().getCurrentUser();
2final SalesforceAnalyticsManager sfAnalyticsManager = 
3    SalesforceAnalyticsManager.getInstance(curAccount);
4boolean enabled = sfAnalyticsManager.isLoggingEnabled();

iOS

For iOS, check the BOOL isLoggingEnabled property.

1SFUserAccount *account = [SFUserAccountManager sharedInstance].currentUser;
2SFSDKSalesforceAnalyticsManager *sfAnalyticsManager =
3    [SFSDKSalesforceAnalyticsManager sharedInstanceWithUser:account];
4BOOL enabled = sfAnalyticsManager.isLoggingEnabled;

Set Upload Frequency (Android Only)

On Android, you can set the frequency, in hours, of event log uploads. The default value is 8.

1final UserAccount curAccount = UserAccountManager.getInstance().getCurrentUser();
2final SalesforceAnalyticsManager sfAnalyticsManager =
3    SalesforceAnalyticsManager.getInstance(curAccount);
4sfAnalyticsManager.setPublishFrequencyInHours(numHours); // numHours is the desired upload interval in hours.

Mobile SDK Development Guide

Instrumentation and Event Collection

Toggle Event Logging

Check Event Logging Status

Set Upload Frequency (Android Only)