Torch Log Service
Torch Log Service
Torch Log Service
Document
Product News
Product Overview
Product Billing
User Guide
TLS Agent
AgentLoop
Resource management
Host group
Data collection
LogCollector collection
Introduction to LogCollector
Installation and upgrade
Collect host logs
Collect container logs
LogCollector plugins
Manage LogCollector
general reference
Data import
Cloud product log collection
TOS log collection
DBW log collection
VPN Log collection
VKE log collection
CLB log collection
CloudTrail log collection
CFW log collection
NTA log collection
ALB log collection
APMPlus log collection
veFaaS log collection
VPC log collection
veImageX log collection
TrafficRoute DNS log collection
DDoS log collection
WAF log collection
DCDN log collection
Multi-cloud security platform log collection
APIG log collection
Machine learning task log collection
CR log collection
Volcano Ark application lab log collection
FileNAS log collection
LLM Application Firewall Service log collection
vePFS log collection
Cloud security center log collection
EFS log collection
Data storage
Query and analysis
Configure log indexes
Query log
Analyze logs
Query and analyze logs using third-party tools
Associate external data source for log query
SQL function
SQL syntax
Visualization
Query and analysis charts
Summaries of query and analysis charts
Create dashboard
Use dashboard
Add dashboard filters and variables
Use other systems to analyze logs
Log application
Log applications for product observability
Log applications for large models observability
Coding Agent log app
ModelProvider log app
No-coding Agent log app
Log applications for basic service monitoring
Data processing
Data transformation
Syntax and functions
Global operation function
expression function
Data processing best practices
general reference
Data write processor
Data consumer processor
Data consumption and shipping
Ship logs to TOS
Ship logs to Kafka
Ship logs to Splunk
Alarm
Alarm policy
Alarm notification content
Alarm notification content template
alarm notification channel
Tracing service
Monitor Log Service
API reference
Project management API
Topic management API
Shard management API
Index management API
Log management API
Host group management API
Collection configuration management API
Data import API
Data processor API
Data transformation API
Data backflow API
SQL analysis API
Alarm management API
Consumer group management API
Kafka protocol consumption API
Tag management API
Trace storage API
Account management API
SDK reference
Go SDK
Java SDK
Python SDK
iOS SDK
C++ SDK
CLI reference
Best practices
Data collection
Query and analysis
permission management
Consumption and delivery
Visualization
Alarm
FAQs
Billing and cost FAQ
Data collection FAQ
Data storage FAQ
Index configuration FAQ
Query and analysis FAQ
Scheduled SQL tasks FAQ
Alarm FAQ
- Documentation
Torch Log ServiceSDK referenceNode.js SDKGetting started
Copy page
Download PDFNode.js SDK
Getting started
Copy pageDownload PDFGetting started
This topic describes how to use Torch Log Service (TLS) SDK for Node.js to quickly collect logs, including creating projects, creating topics, writing logs, and querying logs.
Before you begin
- Install TLS SDK for Node.js. For more information, refer to Install TLS SDK for Node.js.
- We recommend that you use the latest version of TLS SDK for Node.js. You can view the SDK version in the @volcengine/openapi field of the package.json file.
Sample code
This section uses the log collection and query processes of TLS as an example. Create a TLSQuickStart.js file, and call API actions to create a project, topic, and index, and write and query log data.
Sample code:
const { tlsOpenapi } = require('@volcengine/openapi');
async function main() {
const tlsOpenapiService = tlsOpenapi.defaultService;
tlsOpenapiService.setHost('your host');
tlsOpenapiService.setSecretKey('your secret key');
tlsOpenapiService.setAccessKeyId('your access key id');
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',
});
// Use the objToProtoBuffer method to convert structured log data to Protobuf log data.
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',
}
]
});
// The PutLogs API action accepts TopicId, CompressType, and LogGroupList as input parameters to upload log data to TLS. Note that LogGroupList specifies logs in Protobuf format.
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',
});
}
Last updated: 2025.10.11 16:44:07
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
