网络
虚拟私有云 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
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
文档首页/ 云日志服务 LTS/ 用户指南/ 日志接入/ 使用SDK接入LTS/ 云日志服务Java SDK(标准插件)

云日志服务Java SDK(标准插件)

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

云日志服务SDK提供了Java语言上报未结构化日志的一系列方法,方便用户直接使用编码方式上报未结构化日志到云日志服务后台。

传输协议

HTTPS

使用前提

使用说明

  • 当用户修改权限后,权限信息在一天后生效。
  • SDK支持跨云/本地上报日志,当前仅支持华北-北京四、华东-上海一、华南-广州、西南-贵阳一。使用详情见Appender配置参数说明表中的“enableLocalTest”参数,当该参数为true时,上报日志规格为单个机器200次/秒(即每秒只能发送200次,每次批量发送数量/大小详情见参数“batchSizeThresholdInBytes、batchCountThreshold、lingerMs”)。
  • 通过SDK上报日志到LTS的时间相距当前时间不超过2天,否则上报日志会被LTS删除。

注意事项

由于Java-SDK默认对SK明文存储,不符合某些对于安全有更高要求的用户,LTS提供了一种用户自定义的加解密方式,建议用户优先使用加解密方式。

加密过程如下:

  1. 用户编写一个java类,比如com.demo.DecryptDemo类,在该类中增加一个解密方法,比如decrypt方法,输入和输出均为字符串。
  2. 编写decrypt的方法内容,客户自行实现SK加解密算法,返回解密后的值。
  3. 当用户调用Java-SDK初始化时,会需要传入SK,这时使用DecryptDemo.decrypt方法即可。

安装SDK

您可以通过以下两种方式安装云日志服务Java SDK

方式一:Maven项目中加入依赖项(推荐方式)。

  1. maven构建时,settings.xml文件的mirrors节点需要增加华为外部开源仓。如下:
    <mirror>
        <id>huaweicloud</id>
        <mirrorOf>*</mirrorOf>
        <url>https://repo.huaweicloud.com/repository/maven/</url>
    </mirror>
  2. 您可以在华为外部开源仓中获取日志服务Java SDK依赖的最新版本。
  3. Maven工程中使用日志服务Java SDK,只需在pom.xml中加入相应依赖即可,Maven项目管理工具会自动下载相关JAR包。以1.0.1版本为例,在<dependencies>中加入如下内容:
    <dependency> 
         <groupId>io.github.huaweicloud</groupId> 
         <artifactId>lts-sdk-common</artifactId> 
         <version>1.0.1</version> 
     </dependency> 
     <dependency> 
         <groupId>io.github.huaweicloud</groupId> 
         <artifactId>lts-sdk-java</artifactId> 
         <version>1.0.1</version> 
     </dependency>

方式二:在项目中直接依赖Java SDK的jar包。

  1. 下载lts-sdk-commonlts-sdk-java包。(建议使用最新版本的jar包。)
  2. 请确保您的项目中有以下依赖,因为SDK的jar包中需要该依赖。
    <dependency> 
         <groupId>com.alibaba</groupId> 
         <artifactId>fastjson</artifactId> 
         <version>1.2.83</version> 
     </dependency> 
     <dependency> 
         <groupId>joda-time</groupId> 
         <artifactId>joda-time</artifactId> 
         <version>2.10.14</version> 
     </dependency> 
     <dependency> 
         <groupId>org.apache.commons</groupId> 
         <artifactId>commons-lang3</artifactId> 
         <version>3.11</version> 
     </dependency> 
     <dependency> 
         <groupId>org.apache.httpcomponents</groupId> 
         <artifactId>httpclient</artifactId> 
         <version>4.5.13</version> 
     </dependency> 
     <dependency> 
         <groupId>com.google.guava</groupId> 
         <artifactId>guava</artifactId> 
         <version>30.1.1-jre</version> 
     </dependency> 
     <dependency> 
         <groupId>commons-io</groupId> 
         <artifactId>commons-io</artifactId> 
         <version>2.11.0</version> 
     </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>2.0.7</version>
     </dependency>
     <dependency>
         <groupId>org.slf4j</groupId>
         <artifactId>slf4j-simple</artifactId>
         <version>2.0.7</version>
     </dependency>
  3. 以0.6.75版本的IntelliJ IDEA为例:项目中导入JAR
    • IntelliJ IDEA中选择您的工程,选择File > Project Structure
    • Project Structure对话框,左侧单击Modules
    • Dependencies页签,选择+ > JARs or directories
    • Attach Files or Directories对话框中,选中已下载的JAR文件,单击OK

示例代码

