Android SDK快速入门_日志服务(SLS)-阿里云帮助中心

本文介绍如何快速使用日志服务Android SDK采集日志。

前提条件

已安装Android SDK。具体操作，请参见安装Android SDK 。

快速使用

您可以按照以下方式初始化SDK，并通过调用 addLog 方法上报日志。

// 建议您全局保存LogProducerConfig实例和LogProducerClient实例。
private LogProducerConfig config = null;
private LogProducerClient client = null;
 * 初始化SDK
private void initProducer() {
    try {
        // 日志服务的服务接入点。此处必须是以https://或http://开头。
        final String endpoint = "your endpoint";
        final String project = "your project";
        final String logstore = "your logstore";
        config = new LogProducerConfig(context, endpoint, project, logstore);
        // 设置日志主题。
        config.setTopic("example_topic");
        // 设置tag信息，此tag信息将被附加在每条日志上。
        config.addTag("example", "example_tag");
        // 是否丢弃过期日志。0表示不丢弃，把日志时间修改为当前时间; 1表示丢弃。默认值为1。
        config.setDropDelayLog(0);
        // 是否丢弃鉴权失败的日志。0表示不丢弃，1表示丢弃。默认值为0。
        config.setDropUnauthorizedLog(0);
        // LogProducerCallback为可选配置, 如果您不需要关注日志的发送成功或失败状态, 可以不注册callback。
        // 如果需要动态化配置AccessKey，建议设置LogProducerCallback，并在onCall方法被调用时更新AccessKey。
        final LogProducerCallback callback = new LogProducerCallback() {
            @Override
            public void onCall(int resultCode, String reqId, String errorMessage, int logBytes, int compressedBytes) {
                // resultCode: 状态码, 更多信息，请参见错误码。
                // reqId: 请求ID，已废弃。
                // errorMessage: 失败信息。
                // logBytes: 日志原始字节数。
                // compressedBytes: 日志压缩字节数。
                final LogProducerResult result = LogProducerResult.fromInt(resultCode);
                if (LogProducerResult.LOG_PRODUCER_SEND_UNAUTHORIZED == result || LogProducerResult.LOG_PRODUCER_PARAMETERS_INVALID == result) {
                    // 更新AccessKey或者SDK的初始化参数。
        // 需要关注日志的发送成功或失败状态时, 第二个参数需要传入一个callback。
        client = new LogProducerClient(config, callback);
    } catch (LogProducerException e) {
        e.printStackTrace();
// 请求AccessKey信息。
private void requestAccessKey() {
    // 推荐您先使用移动端日志直传服务配置AccessKey信息。
    // ...
    // 获取AccessKey信息后，完成更新。
    updateAccessKey(accessKeyId, accessKeySecret, securityToken);
// 更新AccessKey信息。
private void updateAccessKey(String accessKeyId, String accessKeySecret, String securityToken) {
    // 通过STS服务获取的AccessKey包含securityToken，需要使用以下方式更新。
    if (null != securityToken && !"".equals(securityToken)) {
        config.resetSecurityToken(accessKeyId, accessKeySecret, securityToken);
    } else {
        // 不是通过STS服务获取的AccessKey，使用以下方式更新。
        config.setAccessKeyId(accessKeyId);
        config.setAccessKeySecret(accessKeySecret);
 * 上报日志
public void addLog() {
    Log log = new Log();
    // 您可以根据实际业务需要调整需上报的字段。
    log.putContent("content_key_1", 123456);
    log.putContent("content_key_2", 23.34f);
    log.putContent("content_key_3", "中文️");
    log.putContent(null, "null");
    log.putContent("null", (String) null);
    client.addLog(log);
}

// 支持独立配置或一起配置Endpoint、ProjectName、Logstore等参数。
// 更新Endpoint。
config.setEndpoint("your new-endpoint");
// 更新Project名称。
config.setProject("your new-project");
// 更新Logstore名称。
config.setLogstore("your new-logstore");

// 如果您在初始化LogProducerClient时已经完成了LogProducerCallback的初始化，以下代码可忽略。
final LogProducerCallback callback = new LogProducerCallback() {
    @Override
    public void onCall(int resultCode, String reqId, String errorMessage, int logBytes, int compressedBytes) {
        // resultCode: 状态码。更多信息，请参见错误码。
        // reqId: 请求ID, 已废弃。
        // errorMessage: 失败信息。
        // logBytes: 日志原始字节数。
        // compressedBytes: 日志压缩字节数。
        final LogProducerResult result = LogProducerResult.fromInt(resultCode);
        if (LogProducerResult.LOG_PRODUCER_SEND_UNAUTHORIZED == result || LogProducerResult.LOG_PRODUCER_PARAMETERS_INVALID == result) {
            // 需要更新AccessKey或者SDK的初始化参数。
            requestAccessKey();
// 需要关注日志的发送成功或失败状态时, 第二个参数需要传入一个callback。
client = new LogProducerClient(config, callback);
// 请求AccessKey信息。
private void requestAccessKey() {
    // 推荐您先使用移动端日志直传服务配置AccessKey信息。
    // ...
    // 获取AccessKey信息后，完成更新。
    updateAccessKey(accessKeyId, accessKeySecret, securityToken);
// 更新AccessKey信息。
private void updateAccessKey(String accessKeyId, String accessKeySecret, String securityToken) {
    // 通过STS服务获取的AccessKey包含securityToken，需要使用以下方式更新。
    if (null != securityToken && !"".equals(securityToken)) {
        config.resetSecurityToken(accessKeyId, accessKeySecret, securityToken);
    } else {
        // 不是通过STS服务获取的AccessKey，使用以下方式更新。
        config.setAccessKeyId(accessKeyId);
        config.setAccessKeySecret(accessKeySecret);
}

```
// 设置日志来源。
config.setSource("your new-source");
// 设置日志主题。
config.setTopic("your new-topic");
// 设置tag信息，此tag信息将被附加在每条日志上。
config.addTag("test", "your new-tag");
```

private void initProducer() {
    // 1表示开启断点续传功能，0表示关闭。默认值为0。
    config.setPersistent(1);
    // 持久化的文件名，需要保证文件所在的文件夹已创建。
    final String persistentFilePath = getFilesDir() + File.separator + "log_data";
    config.setPersistentFilePath(persistentFilePath);
    // 持久化文件滚动个数，建议设置为10。
    config.setPersistentMaxFileCount(10);
    // 每个持久化文件的大小，单位为Byte，格式为N*1024*1024。建议N的取值范围为1~10。
    config.setPersistentMaxFileSize(N*1024*1024);
    // 本地最多缓存的日志数量，不建议超过1048576，默认为65536。
    config.setPersistentMaxLogCount(65536);
}

-keep class com.aliyun.sls.android.producer.* { *; }
-keep interface com.aliyun.sls.android.producer.* { *; }

<uses-permission android:name="android.permission.INTERNET" />

参数	数据类型	说明
setTopic	String	设置topic字段的值。默认值为空符串。
addTag	String	设置tag，格式为 `tag:xxxx` 。默认值为空符串。
setSource	String	设置source字段的值。默认值为Android。
setPacketLogBytes	Int	每个缓存的日志包大小上限。超过上限后，日志会被立即发送。取值范围为1~5242880，默认值为1024 * 1024，单位为字节。
setPacketLogCount	Int	每个缓存的日志包中包含日志数量的最大值。超过上限后日志会被立即发送。取值范围为1~4096，默认值为1024。
setPacketTimeout	Int	被缓存日志的发送超时时间，如果缓存超时，日志会被立即发送。默认值为3000，单位为毫秒。
setMaxBufferLimit	Int	单个Producer Client实例可以使用的内存上限，超出缓存时add_log接口会立即返回失败。默认值为64 * 1024 * 1024。
setSendThreadCount	Int	发送线程数。开启断点续传后，该值强制为1。
setPersistent	Int	是否开启断点续传功能。 1：开启。 0（默认值）：关闭。
setPersistentFilePath	String	持久化的文件名，需保证文件所在的文件夹已创建。配置多个LogProducerConfig实例时，需确保唯一性。默认值为空。
setPersistentForceFlush	Int	是否开启每次AddLog强制刷新功能。 1：开启。开启后对性能会有影响，建议谨慎开启。 0（默认值）：关闭。在高可靠性场景时建议开启，
setPersistentMaxFileCount	Int	持久化文件滚动个数，建议设置成10。默认值为0。
setPersistentMaxFileSize	Int	每个持久化文件的大小，单位为Byte，格式为N10241024。建议N的取值范围为1~10。
setPersistentMaxLogCount	Int	本地最多缓存的日志数量，不建议超过1048576，默认为65536。
setConnectTimeoutSec	Int	网络连接超时时间。默认值为10，单位为秒。
setSendTimeoutSec	Int	日志发送超时时间。默认值为15，单位为秒。
setDestroyFlusherWaitSec	Int	flusher线程销毁最大等待时间。默认值为1，单位为秒。
setDestroySenderWaitSec	Int	sender线程池销毁最大等待时间。默认值为1，单位为秒。
setCompressType	Int	数据上传时的压缩类型。 0：不压缩。 1（默认值）：LZ4压缩。
setNtpTimeOffset	Int	设备时间与标准时间的差值，值为标准时间-设备时间。一般这种差值是由于用户客户端设备时间不同步场景。默认值为0，单位秒。
setMaxLogDelayTime	Int	日志时间与本机时间的差值。超过该差值后，SDK会根据setDropDelayLog选项进行处理。单位秒，默认值为7243600，即7天。
setDropDelayLog	Int	是否丢弃超过setMaxLogDelayTime的过期日志。 0（默认值）：不丢弃，把日志时间修改为当前时间。 1：丢弃。
setDropUnauthorizedLog	Int	是否丢弃鉴权失败的日志。 0（默认值）：不丢弃。 1：丢弃。
setCallbackFromSenderThread	Boolean	是否从sender线程回调callback。 true（默认值）：从sender线程回调。 false：从主线程回调。

错误码	数值	说明	解决方案
LOG_PRODUCER_OK	0	成功。	不涉及。
LOG_PRODUCER_INVALID	1	SDK已销毁或无效。	检查是否正确初始化SDK。检查是否调用了destroy()方法。
LOG_PRODUCER_WRITE_ERROR	2	数据写入错误，可能原因是Project写入流量已达上限。	调整Project写入流量上限。具体操作，请参见调整资源配额。
LOG_PRODUCER_DROP_ERROR	3	磁盘或内存缓存已满，日志无法写入。	调整maxBufferLimit、persistentMaxLogCount、persistentMaxFileSize参数值后重试。
LOG_PRODUCER_SEND_NETWORK_ERROR	4	网络错误。	检查Endpoint、Project、Logstore的配置情况。
LOG_PRODUCER_SEND_QUOTA_ERROR	5	Project写入流量已达上限。	调整Project写入流量上限。具体操作，请参见调整资源配额。
LOG_PRODUCER_SEND_UNAUTHORIZED	6	AccessKey过期、无效或AccessKey权限策略配置不正确。	检查AccessKey。 RAM用户需具备操作日志服务资源的权限。具体操作，请参见为RAM用户授权。
LOG_PRODUCER_SEND_SERVER_ERROR	7	服务错误。	提请工单联系技术支持。
LOG_PRODUCER_SEND_DISCARD_ERROR	8	数据被丢弃，一般是设备时间与服务器时间不同步导致。	SDK会自动重新发送。
LOG_PRODUCER_SEND_TIME_ERROR	9	与服务器时间不同步。	SDK会自动修复该问题。
LOG_PRODUCER_SEND_EXIT_BUFFERED	10	SDK销毁时缓存数据还没有上报。	建议开启断点续传功能可避免数据丢失。
LOG_PRODUCER_PARAMETERS_INVALID	11	SDK初始化参数错误。	检查AccessKey、Endpoint、Project、Logstore等参数配置。
LOG_PRODUCER_PERSISTENT_ERROR	99	缓存数据写入磁盘失败。	1、检查缓存文件路径配置不正确。 2、检查缓存文件是否写满 3、检查系统磁盘空间是否充足。

public class AliyunLogHelper {
    private LogProducerConfig config;
    private LogProducerClient client;
    private static class Holder {
        private static final AliyunLogHelper INSTANCE = new AliyunLogHelper();
    public static AliyunLogHelper getInstance() {
        return Holder.INSTANCE;
    private AliyunLogHelper() {
        initProducer();
    private void initProducer() {
        // 以下代码替换为您的初始化代码。
        try {
            config = new LogProducerConfig();
            client = new LogProducerClient(config);
        } catch (LogProducerException e) {
            e.printStackTrace();
    public void addLog(Log log) {
        if (null == client) {
            return;
        client.addLog(log);
}

// 初始化SDK。
private void initProducer() {
    // 调整HTTP链接和发送超时时间，有利于减少日志重复率。
    // 您可以根据实际情况调整具体的超时时间。
    config.setConnectTimeoutSec(20);
    config.setSendTimeoutSec(20);
    // 其他初始化参数。
    // ...
}

错误码	说明
LOG_PRODUCER_SEND_NETWORK_ERROR	检查Endpoint、Project、Logstore的配置是否正确。
LOG_PRODUCER_SEND_UNAUTHORIZED	检查AccessKey是否过期、有效或AccessKey权限策略配置是否正确。
LOG_PRODUCER_SEND_QUOTA_ERROR	调整Project写入流量已达上限。具体操作，请参见调整资源配额。

Android SDK快速入门

前提条件

快速使用

高级用法

动态配置参数

断点续传

混淆规则

Android权限

配置参数说明

错误码

常见问题

为什么会存在重复日志？

日志缺失，如何处理？

日志上报延时，如何处理？