网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

云日志服务Android SDK

更新时间:2025-01-23 GMT+08:00
分享

云日志服务Android SDK提供了Kotlin & Java语言上报日志的一系列方法,如果您需要收集和分析用户在网站上的信息,例如用户的浏览器、浏览行为记录、购买行为记录、终端设备记录,设备异常记录,网络使用记录等,可以直接使用Android SDK上报日志到LTS。

当前仅华北-北京四、华东-上海一、华南-广州区域的白名单用户支持使用该功能,如有需要请提工单申请。

传输协议

HTTPS

使用前提

  • 确认云日志服务的区域,请您根据所在区域,选择RegionName。
  • 获取华为云账号的项目ID(project id),步骤参考:请参见“我的凭证 > API凭证”。
  • 获取需要上报到LTS的日志组ID日志流ID
  • 日志流需要开启匿名写入功能。详细操作请参考管理日志流

版本更新说明

SDK如何处理个人信息请参考华为云日志服务移动端日志采集SDK隐私声明

您集成和使用我们的SDK时需要遵从个人信息保护基本要求,详情请参考华为云日志服务移动端日志采集SDK开发者合规指南

表1 版本更新说明

版本号

下载地址

检验信息下载地址

更新说明

系统

1.0.28

单击下载

单击下载

修复了1.0.26版本以来工程配置导致的配置冲突。

Android 7 及以上

0.0.5

请通过mavenCentral下载。

-

功能与1.0.28版本相同,可支持kotlin 1.3.x。

Android 7 及以上。

1.0.27

单击下载

单击下载

优化了缓存效率。

Android 7 及以上

0.0.4

请通过mavenCentral下载。

-

功能与1.0.27版本相同,可支持kotlin 1.3.x。

Android 7 及以上。

1.0.26

单击下载

单击下载

修复了因异步修改入参导致数据异常的问题。

Android 7 及以上。

1.0.25

单击下载

单击下载

增强代码强壮性,添加参数保护。

Android 7 及以上。

1.0.24

单击下载

单击下载

  • 支持更多region:华东-上海一、华南-广州。
  • 修改了程序目录,修改为com.cloud.lts.*。

Android 7 及以上。

1.0.21

单击下载

单击下载

废弃setconfig方法,使用LTSSDK的构造方法代替。

Android 7 及以上。

1.0.19

单击下载

单击下载

  • 修改了上报时间间隔阈值。
  • 修复了修改配置信息后导致无法获取缓存的问题。

Android 7 及以上。

1.0.18

单击下载

单击下载

  • 增强代码强壮性,修复多实例时可能会产生的崩溃。
  • 修复最低 Android API 支持版本定义错误的问题。
  • 增加设置调试日志级别接口:setLogLevel。
  • 修改了 日志发送的入参 label 的类型,支持多层嵌套。
  • 日志发送入参 content 支持数组类型,方便使用。
  • 添加缓存存储条目最大值支持,如果超过会丢弃后再存储。
  • 修改了请求失败时的控制策略,支持递进式等待。
  • 对本地错误日志输出做了整理。

Android 7 及以上。

1.0.17

单击下载

单击下载

首次发布,提供四个接口:初始化、配置config、上报日志report、立即上报日志reportImmediately。

Android 7 及以上。

