移动性能监控 SDK 详细集成文档
一. Gradle配置
- 在 Project 的 build.gradle 文件中添加ArgusAPM的相关配置，示例如下：
在项目根目录的 build.gradle（注意：不是 app/build.gradle） 中添加以下配置：
buildscript {
repositories {
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:2.2.3'
classpath 'com.qihoo360.argusapm:argus-apm-gradle:2.0.1.1006'
}
}
allprojects {
repositories {
jcenter()
}
}
- 在app的build.gradle 文件中添加插件引用，示例如下：
apply plugin: 'argusapm'
//在android的配置代码块里面(为了兼容Android6.0系统):
android {
useLibrary ‘org.apache.http.legacy‘
}- 特殊配置
如果接入过程一切正常，可忽略该部分。
ArgusAPM的部分监控代码，是通过Gradle的Transform API，在编译期织入的，由于我们在开发中可能会引入各种lib库，而这些库可能会因各种各样的原因，不允许我们织入，具体表现就是，编译期报如下错：
can't determine superclass of missing type**
when weaving type**
when weaving classes
when weaving
when batch building BuildConfig[null] #Files=0 AopXmls=#0[Xlint:cantFindType]
如果您在编译期遇到如上问题，则需要找到对应报错的库，把这个库过滤掉，具体过滤方式：
1）在主项目build.gradle同级目录下，新增argusapm.gradle文件，内容如下：
apply plugin: 'argusapm'
argusApmAjxConfig
{
exclude 'com.qihoo360.xxx' // 跳过 com.qihoo360.xxx包下的所有文件
excludeJar 'libammsdk' // 跳过 libammsdk.jar
}2）将app的build.gradle中的apply plugin: ‘argusapm’ 修改为apply from: ‘argusapm.gradle’。
二. AndroidManifest.xml配置
a. 权限相关
<!--需要申请如下权限-->
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.BATTERY_STATS" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
b. 组件使用 需要在AndroidManifest.xml里添加如下组件声明：
<provider
android:name="com.argusapm.android.core.storage.ApmProvider"
android:authorities="{当前应用的applicationId}.apm.storage"
android:exported="false" />
**三. 代码部分（重要类介绍及使用方法）**
- Config.ConfigBuilder配置项方法说明：
| 方法 | 说明 |
|---|---|
| setAppContext | 设置ArgusAPM所需要的上下文环境（必选） |
| setAppName | 设置APP名称（英文，必选） |
| setAppVersion | 设置APP版本号（必选） |
| setApmid | 设置ArgusAPM分配给应用的唯一标识appkey（必选，由移动性能监控服务提供，不可随意设置） |
| setRuleRequest | 设置云规则请求 |
| setUpload | 设置ArgusAPM采集到的数据上传 |
| setEnabled | 设置ArgusAPM在当前进程是否启用某个收集模块的逻辑，用于多进程场景（可选），参数见flag说明 |
| setDisabled | 设置ArgusAPM在当前进程是否禁用某个收集模块的逻辑，用于多进程场景（可选），参数见flag说明 |
| build | 最终生成Config对象 |
- Client类的主要方法（启动移动性能监控服务）：
| 方法 | 说明 |
|---|---|
| attach | 使用Config.ConfigBuilder初始化ArgusAPM（建议在Application的attachBaseContext里调用） |
| isDebugOpen | 是否开启debug模式,，如果开启的话，则会有悬浮窗功能 |
| startWork | 启用ArgusAPM开始工作 |
四. 一个简单的SDK初始化代码
在项目的Application的attachBaseContext里调用如下代码即可
// 注：根据实际情况，来选择主进程
// 如果您有常驻进程，则主进程是常驻进程
// 如果您是单进程模型，则主进程是UI进程
boolean isMainProcess = TextUtils.equals(getPackageName(), getCurrentProcessName());
Config.ConfigBuilder builder = new Config.ConfigBuilder()
.setAppContext(this)
.setRuleRequest(new RuleSyncRequest())
.setUpload(new CollectDataSyncUpload())
.setAppName("apm_demo")
.setAppVersion("0.0.1")
.setApmid("apm_demo");
//单进程应用可忽略builder.setDisabled相关配置。
if(!isMainProcess) {
//除了“主进程”，其他进程不需要进行数据上报、清理等逻辑。“主进程”通常为常驻进行，如果无常驻进程，即为UI进程。
builder.setDisabled(ApmTask.FLAG_DATA_CLEAN) //只有主进程才清理数据
.setDisabled(ApmTask.FLAG_CLOUD_UPDATE)//只有主进程才执行云控
.setDisabled(ApmTask.FLAG_DATA_UPLOAD)//只有主进程才执行数据上报
.setDisabled(ApmTask.FLAG_COLLECT_ANR)//只有主进程才收集ANR
.setDisabled(ApmTask.FLAG_COLLECT_FILE_INFO) //只有主进程才收集文件信息
.setDisabled(ApmTask.FLAG_COLLECT_CPU);//只有主进程才收集CPU数据
}
//builder.setEnabled(ApmTask.FLAG_COLLECT_ACTIVITY_AOP); //activity采用aop方案时打开，默认关闭即可。
//builder.setEnabled(ApmTask.FLAG_LOCAL_DEBUG); //是否读取本地配置，默认关闭即可。
Client.attach(builder.build());
// Client.isDebugOpen(true, getPackageName());// 是否展示debug模式悬浮窗。根据项目需求添加
Client.startWork();注意：
apmid(appkey)名称必须保证唯一性，由Argus APM统一分配，请勿随意填写。
如此，移动性能监控 SDK就接入完成,更多技巧请参考详细接入文档。
五. 接入成功日志输出
接入完毕，运行应用，如果看到以下log，说明接入成功:
六. 混淆相关
无需任何混淆配置，因为ArgusAPM的AAR自带Proguard文件，直接接入ArgusAPM-SDK即可生效。