全部产品

Android SDK接入(Maven集成)

本文介绍如何通过Maven集成方式添加依赖接入远程日志服务。

说明

  • 接入远程日志服务的Android SDK可采用Maven集成和本地集成2种方式添加依赖。推荐使用Maven集成方式添加依赖,可大幅简化接入操作。

  • 如需使用本地集成方式添加依赖,操作方法参见:Android SDK接入(本地集成)

前提条件

  • 已创建工作空间/应用。具体操作参见:移动研发平台 EMAS > 快速入门

  • 已打开控制台页面。具体操作参见:打开控制台页面

使用限制

  • 仅支持Android 4.2及以上版本。

  • 仅支持armeabi-v7a/arm64-v8a/x86/x86_64架构。

  • 日志在手机端最多存储7天。

接入概述

  1. 准备:获取AppKey/AppSecret;下载Android配置文件,获取远程日志公钥。

  2. 添加依赖:采用Maven集成方式。

  3. 接入服务:添加自定义Application,以及初始化代码;配置ABI;设置日志拉入级别。

  4. 打印日志:引入头文件;在代码中打印日志信息。

  5. 上报日志:引入头文件;上报缓存的日志信息到远程日志服务。

  6. 混淆配置:如App对代码进行乱序混淆,则修改混淆配置文件。

  7. 编译

准备

1:在控制台 > 工作空间概览页面 > 我的应用区域,单击Android应用图标,打开指定Android应用编辑配置右侧栏。

1F5E23B3-C848-45E4-95C8-F212C1F463B2

2:在编辑配置右侧栏,查看App的AppKey/AppSecret。

参数

说明

AppKey

用于唯一标识App。由系统生成,8位数字。

AppSecret

用于认证App。由系统生成,32位字符串。

截屏2021-01-26 下午3

3:在编辑配置右侧栏,单击下载Android配置按钮,下载App配置文件:aliyun-emas-services.json

4:打开配置文件,查询appmonitor.tlog.rsaSecret字段内容,即为远程日志公钥。公钥

注意

  • 为避免在日志中泄漏参数appkey/appsecret/rsaSecret或App运行过程中产生的数据,建议线上版本关闭SDK调试日志。

  • 由于所有用户使用统一的SDK接入,在接入过程中需要在代码中设置appkey/appsecret/rsaSecret参数,而此类参数与计量计费密切相关,为防止恶意反编译获取参数造成信息泄漏,建议您开启混淆,并进行App加固后再发布上线。

添加依赖

1:在项目build.gradle中的repositories节点内添加阿里云Maven仓库地址。

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

2:在项目build.gradle中的dependencies节点内添加依赖:

compile('com.aliyun.ams:alicloud-android-ha-adapter:1.1.5.0-open@aar') {
    transitive=true
}
compile('com.aliyun.ams:alicloud-android-tlog:1.1.4.0-open@aar') {
    transitive=true
}

3:在build.gradle项目文件的defaultConfig节点内根据实际需要配置ABI。

ndk {
        abiFilters 'armeabi'    //配置项。可选取值:armeabi/armeabi-v7a/x86/x86_64
}
注意

远程日志服务目前仅支持armeabi/armeabi-v7a/x86/x86_64架构。

接入服务

1、定义Application类,并编写onCreate方法启动服务:

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        initHa();
    }
    private void initHa() {
         AliHaConfig config = new AliHaConfig();
         config.appKey = "xxxxxxxx"; //配置项:appkey
         config.appVersion = "x.xx"; //配置项:应用的版本号
         config.appSecret = "xxxxxxxxxxxx"; //配置项:appsecret
         config.channel = "mqc_test"; //配置项:应用的渠道号标记,自定义
         config.userNick = null; //配置项:用户的昵称
         config.application = this; //配置项:应用指针
         config.context = getApplicationContext(); //配置项:应用上下文
         config.isAliyunos = false; //配置项:是否为yunos
         config.rsaPublicKey = "xxxxxxx"; //配置项:tlog公钥
         AliHaAdapter.getInstance().addPlugin(Plugin.tlog);
         AliHaAdapter.getInstance().openDebug(true);
         AliHaAdapter.getInstance().start(config);
         TLogService.updateLogLevel(TLogLevel.XXXXXX); //配置项:控制台可拉取的日志级别
    }
}

配置说明如下:

参数

说明

config.appKey

用于指定App的AppKey。

【数据类型】字符串

【如何获取】参见:步骤1

【是否必选】是

【是否可为空】否

【默认值】无

config.appVersion

用于设置App的版本号。

【数据类型】字符串

【格式要求】自定义

【取值范围】任意长度。

说明

该参数值将在控制台显示为下拉列表选项,建议短小凝练。

【是否必选】是

【是否可为空】否

【默认值】无

【大小写敏感】是。例如,vx.x和Vx.x不是一个版本。

【字符类型】英文大小写、数字。

说明

该参数不支持中文字符、特殊字符。