安装Android SDK

  1. 集成接入SDK。

    1. maven仓库集成。
      1. 在build.gradle中添加依赖。
        plugins {
            ...
            id 'org.jetbrains.kotlin.android' version 'KOTLIN_VERSION' apply false  // 添加kotlin插件,1.x.x最低支持1.6.20版本,最低可支持1.3.61版本
            ...
        }
      2. 在app/build.gradle中添加依赖。
        dependencies {
            ...
            implementation 'io.github.lts-sdk:lts-sdk-android:1.0.28'
            ...
        }
      3. 在 settings.gradle中添加maven仓库源。
        pluginManagement{
            ...
            repositories {
                ...
                // 加入下面内容
                mavenCentral()
           }
        }
        dependencyResolutionManagement {
            ...
            repositories {
                ...
                // 加入下面内容
                mavenCentral()
           }
        }
    2. 手动集成。
      1. 下载日志SDK包。
      2. 下载后解压到指定目录。注:直接解压即可,不需要额外操作。
      3. 将解压后的aar静态库文件添加到您的项目工程中。
      4. 在build.gradle中添加依赖。
        plugins {
            ...
            id 'org.jetbrains.kotlin.android' version 'KOTLIN_VERSION' apply false  // 添加kotlin插件,1.x.x最低支持1.6.20版本,0.0.x最低可支持1.3.61版本
            ...
        }
      5. 在app/build.gradle中添加依赖。
        dependencies {
            ...
            implementation fileTree(dir: $dir, include: ['*.aar']) // 填写aar所在的文件夹,例如'libs'
            implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.4.0' // 0.0.x版本依赖版本为1.3.3
            implementation 'androidx.core:core-ktx:1.7.0'// 0.0.x版本依赖版本为1.2.0
            implementation 'com.google.code.gson:gson:2.8.9'
            kapt 'androidx.room:room-compiler:2.3.0'    // 0.0.x版本依赖版本为2.2.6
            api 'androidx.room:room-runtime:2.3.0'      // 0.0.x版本依赖版本为2.2.6
            api 'androidx.room:room-common:2.3.0'       // 0.0.x版本依赖版本为2.2.6
            ...
        }
      6. 在 settings.gradle中添加maven仓库源。

        如果您的Gradle版本低于7.0 则需要将mavan仓库源添加到build.gradle文件中。

        pluginManagement{
            ...
            repositories {
                ...
                // 加入下面内容
                google()
                mavenCentral()
           }
        }
        dependencyResolutionManagement {
            ...
            repositories {
                ...
                // 加入下面内容
                google()
                mavenCentral()
           }
        }

  2. 初始化,详细参数请参考表4

    1. 添加依赖
      import com.cloud.lts.UserConfig
      import com.cloud.lts.LTSSDK
    2. Kotlin:初始化代码示例。
      // 注意:认证用的华为云账号AK、SK硬编码到代码中或者明文存储都有很大的安全风险,建议密文存放,使用时解密,确保安全。
      val ak: String = getData("HUAWEICLOUD_SDK_AK")
      val sk: String = getData("HUAWEICLOUD_SDK_SK")
      // LTS参数配置
      val userConfig = UserConfig.Builder()
      // 必填参数
      .setRegion(USER_REGION)  // 云日志服务的区域
      .setProjectId(PROJECT_ID)  // 华为云账号的项目ID
      .setGroupId(LOG_GROUP_ID)  // LTS的日志组ID
      .setStreamId(LOG_STREAM_ID)  // LTS的日志流ID
      .setAccessKey(ak)  // 华为云访问密钥
      .setSecretKey(sk)  // 华为云秘密访问密钥
      // 选填参数
      .setUrlHost(url)  // LTS的公网地址域名
      .setCacheThreshold(200)
      .setTimeInterval(60)
      .setIsReportBackground(true)
      .setIsReportLaunch(false)
      .build()
       // LTS初始化方法
      ltssdk = LTSSDK( </* Application Instance */> , userConfig)
    3. Java:初始化代码示例。LTSSDK支持多实例日志上报机制,根据不同配置创建实例进行上报。
      // 注意:认证用的华为云账号AK、SK硬编码到代码中或者明文存储都有很大的安全风险,建议密文存放,使用时解密,确保安全。
      String ak = getData("HUAWEICLOUD_SDK_AK")
      String sk = getData("HUAWEICLOUD_SDK_SK")
      // LTS参数配置
      UserConfig userConfig = new UserConfig.Builder()
       // 必填参数
      .setRegion(USER_REGION)  // 云日志服务的区域
      .setProjectId(PROJECT_ID)  // 华为云账号的项目ID
      .setGroupId(LOG_GROUP_ID)  // LTS的日志组ID
      .setStreamId(LOG_STREAM_ID)  // LTS的日志流ID
      .setAccessKey(ak)  // 华为云访问密钥
      .setSecretKey(sk)  // 华为云秘密访问密钥
      // 选填参数
      .setUrlHost(url)  // LTS的公网地址域名
      .setCacheThreshold(200)
      .setTimeInterval(60)
      .setIsReportBackground(true)
      .setIsReportLaunch(false)
      .build();
      // LTS初始化方法
      ltssdk = new LTSSDK( </* Application Instance */> , userConfig);

  3. 上报日志。LTS提供两种上报日志的方法。

    表2 两种上报日志的方法

    Method

    Description

    report(content, labels)

    上报日志:先存入本地数据库,根据配置中设定的策略实施上报。

    reportImmediately(content, labels)

    立即上报日志。

    表3 Parameters参数

    Name

    Description

    content

    日志内容,支持字典和字典数组;键值对最多300个;content转JSON字符串最大支持长度为30*1024,超出部分被截断。

    labels

    日志标签。

    • 支持字典或空值。
    • 最外层键值对最多50个。
    • 最外层key最大长度为64。
    • 支持字母、数字和下划线组合,首字符须是字母。
    • 字典转JSON字符串最大支持长度为30720,超出则该条日志无法上报。
    • Kotlin代码示例如下:
      var ltssdk: LTSSDK
      val food = hashMapOf(Pair("food_1", "rice"), Pair("food_2", "wheat"), Pair("food_3", "egg"))
      val fruit = hashMapOf(Pair("fruit_1", "apple"), Pair("fruit_2", "pear"), Pair("fruit_3", "banana"))
      val label = hashMapOf( Pair("date","2023-10-01"))
      val contents = listOf(food, fruit).toTypedArray()
      ltssdk.report(food, label)    // 缓存上报单条 带标签
      ltssdk.report<String, String>(food)    // 缓存上报单条 不带标签
      ltssdk.reportImmediately(food, label)    // 立即上报单条 带标签
      ltssdk.reportImmediately<String, String>(food)    // 立即上报单条 不带标签
      ltssdk.report(contents, label)    // 缓存上报多条 带标签
      ltssdk.report<String, String>(contents)    // 缓存上报多条 不带标签
      ltssdk.reportImmediately(contents , label)    // 立即上报多条 带标签
      ltssdk.reportImmediately<String, String>(contents)    // 立即上报多条 不带标签
    • Java代码示例如下:
      LTSSDK ltssdk;
      HashMap fruit = new HashMap<String, String>(){{
          put("fruit_1", "apple");
          put("fruit_2", "pear");
          put("fruit_3", "banana");
      }};
      HashMap food = new HashMap<String, String>(){{
          put("food_1", "rice");
          put("food_2", "wheat");
          put("food_3", "egg");
      }};
      HashMap<String, String> labels = new HashMap(){{
          put("date","2023-10-01");
      }};
      HashMap[] contents = {food, fruit};
      ltssdk.report(food);  // 缓存上报单条 不带标签
      ltssdk.report(food, labels);  // 缓存上报单条 带标签
      ltssdk.reportImmediately(food);  // 立即上报单条 不带标签
      ltssdk.reportImmediately(food, labels);  // 立即上报单条 带标签
      ltssdk.report(contents); // 缓存上报多条 不带标签
      ltssdk.report(contents, labels); // 缓存上报多条 带标签
      ltssdk.reportImmediately(contents);  // 立即上报多条 不带标签
      ltssdk.reportImmediately(contents, labels);  // 立即上报多条 带标签

