接入Android应用 - 应用实时监控服务ARMS

用户体验监控提供了非常全面的移动端应用监控能力，支持对应用性能、崩溃、卡顿等关键指标的进行实时监控与分析。本文介绍如何接入Android应用。

集成SDK

支持版本

Android 7.0 及以上的版本

Maven自动集成（推荐）

通过在 Android Studio 工程的 build.gradle 配置脚本中添加 maven 线上依赖，并导入最新版本 SDK。

说明

建议从以下链接获取最新版本SDK：SDK版本说明。

在工程根目录下的 build.gradle 配置脚本中添加插件依赖，示例如下：

buildscript {
  repositories {
    mavenLocal()
    google()
    mavenCentral()
    gradlePluginPortal()
  }
  
  dependencies {
    // 导入阿里云 ARMS RUM 插件依赖
    classpath "com.aliyun.rum:alibabacloud-android-rum-plugin:2.2.16"
  }
}

在工程 App 模块对应的 build.gradle 配置脚本中启用插件和添加SDK依赖，示例如下：

// 启用阿里云 ARMS RUM 插件
apply plugin: "com.aliyun.rum"

dependencies {
  // 导入阿里云 ARMS RUM SDK
  implementation("com.aliyun.rum:alibabacloud-android-rum-sdk:2.2.16")
}

手动集成

下载SDK并解压

下载SDK后，并解压.zip文件后得到内容如下：

libs文件夹，包含必须的jar包和jni库
repo文件夹，包含必须的插件
assets文件夹，不包含必须的资源文件

工程配置

复制 repo 文件夹到项目根目录
复制 libs 文件夹到 App Module 目录
复制libs/assets中的文件到App/src/assets目录中。如下图：

打开项目根目录下的 build.gradle （Gradle 7.0 及以下）或 settings.gradle （Gradle 7.0 以上）文件，在 repositories 块中加入以下 maven 配置：

build.gradle文件配置

buildscript {
    repositories {
        maven {
            url uri('./repo')
        }
        //... 其他配置
    }
}

allprojects {
    repositories {
        maven {
            url uri('./repo')
        }
        //... 其他配置
    }
}

//... 其他配置

settings.gradle文件配置

pluginManagement {
    repositories {
        maven {
            url uri('./repo')
        }
        //... 其他配置
    }
}
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        maven {
            url uri('./repo')
        }
        //... 其他配置
    }
}
//... 其他配置

在项目根目录下的 build.gradle 文件中，加入 classpath 配置：

// 不区分Gradle版本，加入下面
buildscript {
    dependencies {
        classpath "com.aliyun.rum:alibabacloud-android-rum-plugin:2.2.16"
    }
}
//... 其他配置

打开App Module下的build.gradle文件，导入AlibabaCloudRUM插件和依赖，如下：

apply plugin: "com.aliyun.rum"
//... 其他配置
android {
    //... 其他配置
    sourceSets {
        main {
            jniLibs.srcDirs = ['libs']
        }
    }
    //... 其他配置
}

dependencies {
    implementation files('libs/alibabacloud-android-rum-sdk.jar')
    //... 其他配置
}

插件配置

在项目App Module目录下的 build.gradle 文件中，按需添加plugin配置：

AlibabacloudRumExt {
    // 排除不需要插桩的包
    excludePackages = [
        "com.example.internal",      // 排除内部实现包
        "com.myapp.debug",           // 排除调试相关包
        "com.thirdparty.analytics"   // 排除第三方分析SDK
    ]
}
//... 其他配置

权限配置

阿里云 ARMS RUM SDK 需要宿主App授予以下权限，确保已引入如下权限：

<!--  必须  -->
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<!--  可选  -->
<uses-permission android:name="android.permission.READ_PHONE_STATE"/>
<uses-permission android:name="android.permission.READ_BASIC_PHONE_STATE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>

混淆配置

若您的应用使用proguard混淆，请添加以下配置：

-keep public class com.alibabacloud.rum.** { *; }
-dontwarn com.alibabacloud.rum.**

-optimizations !code/simplification/*,!field/*,!class/merging/*,!method/propagation/*,!class/unboxing/enum,!code/allocation/variable

初始化SDK

请在自定义Application的onCreate函数首行添加以下代码，示例如下：

同步启动

import com.alibabacloud.rum.AlibabaCloudRum;

public class YourApplication extends Application {
  @Override
  public void onCreate() {
    super.onCreate();
    // SDK版本 >= 2.0.0
    AlibabaCloudRum.withServiceId("") // ServiceId 在创建 RUM 应用时获取
          .withWorkspace("") // Workspace 在创建 RUM 应用时获取
          .withEndpoint("") // Endpoint 在创建 RUM 应用时获取
          .start(getApplicationContext());

    // SDK版本 < 2.0.0
    AlibabaCloudRum.withAppID("<your appid>") // AppID，步骤一创建RUM应用时获取。
        .withConfigAddress("<your config address>") // ConfigAddress，步骤一创建RUM应用时获取。
        .start(getApplicationContext());
  }
}

异步启动

SDK版本 >= 2.2.9 支持异步启动。

说明

使用异步启动的方式SDK启动流程不阻塞宿主APP，但SDK启动前产生的数据会有采集不到的风险。

import com.alibabacloud.rum.AlibabaCloudRum;

public class YourApplication extends Application {
  @Override
  public void onCreate() {
    super.onCreate();

    // SDK版本 >= 2.2.9
    AlibabaCloudRum.withServiceId("") // ServiceId 在创建 RUM 应用时获取
      .withWorkspace("") // Workspace 在创建 RUM 应用时获取
      .withEndpoint("") // Endpoint 在创建 RUM 应用时获取
      .start(getApplicationContext(), true);
  }
}

接入验证

启动已经集成了SDK的APK应用，查看Android Studio Logcat日志，搜索AlibabaCloudRUM关键字（或者过滤 AlibabaCloudRUM 标签），出现如下log则表示SDK集成成功且数据开始采集。