config.appSecret

用于指定App的AppSecret。

【数据类型】字符串

【如何获取】参见:步骤1

【是否必选】是

【是否可为空】否

【默认值】无

config.channel

用于设置渠道标识,上报至服务端,进行渠道区分。

【数据类型】字符串

【取值范围】任意长度

【是否必选】否

【是否可为空】是

【默认值】无

【字符类型】英文大小写、数字。

说明

该参数不支持中文字符、特殊字符。

config.userNick

用于设置用户昵称,上报至服务端,进行用户区分。后续可能依据该参数,进行数据检索。

【数据类型】字符串

【取值范围】任意长度

【是否必选】否

【是否可为空】是

【默认值】无

【字符类型】英文大小写、数字。

说明

该参数不支持中文字符、特殊字符。

【命名规范】自定义

config.application

用于指定本应用。

注意

不能指向其他应用。

【数据类型】对象

【是否必选】是

【是否可为空】否

【默认值】无

config.context

用于指定App的上下文对象,设置getApplicationContext();即可。

【数据类型】对象

【是否必选】是

【是否可为空】否

【默认值】无

config.isAliyunos

用于判断App所在平台是否为YunOS。

【数据类型】布尔型

【取值范围】false/true

【是否必选】否

【是否可为空】是

【默认值】false

config.rsaPublicKey

用于指定远程日志公钥。

【数据类型】字符串

【如何获取】参见:步骤1

【是否必选】是

【是否可为空】否

【默认值】无

TLogLevel.XXXXXX

用于全局设置控制台可拉取的日志的级别。

【数据类型】枚举型

【取值范围】

  • VERBOSE:可拉取所有级别的日志。

  • DEBUG:可拉取DEBUG/INFO/WARN/ERROR级别的日志。

  • INFO:可拉取INFO/WARN/ERROR级别的日志。

  • WARN:可拉取WARN/ERROR级别的日志。

  • ERROR:可拉取ERROR级别的日志。

【是否必选】是

【默认取值】ERROR

【配置说明】

  • TLogService.updateLogLevel()函数可选调用,如未调用,则全局默认可拉取的日志级别为ERROR。

  • 日志级别说明参见:术语解释

2:在AndroidManifest.xml中添加代码段注册Application

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

打印日志

1:如业务流程触发日志输出,需引入头文件:

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

2:在适当位置添加代码,打印日志信息。示例代码:

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");

函数TLogService.<LogLevel>(<MODEL>,<TAG,<MESSAGE>);

说明:用于输出指定级别的日志信息。

参数

说明

LogLevel

指定拉取的日志级别。日志级别说明参见:术语解释

【数据类型】枚举型

【取值范围】

  • logv:输出VERBOSE(调试详情)级别的日志。

  • logd:输出DEBUG(调试信息)级别的日志。

  • logi:输出INFO(一般信息)级别的日志。

  • logw:输出WARN(警告信息)级别的日志。

  • loge:输出ERROR(错误信息)级别的日志。

【配置说明】输出的日志是否可以被控制台拉取,取决于TLogService.updateLogLevel()函数的参数设置。例如,当TLogService.updateLogLevel(TLogLevel.WARN)时,则控制台拉取不到通过logv/logd/logi输出的日志。

MODEL

用于设置输出日志内容的功能模块,便于后续根据来源筛选日志。

【数据类型】字符串

【字符类型】英文大小写、中文、数字、特殊字符

【是否必选】是

【是否大小写敏感】否

【示例】“推送功能模块Push”

TAG

用于设置日志的关键字,便于后续根据标签筛选日志。

【数据类型】字符串

【字符类型】英文大小写、中文、数字、特殊字符

【是否必选】是

【是否大小写敏感】否

【示例】“推送功能模块收到了推送Push.receive,推送功能模块点击了推送Push.click”

MESSAGE

用于输出日志信息。

【数据类型】字符串

【字符类型】英文大小写、中文、数字、特殊字符

【是否必选】是

上报日志

1:如业务流程触发日志输出,需引入头文件:

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

2:在适当位置添加代码,主动上报当日日志信息。示例代码:

TLogService.positiveUploadTlog("COMMENT");

说明

说明

  • 函数TLogService.positiveUploadTlog(<COMMENT>);,用于主动上报当日缓存的日志信息。

  • 主动上报时系统会删除历史缓存日志,仅上报最新缓存的日志信息,避免相同日志重复上报。

参数

说明

COMMENT

上报日志时设置的备注信息。可用于记录待定位的问题。

【数据类型】字符串

【字符类型】英文大小写、中文、数字、特殊字符

【是否必选】否

混淆配置

如App对代码进行乱序混淆,则在混淆配置文件中添加代码段:

#-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

编译

如同时使用其他阿里云产品,可能会因为依赖中存在UTDID冲突,造成编译失败。解决办法参见:SDK UTDID冲突解决方案

样例代码

远程日志服务Android SDK接入工程样例参见:Demo工程