配置参数说明

表4 初始化参数说明

参数名称

类型

是否必填

默认值

描述

projectId

String

必填

-

华为云账号的项目ID。

accessKey

String

必填

-

华为云账号的访问密钥,简称AK。

认证用的华为云账号AK、SK硬编码到代码中或者明文存储都有很大的安全风险,建议密文存放,使用时解密,确保安全。

说明:

认证用的华为云账号AK、SK硬编码到代码中或者明文存储都有很大的安全风险,建议密文存放,使用时解密,确保安全。

secretKey

String

必填

-

华为云账号的秘密访问密钥,简称SK。注意:认证用的华为云账号AK、SK硬编码到代码中或者明文存储都有很大的安全风险,建议密文存放,使用时解密,确保安全。

region

String

必填

-

LTS的服务区域。

groupId

String

必填

-

LTS的日志组ID。

streamId

String

必填

-

LTS的日志流ID。

url

String

选填

null

用于上报的公网地址域名,如未设置,将根据region自动生成链接,格式如下:https://lts-access.{region}.myhuaweicloud.com

cacheThreshold

Long

选填

200条

当本地数据库日志存储条数达到该值会触发上报,取值范围为30-1000条。

timeInterval

Long

选填

3秒

定时器每隔该值会触发上报,取值范围为1-1800秒。

isReportBackground

boolean

选填

true

是否开启APP切入后台时上报功能。

isReportLaunch

boolean

选填

false

是否开启APP启动时上报功能。

上报日志策略说明

LTSSDK支持四种日志上报策略:阈值上报、定时上报、应用切后台和启动时上报,根据场景选择合适的值配置cacheThreshold、timeInterval、isReportBackground、isReportLaunch等参数。

权限配置

LTSSDK 需要 Android 的网络权限,如果您没有配置,请将下面内容的写入APP 的 Manifest.xml 文件中:

manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools">
...
// 加入下面的内容
<uses-permission android:name="android.permission.INTERNET" />
...
</manifest>

混淆配置

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

-keep class com.cloud.**{*;} 

接入调试

在开发过程中可以启用调试模式,借助控制台日志实时查看上报日志的记录情况,观察具体结果并根据需要进行调整。

需要通过调用LTSSDK的静态方法来修改,SDK支持Debug、Info、Warning 、 Error 和 Off 5个级别的默认为静默输出(Off)。5个级别分别对应的参数:LogLevel.DEBUG、LogLevel.INFO、LogLevel.WARNING、LogLevel.ERROR、LogLevel.OFF。代码示例如下:

LTSSDK.setLogLevel(LogLevel.DEBUG)

参数获取方式

  • 区域表
    表5 区域表

    区域名称

    RegionName

    华北-北京四

    cn-north-4

    华东-上海一

    cn-east-3

    华南-广州

    cn-south-1

  • 日志组ID登录云日志服务页面,选择“日志管理”,鼠标悬浮在日志组名称上,可查看日志组名称和日志组ID
  • 日志流ID单击“日志组名称”可查看日志流列表,鼠标悬浮在日志流名称上,可查看日志流名称和日志流ID
提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容