tencent cloud

日志服务

动态与公告
产品动态
公告
新手指引
产品简介
产品概述
产品优势
地域和访问域名
规格与限制
基本概念
购买指南
计费概述
产品定价
按量计费(后付费)
欠费说明
清理日志服务资源
成本优化
常见问题
快速入门
一分钟入门指南
入门指南
使用 Demo 日志快速体验 CLS
操作指南
资源管理
权限管理
日志采集
指标采集
日志存储
指标存储
检索分析(日志主题)
检索分析(指标主题)
仪表盘
数据处理
投递与消费
监控告警
云产品中心
DataSight 独立控制台
历史文档
实践教程
日志采集
检索分析
仪表盘
监控告警
投递和消费
成本优化
开发者指南
通过 iframe 内嵌 CLS(旧方案)
通过 Grafana 使用 CLS
API 文档
History
Introduction
API Category
Making API Requests
Topic Management APIs
Log Set Management APIs
Index APIs
Topic Partition APIs
Machine Group APIs
Collection Configuration APIs
Log APIs
Metric APIs
Alarm Policy APIs
Data Processing APIs
Kafka Protocol Consumption APIs
CKafka Shipping Task APIs
Kafka Data Subscription APIs
COS Shipping Task APIs
SCF Delivery Task APIs
Scheduled SQL Analysis APIs
COS Data Import Task APIs
Data Types
Error Codes
常见问题
健康监测问题解释
采集相关
检索分析相关
其他问题
服务等级协议
CLS 政策
隐私协议
数据处理和安全协议
联系我们
词汇表

HarmonyOS SDK 上传日志

PDF
聚焦模式
字号
最后更新时间: 2025-11-07 17:40:38
本文介绍如何快速使用日志服务的 HarmonyOS SDK 实现日志上传的操作。更多 SDK 使用的详细内容,可见代码仓库:tencntcloud-cls-sdk-ohos

前提条件

已安装 HarmonyOS 应用开发环境。更多信息,请参见 HarmonyOS 开发者指南
创建并获取云 API 密钥信息 access_secret 和 access_key,密钥信息获取请前往 API 密钥管理。并请确保密钥关联的账号具有相应的 SDK 上传日志权限

安装 HarmonyOS SDK

1. 创建 HarmonyOS 应用项目。
2. 导入日志服务 HarmonyOS 模块,在项目下执行如下命令。
ohpm install @farmerx/tencntcloud-cls-sdk-ohos
3. 执行完成后,可以在指定的 ets 文件中导入日志服务模块,进行引用并编写代码。
import { TencntcloudLog, LogCallback } from "@farmerx/tencntcloud-cls-sdk-ohos"

请求参数

变量
类型
是否必填
说明
endpoint
String
地域信息,填写请参见 可用地域 中 API 上传日志 Tab 中的域名。
access_secret
String
云 API 密钥信息,密钥信息获取请前往 API 密钥管理。并请确保密钥关联的账号具有相应的 SDK 上传日志权限
access_key
String
云 API 密钥信息,密钥信息获取请前往 API 密钥管理。并请确保密钥关联的账号具有相应的 SDK 上传日志权限
access_token
String
临时密钥的 token,如使用临时密钥可填入。
topic_id
String
日志主题的 ID 信息。

日志上传示例代码

在您的 HarmonyOS 项目中,可以使用如下的示例代码实现日志上传的能力,示例代码如下所示。
在代码中直接明文使用云 API 密钥(access_key、access_secret)风险较高,为确保安全性,建议使用 临时密钥 进行鉴权。
import {LogProducer} from "@farmerx/tencntcloud-cls-sdk-ohos";

// 初始化
let producer = new LogProducer(
"#[topic_id]",
"#[access_key]",
"#[access_secret]",
"#[access_token]",
"",
"#[endpoint]", 100, 100, 2000)

// 设置callback 回掉函数
producer.setCallback((err: Error | null, topicID: string, code: number, request_id: string, errorMessage: string) => {
if (err==null) {
hilog.info(0x0000,
'testTagCLS',
'onLogCallback.topic: %{public}s , code: %{public}d, request_id: %{public}s, errorMessage: %{public}s',
topicID, code, request_id, errorMessage
);
} else {
hilog.info(0x0000,
'testTagCLS',
'onLogCallback.topic: %{public}s, code: %{public}d, request_id: %{public}s, errorMessage: %{public}s',
topicID, code, request_id, err.message
);
}
})

// 设置来源 IP
producer.setSourceIp("127.0.0.3")


// reset access key
producer.setAccessKey("#[access_key]", "#[access_secret]", "#[access_token]");

// 同步发送
function syncsencLog() {
let logs: Record<string, string>[] = [];
let log: Record<string, string> = {};
// 添加键值对
log["key1"] = "value1";
log["key2"] = "value2";
log["key3"] = "value3";
logs.push(log)
try {
let rsp = producer.syncSendLogs( "127.0.0.1", logs)
hilog.info(0x0000, 'testTag', "========%{public}s, %{public}s", rsp.requestId, rsp.rspText)
} catch (e) {
// ....
}
}
// 异步发送
function asyncSendLog() {
let log: Record<string, string> = {};
// 添加键值对
log["key1"] = "value1";
log["key2"] = "value2";
log["key3"] = "value3";
try {
producer.addLog(log)
} catch (e) {
// ....
}
}

asyncSendLog()
sencLog()


结语

通过以上步骤,您可以快速使用腾讯云 CLS 的 HarmonyOS SDK 完成日志的上传操作。如遇到任何问题,请 联系我们 获取帮助。

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