package com.huawei.log;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import com.alibaba.fastjson.JSONObject;

import com.huaweicloud.lts.appender.JavaSDKAppender;
import com.huaweicloud.lts.producer.Producer;
import com.huaweicloud.lts.producer.exception.ProducerException;
import com.huaweicloud.lts.producer.model.log.LogContent;
import com.huaweicloud.lts.producer.model.log.LogItem;


public class LtsLogJavaSdkTest1 implements Runnable {

    @Override
    public void run() {
            /* 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险, 建议在配置文件或者环境变量中密文存放, 使用时解密, 确保安全;
            本示例以ak和sk保存在环境变量中为例, 运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK. */
            String ak = System.getenv("HUAWEICLOUD_SDK_AK");
            String sk = System.getenv("HUAWEICLOUD_SDK_SK");
            // 构建appender
            JavaSDKAppender appender = JavaSDKAppender.custom()
            // 华为云号的项目ID(project id)
            .setProjectId("xxx")
            // 华为云号的AK
            .setAccessKeyId(ak)
            // 华为云号的SK
            .setAccessKeySecret(sk)
            // 云日志服务的区域
            .setRegionName("xxxxxx")
            // 单个Appender能缓存的日志大小上限
            .setTotalSizeInBytes(104857600)
            // producer发送日志时阻塞时间
            .setMaxBlockMs(0L)
            // 执行日志发送任务的线程池大小
            .setIoThreadCount(8)
            // producer发送单批日志量上限
            .setBatchSizeThresholdInBytes(524288)
            // producer发送单批日志条数上限
            .setBatchCountThreshold(4096)
            // producer发送单批日志等待时间
            .setLingerMs(2000)
            // producer发送日志失败后重试次数
            .setRetries(5)
            // 首次重试的退避时间
            .setBaseRetryBackoffMs(500L)
            // 重试的最大退避时间
            .setMaxRetryBackoffMs(500L)
           // 默认false, true: 可以跨云上报日志, false: 仅能在华为云ecs主机上报日志 
           // .setEnableLocalTest(false)
            // 超过1M的日志, 拆分后丢弃大于1M的数据
            // .setGiveUpExtraLongSingleLog(true)
            .builder();
        // 获取发送producer
        Producer producer = appender.getProducer();

        // 创建日志发送的结构体
        while (true) {
            List<LogItem> logItemList = new ArrayList<>();
            try {
                Thread.sleep(500);
                // 构建日志
                LogItem logItem = getLogItem();
                logItemList.add(logItem);
                // 发送日志(日志组ID,日志流ID,日志)
                producer.send("xxxxxx", "xxxxxx", logItemList);
            } catch (InterruptedException | ProducerException e) {
                e.printStackTrace();
            }
        }
    }

    private LogItem getLogItem() {
        LogItem logItem = new LogItem();
        // 华为云号的项目ID(project id)
        logItem.setTenantProjectId("xxxxxx");
        // 客户可以自行定义日志标签, 如果不需要请传入一个空Map
        Map<String, String> labels = new HashMap<>();
        labels.put("javaSdk1", "value1");
        labels.put("javaSdk2", "value2");
        logItem.setLabels(JSONObject.toJSONString(labels));
        List<LogContent> contents = new ArrayList<>();

        for (int k = 0; k < 100; k++) {
            LogContent logContent = new LogContent();
            // 日志产生时间, 建议为当前时间Ns
            long logTimeNs = System.currentTimeMillis() * 1000000L + System.nanoTime() % 1000000L;
            logContent.setLogTimeNs(logTimeNs);
            // 日志内容
            logContent.setLog("test~~javaSdk~~~test1 " + k);
            contents.add(logContent);
        }
        logItem.setContents(contents);
        return logItem;
    }

}

单个producer性能基线

上报日志时,请参考如下参数的测试性能基线,若超出基线值,可能会导致日志上报异常。

  • totalSizeInBytes:524288000
  • ioThreadCount:8
  • maxBlockMs:0
  • batchSizeThresholdInBytes:524288
  • batchCountThreshold:4096
  • lingerMs:2000

按照参数基线值设置后,使用8U16GB的机器规格测试,上报单条日志大小为1KB。

测试结果:SDK上报日志的数据量为10MB/s,速率为1.2w条/s。

当日志上报量超过单个producer时:

  • 建议拆分日志流,使用多个producer上报日志,分摊流量,以保障SDK处于正常上报状态。
  • 如果maxBlockMs为0时,SDK处于非阻塞状态,会触发保护机制自动降级,可能会对部分日志做丢弃处理。
  • 如果maxBlockMs大于0时,SDK处于阻塞状态,阻塞时间为maxBlockMs,可能会造成prodcuer.send()发送日志方法处于阻塞状态。

