Android SDK integration (Maven)

Prerequisites

• You have created a project and an application. For more information, see Quick Start.

Limits

• Supports only Android 4.2 and later.

• Supports only the armeabi-v7a, arm64-v8a, x86, and x86_64 architectures.

• Logs are stored on the mobile device for a maximum of 7 days.

Integration overview

1. Add dependencies: Use Maven integration.

2. Connect to the service: Add a custom Application and initialization code, configure the ABI, and set the log pull level.

3. Print logs: Import the header file and print log information in the code.

4. Configure obfuscation: If your app obfuscates code, modify the obfuscation configuration file.

5. Compile.

Add dependencies

1. In the repositories node of your project's build.gradle file, add the Alibaba Cloud Maven repository URL.

repositories {
    maven { url "http://maven.aliyun.com/nexus/content/repositories/releases" }
}

2. In the dependencies node of the project's build.gradle file, add the dependencies.

implementation 'com.aliyun.ams:alicloud-android-ha-adapter:1.2.4.0-open'
implementation 'com.aliyun.ams:alicloud-android-tlog:1.1.8.0-open'

3. In the defaultConfig node of the build.gradle file, configure the ABI as needed.

ndk {
        abiFilters 'arm64-v8a'    // Configuration item. Available values: armeabi-v7a, arm64-v8a, x86, x86_64
}

Service access

1. Pre-initialize the SDK.

Pre-initialize the SDK in the `Application.onCreate` method.

public class MyApplication extends Application {
   @Override
   public void onCreate() {
     super.onCreate();  
     AliHaAdapter.getInstance().preStart(this);
   }
}

2. Obtain the key information from the EMAS console.

3. Enable Remote Log Access.

Enable Remote Log Access after the user agrees to the privacy policy.

private void startHa() {
  AliHaConfig config = new AliHaConfig();
  config.appKey = "xxxxxxxx"; // Configuration item: appkey
  config.appVersion = "x.xx"; // Configuration item: The version number of the application.
  config.appSecret = "xxxxxxxxxxxx"; // Configuration item: appsecret
  config.channel = "mqc_test"; // Configuration item: The channel ID of the application. This is a custom value.
  config.userNick = null; // Configuration item: The nickname of the user.
  config.application = this; // Configuration item: The application pointer.
  config.context = getApplicationContext(); // Configuration item: The application context.
  config.isAliyunos = false; // Configuration item: Specifies whether the OS is YunOS.
  config.rsaPublicKey = "xxxxxxx"; // Configuration item: The tlog public key, which corresponds to AppRsaSecret in the console.
  AliHaAdapter.getInstance().addPlugin(Plugin.tlog);
  AliHaAdapter.getInstance().start(config);

  TLogService.updateLogLevel(TLogLevel.XXXXXX); // Configuration item: The log level that can be pulled from the console.
}

The configuration is as follows:

3. Data collection.

Configure data collection settings as early as possible while ensuring compliance. By default, device information, system info, and the network type are collected.

AliHaConfig config = new AliHaConfig();
// You can disable the collection of device, system, and network information based on compliance requirements.
config.noCollectionDataType = AliHaConfig.NO_DEVICE_DATA | AliHaConfig.NO_OS_DATA | AliHaConfig.NO_NETWORK_DATA;  

Data collection parameters:

4. In AndroidManifest.xml, add a code segment to register the Application.

<application
    android:name=".MyApplication"
    android:icon="@mipmap/ic_launcher"
    android:label="@string/app_name"
    android:supportsRtl="true"
    android:theme="@style/AppTheme" >
    ...
</application>

Print logs

1. If your business process triggers log output, import the header file.

import com.alibaba.ha.adapter.service.tlog.TLogService;

2. Add code in the appropriate location to print log information. The following is sample code:

TLogService.logv("MODEL","TAG","MESSAGE");
TLogService.logd("MODEL","TAG","MESSAGE");
TLogService.logi("MODEL","TAG","MESSAGE");
TLogService.logw("MODEL","TAG","MESSAGE");
TLogService.loge("MODEL","TAG","MESSAGE");

Function: TLogService.<LogLevel>(<MODEL>, <TAG>, <MESSAGE>);

Description: Prints log information for a specified level.

Obfuscation configuration

If your app obfuscates code, add the following code segment to the obfuscation configuration file:

-keep class com.taobao.tao.log.**{*;}
-keep public class * extends com.taobao.android.tlog.protocol.model.request.base.FileInfo{*;}
-keepattributes Exceptions,InnerClasses,Signature,Deprecated,SourceFile,LineNumberTable,*Annotation*,EnclosingMethod

Compile

If you use other Alibaba Cloud products at the same time, a UTDID conflict in the dependencies may cause the compilation to fail. For more information about how to resolve this issue, see Solutions to UTDID conflicts in the SDK.

Sample code

For a sample project that shows how to integrate the Android SDK for the Remote Log Service, see the Demo project.