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 ServiceUser GuideData consumption and shippingConsume logs using ConsumeLogs
Copy page
Download PDFData consumption and shipping
Consume logs using ConsumeLogs
Copy pageDownload PDFConsume logs using ConsumeLogs
TLS provides the ConsumeLogs API for consuming logs, enabling real-time access to log data collected on the server. This topic describes how to call the ConsumeLogs API using the TLS SDK to achieve sequential reading and writing of complete log data.
Background information
TLS can act as a log data transfer hub, providing log forwarding features similar to Kafka. By using the log consumption APIs and multi-language SDKs provided by TLS, you can use applications in Go and other languages as consumers to access log data in real time. For server-side APIs related to log consumption, see ConsumeLogs. For information about multi-language SDKs provided by TLS, see Overview.
Notice
TLS offers the ConsumerGroup feature through the SDK. You can consume log data using consumer groups. When consuming logs with a consumer group, TLS automatically balances consumer capacity and progress, and allocates Shards. For details, see Consumption data by consumption group.
Code examples
Refer to the following code example to create a ConsumeLogs.go file, call the ConsumeLogs API to read log data, and consume log data in real time.
import (
"fmt"
"time"
. "github.com/volcengine/volc-sdk-golang/service/tls"
"github.com/volcengine/volc-sdk-golang/service/tls/pb"
)
func consumeLogs(topicID string, shardID int) {
client := NewClient(os.Getenv("LOG_TEST_ENDPOINT"), os.Getenv("LOG_TEST_ACCESS_KEY_ID"),
// LOG_TEST_SECURITY_TOKEN is a temporary security token obtained through IAM STS. When using a temporary token, you also need to pass temporary AK and SK. For more information, see https://www.volcengine.com/docs/6470/160162. When not using a temporary token, set LOG_TEST_SECURITY_TOKEN to empty.
os.Getenv("LOG_TEST_ACCESS_KEY_SECRET"), os.Getenv("LOG_TEST_SECURITY_TOKEN"),
os.Getenv("LOG_TEST_REGION"))
// Get the initial log cursor
beginCursorResp, err := client.DescribeCursor(&DescribeCursorRequest{
TopicID: topicID,
ShardID: shardID,
From: "begin",
})
if err != nil {
panic(err.Error())
}
// Get the last log cursor
endCursorResp, err := client.DescribeCursor(&DescribeCursorRequest{
TopicID: topicID,
ShardID: shardID,
From: "end",
})
if err != nil {
panic(err.Error())
}
// Get the log cursor for a specific time
timestampCursorResp, err := client.DescribeCursor(&DescribeCursorRequest{
TopicID: topicID,
ShardID: shardID,
From: "1661418000",
})
if err != nil {
panic(err.Error())
}
var logGroupCount = 10
// Consume ten groups of logs
consumedLogs, err := client.ConsumeLogs(&ConsumeLogsRequest{
TopicID: topicID,
ShardID: shardID,
Cursor: timestampCursorResp.Cursor,
LogGroupCount: &logGroupCount,
})
if err != nil {
panic(err.Error())
}
fmt.Println(consumedLogs)
// Consume ten groups of logs and set the compression format to lz4 (currently only lz4 is supported)
var compressionType = "lz4"
consumedLogs, err = client.ConsumeLogs(&ConsumeLogsRequest{
TopicID: topicID,
ShardID: shardID,
Cursor: timestampCursorResp.Cursor,
LogGroupCount: &logGroupCount,
Compression: &compressionType,
})
if err != nil {
panic(err.Error())
}
// Specify the start and end consumption logs
consumedLogs, err = client.ConsumeLogs(&ConsumeLogsRequest{
TopicID: topicID,
ShardID: shardID,
Cursor: beginCursorResp.Cursor,
EndCursor: &endCursorResp.Cursor,
LogGroupCount: &logGroupCount,
Compression: &compressionType,
})
if err != nil {
panic(err.Error())
}
}
Last updated: 2026.03.23 11:52:09
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
