日志服务
日志服务
日志服务
文档指南
请输入
用户指南
TLS Agent
资源管理
数据采集
LogCollector 采集
LogCollector 简介
安装与升级（Linux）
安装与升级（Windows）
采集容器日志
LogCollector 插件
管理 LogCollector
云产品日志采集
TOS 日志采集
CDN 日志采集
DBW 日志采集
VPN 日志采集
VKE 日志采集
CLB 日志采集
CloudTrail 日志采集
CFW 日志采集
NTA 日志采集
ALB 日志采集
APMPlus 日志采集
veFaaS 日志采集
VPC 日志采集
veImageX 日志采集
TrafficRoute DNS 日志采集
DDos 日志采集
WAF 日志采集
DCDN 日志采集
多云安全平台日志采集
APIG 日志采集
机器学习任务日志采集
采集火山方舟应用实验室日志
CR 日志采集
FileNAS 日志采集
大模型应用防火墙日志采集
vePFS 日志采集
云安全中心日志采集
EFS 日志采集
检索分析
使用第三方工具检索分析日志
关联外部数据源检索分析日志
SQL 函数
可视化
日志应用
云产品观测日志应用
大模型观测日志应用
Coding Agent 日志应用
ModelProvider 日志应用
No-coding Agent 日志应用
Framework 日志应用
基础服务监控日志应用
数据处理
数据加工
消费与投递
告警
Trace 存储
API 参考
日志管理
机器组管理
采集配置管理
数据处理器
定时 SQL 分析
告警管理
消费组管理
Trace 存储
SDK 参考
Go SDK
Java SDK
Android SDK
Node.js SDK
CLI 参考
最佳实践
消费与投递
可视化
常见问题
数据采集常见问题
索引配置常见问题
- 文档首页
日志服务SDK 参考Node.js SDK快速开始 Node.js SDK
复制全文
下载 pdf快速开始 Node.js SDK
文档反馈
问问助手本文介绍如何快速使用日志服务 Node.js SDK 实现基础的日志采集流程，包括创建日志项目、创建日志主题、写入日志和查询日志等操作。
前提条件
- 已安装日志服务 Node.js SDK。详细步骤请参考安装 Node.js SDK。
- 推荐使用最新版本的 Node.js SDK，您可以在 package.json 文件的 @volcengine/openapi 字段中查看 SDK 版本号。
- 已添加 VOLCENGINE_ACCESS_KEY_ID 等环境变量。环境变量的配置方式请参考配置身份认证信息。
初始化客户端
初始化 Client 实例之后，才可以向 TLS 服务发送请求。初始化时推荐通过环境变量动态获取火山引擎密钥等身份认证信息，以免 AccessKey 硬编码引发数据安全风险。
配置环境变量的命令如下：
VOLCENGINE_ACCESS_KEY_ID="your accessKeyId" VOLCENGINE_ACCESS_KEY_SECRET="your secretKey" VOLCENGINE_ENDPOINT="your host" VOLCENGINE_REGION="your region"
示例代码
本文档以日志服务的基本日志采集和检索流程为例。创建一个 TLSSQuickStart.js 文件，并调用接口分别完成创建 Project、创建 Topic、创建索引、写入日志数据和查询日志数据。
详细示例代码如下：
const { tlsOpenapi } = require('@volcengine/openapi');
async function main() {
const tlsOpenapiService = tlsOpenapi.defaultService;
const project = await tlsOpenapiService.CreateProject({
ProjectName: 'your project name',
Region: 'project belong to which region',
});
const topic = await tlsOpenapiService.CreateTopic({
ProjectId: 'your project id',
ShardCount: 'your shard count',
TopicName: 'your topic name',
Ttl: 'your ttl time',
});
const index = await tlsOpenapiService.CreateIndex({
TopicId: 'your topic id',
FullText: 'your full-text config',
KeyValue: 'your kv config',
});
// 将结构化的日志数据通过 objToProtoBuffer 方法转为 Protocol Buffer 格式。
const logBuffer = await tlsOpenapi.TlsService.objToProtoBuffer({
LogGroups: [
{
Logs: [
{
Time: 'log time',
Contents: [{ Key: 'content key', Value: 'key value' }]
}
],
Source: 'log source',
LogTags: [{ Key: 'tag key', Value: 'key value' }],
FileName: 'file name',
ContextFlow: 'context flow',
}
]
});
// PutLogs API 接收 TopicId、压缩类型 （CompressType） 和 Protocol Buffer 格式日志 （LogGroupList） 作为入参，将日志数据上传到 TLS。
const putLogsResult = await tlsOpenapiService.PutLogs({
TopicId: 'your topic id',
CompressType: 'log compress type',
LogGroupList: logBuffer,
});
const searchLogsResult = await tlsOpenapiService.SearchLogs({
StartTime: 'log start time',
EndTime: 'log end time',
Limit: 'page size',
Query: 'query phrases',
TopicId: 'your topic id',
});
}
最近更新时间：2026.09.21 17:50:14
这个页面对您有帮助吗？
有用
有用
无用
无用