基础配置接口-阿里云帮助中心

初始化配置

初始化配置包括崩溃分析需要的配置项。

`setAppKey`

设置EMAS平台的appKey，必须配置。

接口定义

ApmOptions.Builder setAppKey(@NonNull String appKey)

所属类

ApmOptions.Builder

参数说明

参数	类型	是否必填	说明

参数	类型	是否必填	说明
appKey	String	是	EMAS平台的appKey，非空

`setAppSecret`

设置EMAS平台的appSecret，必须设置。

接口定义

ApmOptions.Builder setAppSecret(@NonNull String appSecret)

所属类

ApmOptions.Builder

参数说明

参数	类型	是否必填	说明

参数	类型	是否必填	说明
appSecret	String	是	EMAS平台的appSecret，非空

`setApplication`

设置Application实例，必须设置。

接口定义

ApmOptions.Builder setApplication(@NonNull Application application)

所属类

ApmOptions.Builder

参数说明

参数	类型	是否必填	说明

参数	类型	是否必填	说明
application	Application	是	非空

`addComponent`

添加崩溃分析组件，必须配置崩溃分析组件。

重要

只有添加了崩溃分析组件com.aliyun.emas.apm.crash.ApmCrashAnalysisComponent.class，才会开启崩溃分析功能。

接口定义

ApmOptions.Builder addComponent(@NonNull Class<? extends BaseComponent> component)

所属类

ApmOptions.Builder

参数说明

参数	类型	是否必填	说明

参数	类型	是否必填	说明
component	Class<? extends BaseComponent>	是	崩溃分析的组件是：`com.aliyun.emas.apm.crash.ApmCrashAnalysisComponent.class`

`setUserId`

设置用户ID，适合配置时已经有用户信息的情况。如果在初始化后要更新用户ID，请调用Apm#setUserId。

接口定义

ApmOptions.Builder setUserId(@Nullable String userId)

所属类

ApmOptions.Builder

参数说明

参数	类型	是否必填	说明

参数	类型	是否必填	说明
userId	String	否	配置用户id，长度不超过128个字符，如果超过128字符，测试App会抛出`IllegalArgumentException`，正式App会丢弃本次传递的数据。

`setUserNick`

设置用户昵称，适合配置时已经有用户信息的情况。如果在初始化后要更新用户昵称，请调用Apm#setUserNick。

接口定义

ApmOptions.Builder setUserNick(@Nullable String userNick)

所属类

ApmOptions.Builder

参数说明

参数	类型	是否必填	说明

参数	类型	是否必填	说明
userNick	String	否	配置用户昵称，长度不超过128个字符，如果超过128字符，测试App会抛出`IllegalArgumentException`，正式App会丢弃本次传递的数据。

`setChannel`

设置渠道标识。

接口定义

ApmOptions.Builder setChannel(@Nullable String channel)

所属类

ApmOptions.Builder

参数说明

参数	类型	是否必填	说明

参数	类型	是否必填	说明
channel	String	否	渠道标识，长度不超过128个字符，如果超过128字符，测试App会抛出`IllegalArgumentException`，正式App会丢弃本次传递的数据。

`openDebug`

打开debug日志。默认不开启。

接口定义

ApmOptions.Builder openDebug(boolean open)

所属类

ApmOptions

参数说明

参数	类型	是否必填	说明

参数	类型	是否必填	说明
open	boolean	是	true，开启。 false，关闭。

`build`

构建ApmOptions实例。

接口定义

ApmOptions build()

所属类

ApmOptions.Builder

返回值说明

类型	说明

类型	说明
ApmOptions	参数配置实例

代码示例

ApmOptions apmOptions = new ApmOptions.Builder()
        //必须配置application
        .setApplication(application)  
        //必须配置EMAS的appKey
        .setAppKey(appKey)    
        //必须配置EMAS的appSecret
        .setAppSecret(appSecret)
        //必须配置，否则不会打开崩溃分析功能
        .addComponent(ApmCrashAnalysisComponent.class)
        //可选配置，配置用户ID
        .setUserId(userId)
        //可选配置，配置用户昵称
        .setUserNick(userNick)
        //可选配置，设置App渠道
        .setChannel(channel)
        //可选配置，默认不开启
        .openDebug(true)
        //构建实例
        .build();

开启崩溃分析

开启崩溃分析包含两个阶段，预启动和启动崩溃分析。

说明

预启动，完成参数配置，可在隐私政策同意前调用。
启动，完成初始化，需在隐私政策同意后调用。

`preStart`

预启动，主要是完成配置，不会做初始化的工作，可以在同意隐私协议前调用。

接口定义

static void preStart(@NonNull ApmOptions options)

所属类

Apm

参数说明

参数	类型	是否必填	说明

参数	类型	是否必填	说明
options	ApmOptions	是	配置参数

`start`

启动崩溃分析，完成初始化的工作，需要在同意隐私协议后调用。

重要

调用start方法前，请确保执行了preStart方法，否则会导致初始化失败。

接口定义

static boolean start()

所属类

Apm

返回说明

类型	说明

类型	说明
boolean	true，初始化成功 false，初始化失败

`setUserId`

动态设置用户ID，以便在用户信息变更后动态更新用户ID。

接口定义

static void setUserId(@Nullable String userId)

所属类

Apm

参数说明

参数	类型	是否必填	说明

参数	类型	是否必填	说明
userId	String	否	配置用户id，长度不超过128个字符，如果超过128字符，测试App会抛出`IllegalArgumentException`，正式App会丢弃本次传递的数据。

`setUserNick`

动态设置用户昵称，以便在用户信息变更后动态更新用户昵称。

接口定义

static void setUserNick(@Nullable String userNick)

所属类

Apm

参数说明

参数	类型	是否必填	说明

参数	类型	是否必填	说明
userNick	String	否	配置用户昵称，长度不超过128个字符，如果超过128字符，测试App会抛出`IllegalArgumentException`，正式App会丢弃本次传递的数据。