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 referenceGo SDKUse TLS SDK for Go to query and analyze logs
Copy page
Download PDFGo SDK
Use TLS SDK for Go to query and analyze logs
Copy pageDownload PDFUse TLS SDK for Go to query and analyze logs
Torch Log Service (TLS) allows you to use an SDK to query log data collected to the server. This topic offers sample code that demonstrates how to use TLS SDK for Go to query and analyze logs.
Before you begin
- Install TLS SDK for Go. For more information, refer to Install TLS SDK for Go.
- Run the following command to install the proto dependency:
- go get -u github.com/gogo/protobuf/proto
- Add environment variables such as VOLCENGINE_ACCESS_KEY_ID. For information on how to configure environment variables, refer to Configure identity authentication.
warning
We recommend that you use environment variables to dynamically get identity authentication information such as Volcano Engine AccessKey. Otherwise, hard-coded AccessKey information leads to data security risks.
- Collect log data and configure indexes. To configure indexes in the console, refer to Configure indexes. Alternatively, use CreateIndex API to configure indexes. To get the sample code, refer to Use TLS SDK for Go to create basic resources.
Consuming logs
Scenario description
You can use the SDK to call the SearchLogs API action to query and analyze log data. For information on the limits of the query and analysis feature, refer to [Query and analysis limits](/docs/tls/Limits#Query and analysis limits). For information on the syntax of query and analysis statements, refer to Log query syntax and Analysis overview. The following sample code returns all log data as an example to demonstrate how to use the SDK to query and analyze log data.
Sample code
package tls
import (
"fmt"
"github.com/volcengine/volc-sdk-golang/service/tls"
)
func main() {
// When you initialize the client, we recommend that you use environment variables to dynamically get identity authentication information such as Volcano Engine AccessKey. Otherwise, hard-coded AccessKey information leads to data security risks.
// If you use Security Token Service (STS), use a temporary AccessKey ID and AccessKey secret, and set VOLCENGINE_TOKEN. If you do not use STS, leave VOLCENGINE_TOKEN empty.
client := tls.NewClient(os.Getenv("VOLCENGINE_ENDPOINT"), os.Getenv("VOLCENGINE_ACCESS_KEY_ID"),
os.Getenv("VOLCENGINE_ACCESS_KEY_SECRET"), os.Getenv("VOLCENGINE_TOKEN"), os.Getenv("VOLCENGINE_REGION"))
// Query and analyze log data.
// Specify parameters such as TopicId, Query, StartTime, EndTime, and Limit as needed.
resp, err := client.SearchLogsV2(&tls.SearchLogsRequest{
TopicID: "TopicId",
Query: "*",
StartTime: 1346457600000,
EndTime: 1630454400000,
Limit: 20,
})
if err != nil {
// Handle an error.
fmt.Println(err.Error())
}
// Print some basic information in the return value of the SearchLogs API action.
// Handle other information in the return value as needed.
fmt.Println(resp.Status)
fmt.Println(resp.HitCount)
fmt.Println(resp.Count)
fmt.Println(resp.Analysis)
}
Related documents
- After you use the SDK to send an API request, the server returns a response. If the response contains a non-200 status code, the API call fails. To view the error code and error message, refer to API reference.
- The following table describes the API actions involved in the preceding sample code. To view the details of each API action, refer to API reference.
- APIDescriptionAPIDescriptionCall the SearchLogs interface to query logs.
- To get the complete sample code of TLS queries and analysis, refer to TLS Go SDK Demo on GitHub.
Last updated: 2025.10.11 16:44:07
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
