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 政策
隐私协议
数据处理和安全协议
联系我们
词汇表

NodeJS SDK 上传日志

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

前提条件

创建并获取云 API 密钥信息 accessKeyId 和 accessKey,密钥信息获取请前往 API 密钥管理
并请确保密钥关联的账号具有相应的 SDK 上传日志权限

准备开发环境

开始接入前,请先下载并安装 Node.js。下载地址及相关操作请参见 Node.js 官网。
以下以 CentOS 7系统为例,可使用如下命令安装开发环境。
# 安装EPEL仓库
sudo yum install epel-release -y
# 安装Node.js和npm
sudo yum install nodejs npm -y

安装 NodeJS SDK

1. 创建并进入项目目录。
2. 通过 npm 安装 SDK。
npm install
npm install tencentcloud-cls-sdk-js

请求参数

变量
类型
是否必填
说明
endpoint
String
域名信息,填写请参见 可用地域 中 API 上传日志 Tab 中的域名。
secretId
String
云 API 密钥信息,密钥信息获取请前往 API 密钥管理。并请确保密钥关联的账号具有相应的 SDK 上传日志权限
secretKey
String
云 API 密钥信息,密钥信息获取请前往 API 密钥管理。并请确保密钥关联的账号具有相应的 SDK 上传日志权限
sourceIp
String
来源 IP 地址。
retry_times
integer
重试次数。
topicID
String
日志主题的 ID 信息。

日志上传代码示例

以下代码以 NodeJS SDK 为例,展示通过调用 SDK 完成日志上传的操作。
不建议将云 API 密钥信息明文存储至工程代码中,可通过环境变量动态获取云 API 密钥信息,具体操作,请参见 配置环境变量
const { AsyncClient, LogItem, LogGroup, Content, PutLogsRequest } = require('tencentcloud-cls-sdk-js');

// CLS日志服务日志主题ID; 必填参数
let topicID = "591XXXXXXXXXXXXXXXXXXXXXXXXXXXX"; // 替换为你的日志主题ID

let client = new AsyncClient({
// 填入域名信息,请参见链接中 API 上传日志 Tab 中的域名:https://www.tencentcloud.com/document/product/614/18940?from_cn_redirect=1#.E5.9F.9F.E5.90.8D
endpoint: "ap-xxxxxx.cls.tencentcs.com",
// 填入云API密钥信息。密钥信息获取请前往:https://console.tencentcloud.com/cam/capi
// 并请确保密钥关联的账号具有相应的日志上传权限,权限配置指引:https://www.tencentcloud.com/document/product/614/68374?from_cn_redirect=1#.E4.BD.BF.E7.94.A8-api-.E4.B8.8A.E4.BC.A0.E6.95.B0.E6.8D.AE
// 本示例从环境变量中获取,环境变量配置指引:https://www.tencentcloud.com/document/product/614/113851?from_cn_redirect=1
secretId: process.env.TENCENTCLOUD_SECRET_ID,
secretKey: process.env.TENCENTCLOUD_SECRET_KEY,
// 源IP地址: 选填参数, 为空则自动填充本机IP
sourceIp: "127.XX.XX.1",
// 重试次数: 必填参数
retry_times: 10,
});

async function sendLog() {
let item = new LogItem();
item.pushBack(new Content("__CONTENT__", "这是发送的日志内容")); // 修改为你想发送的日志内容
item.setTime(Math.floor(Date.now() / 1000));

let loggroup = new LogGroup();
loggroup.addLogs(item);
let request = new PutLogsRequest(topicID, loggroup);

try {
let data = await client.PutLogs(request);
console.log("发送日志成功:", data);
} catch (error) {
console.error("发送日志失败:", error);
}
}

// 调用发送日志的函数
sendLog();

结语

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


帮助和支持

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

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

文档反馈