配置参数说明

  • Appender中配置参数说明。
    表1 Appender配置参数说明表

    参数名称

    描述

    类型

    是否需要填写

    默认值

    projectId

    华为云号的项目ID(project id)。

    String

    必填

    -

    accessKeyId

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

    String

    必填

    -

    accessKeySecret

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

    String

    必填

    -

    regionName

    云日志服务的区域。

    String

    必填

    -

    logGroupId

    LTS的日志组ID。

    String

    必填

    -

    logStreamId

    LTS的日志流ID。

    String

    必填

    -

    totalSizeInBytes

    单个producer实例能缓存的日志大小上限。

    int

    选填

    100M(100 * 1024 * 1024)

    maxBlockMs

    如果 producer 可用空间不足,调用者在 send 方法上的最大阻塞时间,单位为毫秒。默认为 60 秒(60000毫秒),建议为0秒。

    • 当maxBlockMs值>=0时,则阻塞到设置的时间,如果到达阻塞时间,还是不能获取到内存,即报错且丢弃日志。
    • 当maxBlockMs值=-1时,则一直阻塞到发送成功,且不会丢弃日志。

    long

    选填

    60秒(60000毫秒)

    ioThreadCount

    执行日志发送任务的线程池大小。

    int

    选填

    客户机器空闲CPU数量,但一定大于1

    batchSizeThresholdInBytes

    当一个 ProducerBatch 中缓存的日志大小大于等于 batchSizeThresholdInBytes 时,该 batch 将被发送。

    int

    选填

    0.5M(512 * 1024)

    batchCountThreshold

    当一个 ProducerBatch 中缓存的日志条数大于等于 batchCountThreshold 时,该 batch 将被发送。

    int

    选填

    4096

    lingerMs

    一个 ProducerBatch 从创建到可发送的逗留时间。

    int

    选填

    2S

    retries

    如果某个 ProducerBatch 首次发送失败,能够对其重试的次数,建议为 5 次。如果 retries 小于等于 0,该 ProducerBatch 首次发送失败后将直接进入失败队列。

    int

    选填

    10

    baseRetryBackoffMs

    首次重试的退避时间。

    long

    选填

    0.1S

    maxRetryBackoffMs

    重试的最大退避时间。

    long

    选填

    50S

    giveUpExtraLongSingleLog

    超过1M的日志, 拆分后丢弃大于1M的数据。

    boolean

    选填

    false

    enableLocalTest

    是否开启跨云上报日志。

    • 选true时,开启跨云后用户能通过公网(仅支持华北-北京四、华东-上海一、华南-广州、西南-贵阳一)访问(建议调测使用)。
    • 选false时,关闭跨云后用户是通过华为云当前区域主机访问。

    boolean

    选填

    false

  • 日志上报LogItem类参数说明

    单次上报条数小于4096条,且小于5M。

    表2 日志上报LogItem类参数说明表

    参数名称

    描述

    类型

    是否需要填写

    tenantProjectId

    华为云号的项目ID(project id)。

    String

    contents

    批量日志内容

    Array< LogContent>

    labels

    日志标签,JSON格式

    支持的Key值有:projectIdclusterIdclusterNamenameSpaceappGroupappNameserviceIDpodNamepidgroupcontainerNamehostIdhostIPhostNamehostIPv6serverlessFuncserverlessPkgfunctionVersionpailIdpathFilekind

    例如:

    {
        "clusterName" : "k8s",
        "appGroup" : "group1"
    }

    String

  • 日志上报LogConten类参数说明

    通过SDK上报日志到LTS的时间相距当前时间不超过2天,否则上报日志会被LTS删除。

    表3 LogConten类参数说明

    参数名称

    描述

    类型

    是否需要填写

    logTimeNs

    日志时间(单位:纳秒)

    long

    log

    日志内容

    String

参数获取方式

  • 区域表
    表4 区域表

    区域名称

    RegionName

    华北-北京二

    cn-north-2

    华北-北京四

    cn-north-4

    华北-北京一

    cn-north-1

    华东-上海二

    cn-east-2

    华东-上海一

    cn-east-3

    华南-广州

    cn-south-1

    华南-深圳

    cn-south-2

    西南-贵阳一

    cn-southwest-2

    亚太-新加坡

    ap-southeast-3

  • 日志组ID:在云日志服务控制台,选择“日志管理”,鼠标悬浮在日志组名称上,可查看日志组名称和日志组ID。
  • 日志流ID:单击日志组名称对应的,鼠标悬浮在日志流名称上,可查看日志流名称和日志流ID。
提示

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

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容