Debug logging is a crucial feature for monitoring and troubleshooting applications integrated with the Adobe Experience Platform SDK. This guide provides detailed steps on how to enable debug logging for both Android and iOS platforms, following Adobe’s recommended practices.
Introduction
Debug logging allows developers to track the internal operations of their applications, making it easier to identify and resolve issues. By enabling debug logging, you can capture detailed information about your application’s behavior, which is essential for effective troubleshooting and performance monitoring.
Problem Statement
When integrating the Adobe Experience Platform SDK into your mobile applications, it is vital to enable debug logging to ensure that any issues can be quickly identified and addressed. This guide will walk you through the steps necessary to enable debug logging on both Android and iOS platforms.
Enabling Debug Logging on Android
To enable debug logging on Android, follow these steps:
- Set Log Level: Use the MobileCore.setLogLevel method to set the desired logging level. In production environments, it’s recommended to use LoggingMode.ERROR or LoggingMode.WARNING to avoid performance and security concerns.
java
Copy code
import com.adobe.marketing.mobile.MobileCore;
import com.adobe.marketing.mobile.LoggingMode;
MobileCore.setLogLevel(LoggingMode.DEBUG); // or LoggingMode.VERBOSE, LoggingMode.WARNING, LoggingMode.ERROR
Ensure this code is executed early in your application’s initialization process.
Enabling Debug Logging on iOS
For iOS, the setup involves handling application lifecycle events and integrating with Adobe’s SDK as follows:
- Register Lifecycle Extension: Register the Lifecycle extension with the SDK Core in your app delegate’s application:didFinishLaunchingWithOptions: method.
objective
Copy code
#import “AEPMobileCore.h”
#import “AEPMobileLifecycle.h”
– (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
[AEPMobileCore registerExtensions:@[AEPMobileLifecycle.class] completion:^{
// Initialization complete
}];
return YES;
}
- Start Lifecycle Data Collection: Start collecting lifecycle data by calling lifecycleStart: from within the completion block of registerExtensions:. Ensure this is done when the application is not in the background state to avoid unnecessary lifecycle counts.
objective
Copy code
– (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
const UIApplicationState appState = application.applicationState;
[AEPMobileCore registerExtensions:@[AEPMobileLifecycle.class] completion:^{
if (appState != UIApplicationStateBackground) {
[AEPMobileCore lifecycleStart:nil];
}
}];
return YES;
}
- Handle Lifecycle Events: Implement methods to handle lifecycle events such as entering foreground and background states to appropriately start and pause lifecycle data collection.
objective
Copy code
– (void)applicationWillEnterForeground:(UIApplication *)application {
[AEPMobileCore lifecycleStart:nil];
}
– (void)applicationDidEnterBackground:(UIApplication *)application {
[AEPMobileCore lifecyclePause];
}
Considerations
- Logging Levels: Use LoggingMode.DEBUG or LoggingMode.VERBOSE for development and testing purposes to gather detailed information. However, restrict usage to LoggingMode.ERROR or LoggingMode.WARNING in production environments to maintain performance and security.
- Lifecycle Metrics: Lifecycle metrics provide valuable insights into app usage patterns. Ensure proper integration with Adobe Analytics or other Experience Cloud solutions to leverage these metrics effectively.
By following these guidelines, you can effectively enable and manage debug logging for the Adobe Experience Platform SDK across both Android and iOS platforms, ensuring robust application monitoring and troubleshooting capabilities. For further details, refer to Adobe’s comprehensive SDK documentation and support resources.
Leave a Reply