Was this helpful?

In the 'Configuration' menu of the App Services admin portal you can custom configure what data is captured by Apigee App Monitoring, as well as specific features in your app.

You can control your App Monitoring configuration by selecting 'Configuration' in the App Services admin portal. Any changes you make to monitoring configuration settings will be pushed to affected user devices immediately, and will take effect the next time they restart the app. There is no need for your users to download a new version of your app.

Monitoring configuration types

Apigee App Monitoring allows you to custom configure three different types of monitoring, which can be accessed in the 'Configuration' menu of the App Services admin portal:

  • Default Configs: These settings will be applied to all clients not in the beta testing or A/B testing groups.
  • Beta Testing Configs: These settings will be applied to specific devices. For example, if you run a beta test, you can specify configurations that will apply exclusively to the devices used in the test. For these devices, these settings will override those in Default Configs. For more information on setting up beta testing with App Services, see Beta testing.
  • A/B Testing Configs: These settings will be applied to a percentage of devices running your app. For example, if you run an A/B test, you can specify monitoring settings for one set of devices and other configurations for another set of devices. For more information on setting up A/B testing with App Services, see A/B testing.

Log & network capture settings

The following settings are available in the Default Configs, Beta Testing Configs, and A/B Testing Configs menus:

Checkbox/Field Configuration Setting
Enable Log Capturing Check to enable monitoring of the app's error log. The checkbox is checked by default.
Log Capture Levels Specifies the highest error level to be monitored in the error log. Debug is the default. For more information on error and crash logging with Apigee App Monitoring, see Monitoring app errors and crashes.
Enable Network Monitoring Check to enable monitoring of network performance. The checkbox is checked by default.

Device data capture settings

The following settings are available in the Default Configs, Beta Testing Configs, and A/B Testing Configs menus:

Checkbox/Field Configuration Setting
Enable Device Data Capture Check to enable monitoring of user device data. The checkbox is checked by default.
Read Location Check to capture the geographic location of the user device. 'Enable Device Data Capture' must also be checked.
Read IMEI Check to capture the identity number (IMEI) of the device. 'Enable Device Data Capture' must also be checked. Note that an IMEI cannot be obtained from iOS devices.
Read Device Model Checked by default. Captures the device model. 'Enable Device Data Capture' must also be checked.
Read Network Carrier Checked by default. Captures the network carrier for the device. 'Enable Device Data Capture' must also be checked.
Read Apigee Device Id Check to capture the App Services-generated ID for the device. 'Enable Device Data Capture' must also be checked. The Apigee device id is a unique ID that is randomly generated in the Mobile Analytics SDK when your app is first started in the device. This ID is needed to identify devices when you set up Beta test configurations

Data sampling settings

The following settings are available in the Default Configs, Beta Testing Configs, and A/B Testing Configs menus:

Checkbox/Field Configuration Setting
Data Upload Interval (in seconds) Specifies how often Apigee App Monitoring should capture monitoring data. The default is 300 seconds. The minimum rate is 60 seconds – any value below 60 will default to 60.
Sampling Rate (in Percentage)

Specifies the percentage of total devices running your app to capture monitoring data from. The default is 100 percent.

Note: omit the '%' symbol in this field

Upload When Roaming Check to specify that the user's device should upload monitoring data when their device is roaming.
Upload When Not on WIFI Checked by default. Specifies that the user's device should upload monitoring data when their device is not connected to WIFI.

Refreshing app monitoring configuration

If your App Monitoring settings change while your app is running, you will need to manually refresh your App Monitoring configuration file. This will cause any changes, such as disabling app usage monitoring, disabling network monitoring, or changes to custom logging to take effect immediately.

To refresh your App Monitoring configuration file, do the following:

if ([[ApigeeMonitoringClient sharedInstance] refreshConfiguration]) {
    ApigeeLogInfo("MY_TAG","configuration refreshed");
} else {
    ApigeeLogInfo("MY_TAG","unable to refresh configuration");
}			
		
if (MonitoringClient.refreshConfiguration(null)) {
    Log.i("MY_TAG","configuration refresh requested");
} else {
    Log.i("MY_TAG","unable to refresh configuration");
}
		

refreshConfiguration executes asynchronously. If you'd like to know when the re-read of the configuration has completed, pass a non-null value for the method argument. The argument is an interface for ConfigurationReloadedListener:

public interface ConfigurationReloadedListener {
    public void configurationReloaded();
}
		

Please note that if you specify a non-null value for the listener interface, the configurationReloaded callback method will be called on a background (non-UI) thread.

This call executes synchronously. To execute it asynchronously, pass in a callback function.

//This code assumes your instance of Apigee.Client is named 'client'
client.monitor.downloadConfig();
		

Add new comment

Provide your email address if you wish to be contacted offline about your comment.
We will not display your email address as part of your comment.

We'd love your feedback and perspective! Please be as specific as possible.
Type the characters you see in this picture. (verify using audio)

Type the characters you see in the picture above; if you can't read them, submit the form and a new image will be generated. Not case sensitive.