### Install Volcengine Log Service Go SDK

Source: https://www.volcengine.com/docs/6470/117661

Use 'go get' to download the SDK. For Go 1.16+, 'go install' is recommended.

```go
go get -u github.com/volcengine/volc-sdk-golang

go

```

--------------------------------

### 下载火山引擎日志服务 Go SDK

Source: https://www.volcengine.com/docs/6470/117661?lang=zh

使用 `go get` 命令下载火山引擎日志服务 Go SDK。对于 Go 1.16 及以上版本，推荐使用 `go install` 命令。

```go
go get -u github.com/volcengine/volc-sdk-golang
```

--------------------------------

### Log Topic Management Examples (Go)

Source: https://www.volcengine.com/docs/6470/116567

Code examples for managing log topics, covering creation, modification, viewing, and deletion. These are available in the GitHub example projects.

```Go
日志主题管理​| 日志主题管理的示例代码，包括创建日志主题、修改日志主题、查看日志主题和删除日志主题。
```

--------------------------------

### C++ SDK Example Project - Common API Calls

Source: https://www.volcengine.com/docs/6470/1119991

This example project demonstrates common API calls for the Volcengine Log Service C++ SDK, including creating log projects, creating log topics, and writing logs. It serves as a practical guide for integrating the SDK into your C++ applications.

```cpp
#include <iostream>
#include <string>
#include <vector>

#include "tls_client.h"
#include "tls_define.h"

using namespace std;
using namespace VolcengineTls;

int main() {
    // Replace with your actual access key, secret key, and region
    string accessKey = "YOUR_ACCESS_KEY";
    string secretKey = "YOUR_SECRET_KEY";
    string region = "YOUR_REGION"; // e.g., "cn-beijing"
    string endpoint = "your_tls_endpoint"; // e.g., "https://tls.cn-beijing.volces.com"

    // Initialize TLS client
    TLSClient client(accessKey, secretKey, region, endpoint);

    // --- Example: Create Log Project ---
    cout << "--- Creating Log Project ---" << endl;
    CreateProjectRequest createProjectReq;
    createProjectReq.projectName = "my_cpp_project";
    createProjectReq.projectDesc = "My C++ Project Description";
    createProjectReq.tags = {{"key1", "value1"}, {"key2", "value2"}};

    CreateProjectResponse createProjectRes;
    ErrorCode err = client.CreateProject(createProjectReq, createProjectRes);
    if (err.Code() == 0) {
        cout << "Project created successfully. Project ID: " << createProjectRes.project_id << endl;
    } else {
        cerr << "Failed to create project. Error Code: " << err.Code() << ", Error Message: " << err.Message() << endl;
        return 1;
    }

    // --- Example: Create Log Topic ---
    cout << "\n--- Creating Log Topic ---" << endl;
    CreateTopicRequest createTopicReq;
    createTopicReq.projectName = createProjectReq.projectName;
    createTopicReq.topicName = "my_cpp_topic";
    createTopicReq.topicDesc = "My C++ Topic Description";
    createTopicReq.auto_split = false;
    createTopicReq.max_split_num = 5;
    createTopicReq.ttl = 30;
    createTopicReq.tags = {{"topic_tag_key", "topic_tag_value"}};

    CreateTopicResponse createTopicRes;
    err = client.CreateTopic(createTopicReq, createTopicRes);
    if (err.Code() == 0) {
        cout << "Topic created successfully. Topic ID: " << createTopicRes.topic_id << endl;
    } else {
        cerr << "Failed to create topic. Error Code: " << err.Code() << ", Error Message: " << err.Message() << endl;
        // Clean up project if topic creation fails
        client.DeleteProject(createProjectRes.project_id);
        return 1;
    }

    // --- Example: Write Logs ---
    cout << "\n--- Writing Logs ---" << endl;
    WriteLogsRequest writeLogsReq;
    writeLogsReq.project_id = createProjectRes.project_id;
    writeLogsReq.topic_id = createTopicRes.topic_id;

    // Create log items
    vector<Log> logs;
    Log log1;
    log1.content = "This is the first log message.";
    log1.time = time(NULL); // Current time
    log1.contents["key1"] = "value1";
    logs.push_back(log1);

    Log log2;
    log2.content = "This is the second log message with a field.";
    log2.time = time(NULL) + 1; // Slightly later time
    log2.contents["key2"] = "value2";
    log2.contents["level"] = "info";
    logs.push_back(log2);

    writeLogsReq.logs = logs;

    WriteLogsResponse writeLogsRes;
    err = client.WriteLogs(writeLogsReq, writeLogsRes);
    if (err.Code() == 0) {
        cout << "Logs written successfully. Count: " << writeLogsRes.count << endl;
    } else {
        cerr << "Failed to write logs. Error Code: " << err.Code() << ", Error Message: " << err.Message() << endl;
        // Clean up project and topic if log writing fails
        client.DeleteTopic(createProjectRes.project_id, createTopicRes.topic_id);
        client.DeleteProject(createProjectRes.project_id);
        return 1;
    }

    // --- Example: Delete Log Topic ---
    cout << "\n--- Deleting Log Topic ---" << endl;
    err = client.DeleteTopic(createProjectRes.project_id, createTopicRes.topic_id);
    if (err.Code() == 0) {
        cout << "Topic deleted successfully." << endl;
    } else {
        cerr << "Failed to delete topic. Error Code: " << err.Code() << ", Error Message: " << err.Message() << endl;
        // Clean up project if topic deletion fails
        client.DeleteProject(createProjectRes.project_id);
        return 1;
    }

    // --- Example: Delete Log Project ---
    cout << "\n--- Deleting Log Project ---" << endl;
    err = client.DeleteProject(createProjectRes.project_id);
    if (err.Code() == 0) {
        cout << "Project deleted successfully." << endl;
    } else {
        cerr << "Failed to delete project. Error Code: " << err.Code() << ", Error Message: " << err.Message() << endl;
        return 1;
    }

    cout << "\nDemo finished successfully." << endl;
    return 0;
}

```

--------------------------------

### Node.js package.json with SDK dependency

Source: https://www.volcengine.com/docs/6470/116992

This is an example of the package.json file after installing the Volcengine Node.js SDK.

```json
{
  "name": "nodejs-doc",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC",
  "dependencies": {
    "@volcengine/openapi": "^1.2.2"
  }
}
```

--------------------------------

### Log Project Management Examples (Go)

Source: https://www.volcengine.com/docs/6470/116567

Code examples for managing log projects, including creation, modification, viewing, and deletion. These snippets are part of the GitHub example projects.

```Go
日志项目管理​| 日志项目管理的示例代码，包括创建日志项目、修改日志项目、查看日志项目和删除日志项目。
```

--------------------------------

### Java SDK: Consume Logs with Consumer Group

Source: https://www.volcengine.com/docs/6470/1172144

This example demonstrates the overall process of creating a consumer group and a consumer using the Java SDK to consume logs. It initializes the client, configures consumer settings, starts consumption, and includes a placeholder for custom log processing logic.

```Java
package com.volcengine.example.tls.demo;

import java.util.ArrayList;
import java.util.List;

import com.volcengine.model.tls.consumer.ConsumerConfig;
import com.volcengine.model.tls.exception.LogException;
import com.volcengine.model.tls.pb.PutLogRequest;
import com.volcengine.service.tls.consumer.Consumer;
import com.volcengine.service.tls.consumer.ConsumerImpl;
import com.volcengine.service.tls.consumer.LogProcessor;


// 您需要定义一个实现LogProcessor接口的类
public class ConsumerDemo implements LogProcessor {
    public static void main(String[] args) throws LogException, InterruptedException {
        // 初始化客户端，推荐通过环境变量动态获取火山引擎密钥等身份认证信息，以免 AccessKey 硬编码引发数据安全风险。详细说明请参考https://www.volcengine.com/docs/6470/1166455
        // 使用 STS 时，ak 和 sk 均使用临时密钥，且设置 VOLCENGINE_TOKEN；不使用 STS 时，VOLCENGINE_TOKEN 部分传空 
        ConsumerConfig config = new ConsumerConfig(System.getenv("VOLCENGINE_ENDPOINT"), System.getenv("VOLCENGINE_REGION"),
                System.getenv("VOLCENGINE_ACCESS_KEY_ID"), System.getenv("VOLCENGINE_ACCESS_KEY_SECRET"), System.getenv("VOLCENGINE_TOKEN"));
        // 请配置您的日志项目ID
        config.setProjectID("your-project-id");
        // 请配置您待消费的日志主题ID列表
        config.setTopicIDList(new ArrayList<String>(){
            add("your-topic-id");
        });
        // 请配置您的消费组名称
        config.setConsumerGroupName("java-consumer-group");
        // 请配置消费者名称
        config.setConsumerName("java-consumer");

        // 实例化ConsumerImpl，调用consumer.start()开始持续消费
        Consumer consumer = new ConsumerImpl(config, new ConsumerDemo());
        consumer.start();

        // 可通过调用consumer.stop()来结束消费组消费
        Thread.sleep(10000);
        consumer.stop();
    }

    /**
     * 您需要根据业务需要，自行实现这里的process方法，用于处理每次消费得到的LogGroupList
     * 下面给出了逐个打印消费到的日志的代码示例
     */
    @Override
    public void process(String topicID, int shardID, PutLogRequest.LogGroupList logGroupList) {
        System.out.println(topicID + " --- " + shardID);
        System.out.println(logGroupList.getLogGroupsCount());

        int count = 0;

        List<PutLogRequest.LogGroup> logGroups = logGroupList.getLogGroupsList();
        for (PutLogRequest.LogGroup logGroup: logGroups) {
            List<PutLogRequest.Log> logs = logGroup.getLogsList();
            for (PutLogRequest.Log log: logs) {
                count++;
                System.out.println("*** Count = " + count + " ***");
                List<PutLogRequest.LogContent> logContents = log.getContentsList();
                for (PutLogRequest.LogContent logContent: logContents) {
                    System.out.println(logContent.getKey() + ": " + logContent.getValue());
                }
                System.out.println();
            }
        }
    }
}

```

--------------------------------

### Install and Start LogCollector

Source: https://www.volcengine.com/docs/6470/72007

Execute this command to install and automatically start the LogCollector process. Required parameters include region, endpoint, secret_id, and secret_key. Optional parameters like label, memory, and cpu can also be set.

```shell
sudo ./logcollector.sh install --region <region> --endpoint <endpoint> --secret_id <secret_id> --secret_key <secret_key> --label <label> --cpu 200% --memory 2G
```

--------------------------------

### Install Proto Dependencies

Source: https://www.volcengine.com/docs/6470/1403984

Execute this command to install the necessary proto dependencies for the Go SDK.

```Shell
go get -u github.com/gogo/protobuf/proto

```

--------------------------------

### DescribeRule API Request Example

Source: https://www.volcengine.com/docs/6470/112202

Example HTTP GET request to the DescribeRule API to retrieve rule configuration.

```HTTP
GET https://{tls-endpoint}/DescribeRule?RuleId=faf HTTP/1.1
```

--------------------------------

### Create Project, Topic, and Index using Java SDK

Source: https://www.volcengine.com/docs/6470/1172148

This example shows how to initialize the TLS client, create a log project, create a log topic with specified configurations, and set up indexing for the topic.

```APIDOC
## Create Project, Topic, and Index using Java SDK

### Description
This example shows how to initialize the TLS client, create a log project, create a log topic with specified configurations, and set up indexing for the topic.

### Method
Java SDK methods

### Endpoint
N/A (SDK usage)

### Parameters
#### Client Initialization
- **VOLCENGINE_ENDPOINT** (string) - Environment variable for endpoint
- **VOLCENGINE_REGION** (string) - Environment variable for region
- **VOLCENGINE_ACCESS_KEY_ID** (string) - Environment variable for access key ID
- **VOLCENGINE_ACCESS_KEY_SECRET** (string) - Environment variable for access key secret
- **VOLCENGINE_TOKEN** (string) - Environment variable for STS token (if applicable)

#### CreateProjectRequest
- **projectName** (string) - Required - The name of the log project.
- **region** (string) - Required - The region for the log project.
- **description** (string) - Optional - A description for the log project.

#### CreateTopicRequest
- **projectId** (string) - Required - The ID of the project to which the topic belongs.
- **topicName** (string) - Required - The name of the log topic.
- **ttl** (integer) - Optional - Time-to-live for logs in days (default 30).
- **description** (string) - Optional - A description for the log topic.
- **shardCount** (integer) - Optional - The number of shards for the topic (default 2).
- **autoSplit** (boolean) - Optional - Whether to enable automatic shard splitting (default true).
- **maxSplitShard** (integer) - Optional - The maximum number of shards allowed when auto-splitting (default 50).
- **enableTracking** (boolean) - Optional - Whether to enable tracking for the topic (default true).

#### CreateIndexRequest
- **topicId** (string) - Required - The ID of the topic to configure indexing for.
- **fullText** (FullTextInfo) - Optional - Configuration for full-text indexing.
  - **caseSensitive** (boolean) - Whether full-text search is case-sensitive.
  - **delimiter** (string) - Delimiter for tokenization.
  - **includeChinese** (boolean) - Whether to include Chinese characters in tokenization.
- **keyValue** (List<KeyValueInfo>) - Optional - Configuration for key-value indexing.
  - **key** (string) - The key name for the key-value pair.
  - **valueInfo** (ValueInfo) - Configuration for the value.
    - **valueType** (string) - Type of the value (e.g., 'text').
    - **delimiter** (string) - Delimiter for parsing the value.
    - **caseSensitive** (boolean) - Whether key-value search is case-sensitive.
    - **includeChinese** (boolean) - Whether to include Chinese characters in parsing.
    - **sqlFlag** (boolean) - Whether to enable SQL-like querying for this key.

### Request Example
```java
package com.volcengine.example.tls.demo;

import com.volcengine.model.tls.*;
import com.volcengine.model.tls.exception.LogException;
import com.volcengine.model.tls.request.*;
import com.volcengine.model.tls.response.*;
import com.volcengine.service.tls.TLSLogClient;

import java.util.ArrayList;
import java.util.List;


public class Demo {
    public static void main(String[] args) throws LogException {
        // Initialize client
        ClientConfig clientConfig = new ClientConfig(System.getenv("VOLCENGINE_ENDPOINT"), System.getenv("VOLCENGINE_REGION"),
            System.getenv("VOLCENGINE_ACCESS_KEY_ID"), System.getenv("VOLCENGINE_ACCESS_KEY_SECRET"), System.getenv("VOLCENGINE_TOKEN"));
        TLSLogClient client = ClientBuilder.newClient(clientConfig);

        // Create log project
        CreateProjectRequest createProjectRequest = new CreateProjectRequest("project-name", "region", "description");
        CreateProjectResponse createProjectResponse = client.createProject(createProjectRequest);
        String projectID = createProjectResponse.getProjectId();

        // Create log topic
        CreateTopicRequest createTopicRequest = new CreateTopicRequest();
        createTopicRequest.setProjectId(projectID);
        createTopicRequest.setTopicName("topic-name");
        createTopicRequest.setTtl(30);
        createTopicRequest.setDescription("description");
        createTopicRequest.setShardCount(2);
        createTopicRequest.setAutoSplit(true);
        createTopicRequest.setMaxSplitShard(50);
        createTopicRequest.setEnableTracking(true);
        CreateTopicResponse createTopicResponse = client.createTopic(createTopicRequest);
        String topicID = createTopicResponse.getTopicId();

        // Create index configuration
        FullTextInfo fullText = new FullTextInfo(false, ",-;", false);
        ValueInfo textValueInfo = new ValueInfo();
        textValueInfo.setValueType("text");
        textValueInfo.setDelimiter(",");
        textValueInfo.setCaseSensitive(false);
        textValueInfo.setIncludeChinese(false);
        textValueInfo.setSqlFlag(false);
        List<KeyValueInfo> keyValue = new ArrayList<>();
        keyValue.add(new KeyValueInfo("key1", textValueInfo));
        CreateIndexRequest createIndexRequest = new CreateIndexRequest(topicID, fullText, keyValue);
        CreateIndexResponse createIndexResponse = client.createIndex(createIndexRequest);
    }
}
```

### Response
#### Success Response (200)
- **createProjectResponse**: Contains `projectId`.
- **createTopicResponse**: Contains `topicId`.
- **createIndexResponse**: Indicates successful index creation.
```

--------------------------------

### GetAccountStatus Request Example

Source: https://www.volcengine.com/docs/6470/1978273

This is an example of a GET request to the GetAccountStatus API endpoint. Ensure the correct TLS endpoint is used.

```http
GET https://{tls-endpoint}/GetAccountStatus HTTP/1.1
Content-Type: application/json

```

--------------------------------

### Run Volcengine TLS Producer Example

Source: https://www.volcengine.com/docs/6470/1829923

Entry point for running the Volcengine TLS producer examples. Handles exceptions during execution. Ensure the TLS producer is initialized with correct project and region details.

```csharp
using System;

namespace VolcengineTls.Examples
{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
                Console.WriteLine("Starting example...");

                var example = new ProducerExample();

                example.Run(); // 同步方法
                // example.RunAsync().Wait(); // 异步方法

                Console.WriteLine("Example completed successfully.");
            }
            catch (AggregateException ex)
            {
                foreach (var innerEx in ex.InnerExceptions)
                {
                    Console.WriteLine($"Error: {innerEx.Message}");
                    if (innerEx.InnerException != null)
                    {
                        Console.WriteLine($"Inner Error: {innerEx.InnerException.Message}");
                    }
                }
            }
            catch (Exception ex)
            {
                Console.log($"Error: {ex.Message}");
                if (ex.InnerException != null)
                {
                    Console.WriteLine($"Inner Error: {ex.InnerException.Message}");
                }
            }

            Console.WriteLine("Press any key to exit...");
            Console.ReadKey();
        }
    }
}

```

--------------------------------

### DescribeShippers API Request Example

Source: https://www.volcengine.com/docs/6470/1333753

This is an example of an HTTP GET request to the DescribeShippers API. It includes parameters for filtering and pagination of shipper information.

```http
GET https://{tls-endpoint}/DescribeShippers?&ProjectId=f3e901c3-b17f-42fd-aa8c-dc91a6c7****&ProjectName=&PageNumber=10&PageSize=20&ShipperName=test&ShipperId=f3e901c3-b17f-42fd-aa8c-dc91a6c7****&TopicName=test&TopicId=f3e901c3-b17f-42fd-aa8c-dc91a6c7****&ShipperType=tos HTTP/1.1
Content-Type: application/json
```

--------------------------------

### Python SDK: Account Management Examples

Source: https://www.volcengine.com/docs/6470/145368

Provides example code for managing your Volcengine Log Service account, including checking account status and activating the service.

```python
from volcengine_log_service.log_client import LogClient
from volcengine_log_service.models.log_request import GetAccountStatusRequest, ActivateServiceRequest

# Initialize the client
client = LogClient(region='cn-beijing', ak='YOUR_AK', sk='YOUR_SK')

# Get account status
status_req = GetAccountStatusRequest()
status_resp = client.get_account_status(status_req)
print(f"Account Status: {status_resp}")

# Activate the service (if not already active)
# activate_req = ActivateServiceRequest()
# activate_resp = client.activate_service(activate_req)
# print(f"Activate Service Response: {activate_resp}")
```

--------------------------------

### C++ SDK Example Project Link

Source: https://www.volcengine.com/docs/6470/1119991?lang=zh

This link points to a GitHub repository containing example projects for the Volcengine Log Service C++ SDK. It demonstrates common API calls such as creating log projects, creating log topics, and writing logs.

```markdown
**示例项目**| **说明**  
---|---  
https://github.com/volcengine/ve-tls-cpp-sdk/blob/master/demo/main.cc| 日志服务的常用接口调用示例，包括创建日志项目、创建日志主题、写入日志等操作。  
```

--------------------------------

### DescribeAlarms API Request Example

Source: https://www.volcengine.com/docs/6470/112219

This is an example of an HTTP GET request to the DescribeAlarms API. Ensure you replace the placeholder {tls-endpoint} with your actual endpoint.

```http
GET https://{tls-endpoint}/DescribeAlarms?ProjectId=e4**** HTTP/1.1
```

--------------------------------

### Python SDK: Log Upload and Query Examples

Source: https://www.volcengine.com/docs/6470/145368

Provides example code for uploading logs, querying consumer cursors, consuming logs, and searching/retrieving logs.

```python
from volcengine_log_service.log_client import LogClient
from volcengine_log_service.models.log_request import PutLogsRequest, GetCursorRequest, BatchGetLogsRequest
from volcengine_log_service.models.log_model import Log, LogContent
import time

# Initialize the client
client = LogClient(region='cn-beijing', ak='YOUR_AK', sk='YOUR_SK')

# Upload logs
log_contents = [
    LogContent(key='log_message', value='This is a test log message.')
]
log = Log(contents=log_contents, time=int(time.time() * 1000))
put_req = PutLogsRequest(project_name='my-log-project', topic_name='my-log-topic', logs=[log])
put_resp = client.put_logs(put_req)
print(f"Put Logs Response: {put_resp}")

# Get consumer cursor
get_cursor_req = GetCursorRequest(project_name='my-log-project', topic_name='my-log-topic', shard_id=0)
get_cursor_resp = client.get_cursor(get_cursor_req)
cursor = get_cursor_resp.cursor
print(f"Cursor: {cursor}")

# Consume logs (example with a specific cursor)
# In a real scenario, you would typically use the cursor obtained from get_cursor or a previous consumption.
# For demonstration, let's assume we have a valid cursor.
# batch_get_logs_req = BatchGetLogsRequest(project_name='my-log-project', topic_name='my-log-topic', shard_id=0, cursor=cursor, count=10)
# batch_get_logs_resp = client.batch_get_logs(batch_get_logs_req)
# print(f"Batch Get Logs Response: {batch_get_logs_resp}")

# Search and retrieve logs (example query)
search_req = {
    "project_name": "my-log-project",
    "topic_name": "my-log-topic",
    "query": "log_message: \"test log\"",
    "start_time": int((time.time() - 3600) * 1000), # Last 1 hour
    "end_time": int(time.time() * 1000)
}
search_resp = client.search_logs(search_req)
print(f"Search Logs Response: {search_resp}")
```

--------------------------------

### Example GET Request URL for DescribeProjects

Source: https://www.volcengine.com/docs/6470/112165

This example shows an unencoded HTTPS request URL for the DescribeProjects API, including pagination parameters.

```plaintext
GET https://{tls-endpoint}/DescribeProjects?PageNumber=1&PageSize=10
```

--------------------------------

### DescribeHostGroupV2 Request Example

Source: https://www.volcengine.com/docs/6470/2121514

This example demonstrates how to call the DescribeHostGroupV2 API using a GET request. Ensure you replace `{tls-endpoint}` with your actual TLS endpoint.

```http
GET https://{tls-endpoint}/DescribeHostGroupV2?&HostGroupId="c7e0e442-19bf-4fb3-b547-5992fb8b****" HTTP/1.1
Content-Type: application/json

```

--------------------------------

### DescribeImportTask API Request Example

Source: https://www.volcengine.com/docs/6470/1333761

This is an example of an HTTP GET request to the DescribeImportTask API. It is used to retrieve details about a specific log import task.

```http
GET https://{tls-endpoint}/DescribeImportTask?&TaskId="fa************" HTTP/1.1
Content-Type: application/json
```

--------------------------------

### Install Sarama for Kafka Go SDK

Source: https://www.volcengine.com/docs/6470/134625

Install the Sarama library, a popular Kafka client for Go, using the provided command. This is a prerequisite for consuming logs with the Go SDK.

```bash
go get github.com/Shopify/sarama@v1.38.1
```

--------------------------------

### DescribeHostGroups API Example

Source: https://www.volcengine.com/docs/6470/112211?lang=zh

Example of an HTTP GET request to describe host groups, including parameters for filtering and pagination, and a sample success response.

```APIDOC
## DescribeHostGroups API

### Request Example

```http
GET https://{tls-endpoint}/DescribeHostGroups?HostGroupId=662*********&HostGroupName=mgn1&PageNumber=1&PageSize=20 HTTP/1.1
```

### Response Example (Success - 200 OK)

```json
{
  "Total": 1,
  "HostGroupHostsRulesInfo": {
    "HostGroupInfo": {
      "HostGroupId": "0fda**********",
      "HostGroupName": "mgn1",
      "HostGroupType": "IP",
      "HostCount": 2,
      "NormalHeartbeatStatusCount": 1,
      "AbnormalHeartbeatStatusCount": 1,
      "RuleCount": 1,
      "AutoUpdate": true,
      "UpdateStartTime": "00:00",
      "UpdateEndTime": "02:00",
      "AgentLatestVersion": "1.0.8",
      "CreateTimestamp": "2021-08-18 13:32:23",
      "ModifyTimestamp": "2021-08-18 13:32:23",
      "ServiceLogging": true,
      "IamProjectName": "default"
    },
    "HostInfos": [
      {
        "Ip": "127.0.0.1",
        "LogCollectorVersion": "logcollector-1.0.3",
        "HeartbeatStatus": 0
      },
      {
        "Ip": "127.0.0.2",
        "LogCollectorVersion": "logcollector-1.0.3",
        "HeartbeatStatus": 1
      }
    ],
    "RuleInfos": [
      {
        "TopicId": "faf6*******",
        "TopicName": "tn1",
        "RuleId": "faf********",
        "RuleName": "testname",
        "Paths": [
          "/data/nginx/log/*/*/*.log"
        ],
        "ExcludePaths": [
          {
            "Type": "File",
            "Value": "/data/nginx/log/*/*/exclude.log"
          }
        ]
      }
    ]
  }
}
```
```

--------------------------------

### Consume Logs using Go Consumer

Source: https://www.volcengine.com/docs/6470/1172151?lang=zh

This example demonstrates how to consume log data using the Go Consumer, which is recommended for production environments. It handles configuration, log processing, and consumer lifecycle management.

```go
package tls

import (
"context"
"fmt"
"os"
"time"

"github.com/pkg/errors"
log_consumer "github.com/volcengine/volc-sdk-golang/service/tls/consumer"
"github.com/volcengine/volc-sdk-golang/service/tls/pb"
)


func launchConsumer() error {
// 获取消费组的默认配置
consumerCfg := log_consumer.GetDefaultConsumerConfig()
// 请配置您的Endpoint、Region、AccessKeyID、AccessKeySecret等基本信息
consumerCfg.Endpoint = os.Getenv("VOLCENGINE_ENDPOINT")
consumerCfg.Region = os.Getenv("VOLCENGINE_REGION")
consumerCfg.AccessKeyID = os.Getenv("VOLCENGINE_ACCESS_KEY_ID")
consumerCfg.AccessKeySecret = os.Getenv("VOLCENGINE_ACCESS_KEY_SECRET")
// 请配置您的日志项目ID和日志主题ID列表
consumerCfg.ProjectID = "<YOUR-PROJECT-ID>"
consumerCfg.TopicIDList = []string{"<YOUR-TOPIC-ID>"}
// 请配置您的消费组名称（若您未创建过消费组，SDK将默认为您创建指定名称的消费组）
consumerCfg.ConsumerGroupName = "<CONSUMER-GROUP-NAME>"
// 请配置消费者名称（同一个消费组的不同消费者需要保证不同名）
consumerCfg.ConsumerName = "<CONSUMER_NAME>"

// 定义日志消费函数，您可根据业务需要，自行实现处理LogGroupList的日志消费函数
// 下面展示了逐个打印消费到的每条日志的每个键值对的代码实现示例
var handleLogs = func(topicID string, shardID int, l *pb.LogGroupList) {
fmt.Printf("received new logs from topic: %s, shard: %d\n", topicID, shardID)
for _, logGroup := range l.LogGroups {
for _, log := range logGroup.Logs {
for _, content := range log.Contents {
fmt.Printf("%s: %s\n", content.Key, content.Value)
}
}
}
}

// 创建消费者
consumer, err := log_consumer.NewConsumer(context.TODO(), consumerCfg, handleLogs)
if err != nil {
return errors.Wrap(err, "get new consumer failed: ")
}

// 启动消费者消费
if err := consumer.Start(); err != nil {
return errors.Wrap(err, "start consumer failed: ")
}

// 等待消费
<-time.After(time.Second * 60)

// 停止消费
consumer.Stop()

return nil
}

func main() {
if err := launchConsumer(); err != nil {
fmt.Println(err.Error())
}
}
```

--------------------------------

### Log Service Request Example (DescribeHostGroup)

Source: https://www.volcengine.com/docs/6470/112210

An example HTTP GET request to the DescribeHostGroup API endpoint, used for retrieving host group information.

```http
GET https://{tls-endpoint}/DescribeHostGroup?HostGroupId=faf6d************ HTTP/1.1
Content-Type: application/json
```

--------------------------------

### Python SDK: Log Index Management Examples

Source: https://www.volcengine.com/docs/6470/145368

Provides example code for managing log index configurations, including creation, modification, querying, and deletion.

```python
from volcengine_log_service.log_client import LogClient
from volcengine_log_service.models.log_request import CreateIndexRequest, DeleteIndexRequest, GetIndexRequest, UpdateIndexRequest

# Initialize the client
client = LogClient(region='cn-beijing', ak='YOUR_AK', sk='YOUR_SK')

# Create an index configuration
index_config = {
    "Key": "log_message",
    "Type": "text",
    "Alias": "message"
}
create_req = CreateIndexRequest(project_name='my-log-project', topic_name='my-log-topic', log_index=index_config)
create_resp = client.create_index(create_req)
print(f"Create Index Response: {create_resp}")

# Get index configuration
get_req = GetIndexRequest(project_name='my-log-project', topic_name='my-log-topic')
get_resp = client.get_index(get_req)
print(f"Get Index Response: {get_resp}")

# Update index configuration
update_index_config = {
    "Key": "log_message",
    "Type": "text",
    "Alias": "updated_message"
}
update_req = UpdateIndexRequest(project_name='my-log-project', topic_name='my-log-topic', log_index=update_index_config)
update_resp = client.update_index(update_req)
print(f"Update Index Response: {update_resp}")

# Delete index configuration
delete_req = DeleteIndexRequest(project_name='my-log-project', topic_name='my-log-topic')
delete_resp = client.delete_index(delete_req)
print(f"Delete Index Response: {delete_resp}")
```

--------------------------------

### DescribeTraceInstances API Request Example

Source: https://www.volcengine.com/docs/6470/2117574

This example demonstrates a GET request to the DescribeTraceInstances API. It includes common query parameters for pagination, filtering by name, ID, project, and status.

```http
GET https://{tls-endpoint}/DescribeTraceInstances?&PageNumber=1&PageSize=20&TraceInstanceName=test-trace&TraceInstanceId=0fdaa6b6-3c9f-424c-8664-fc0d222c****&ProjectId=c7e0e442-19bf-4fb3-b547-5992fb8b****&ProjectName=my-log-project&Status=CREATED&IamProjectName=my-iam-log-project&CsAccountChannel=web HTTP/1.1
Content-Type: application/json
```

--------------------------------

### Log Service Account Management Examples (Go)

Source: https://www.volcengine.com/docs/6470/116567

Code snippets for managing Log Service accounts, such as checking account status and activating the service. These are provided within the GitHub example projects.

```Go
日志服务账号管理​| 日志服务账号管理的示例代码，包括获取账户状态、开通激活日志服务。
```

--------------------------------

### ConsumeLogs API Request Example

Source: https://www.volcengine.com/docs/6470/112194

This example demonstrates how to make a GET request to the ConsumeLogs API to fetch log data. Ensure to replace placeholders with your actual TopicId and ShardId.

```http
GET https://{tls-endpoint}/ConsumeLogs?TopicId=c13f36aa-3131-41c7-9862-c1fa5d0****&ShardId=0 
Content-Type: application/json 
{
"Cursor": "MC0wLTAwMD****",
"EndCursor": "MC0wLTA****",
"LogGroupCount": 100,
"Compression": "lz4"
}
```

--------------------------------

### Start LogCollector with anonymous identity

Source: https://www.volcengine.com/docs/6470/1792732

Use this command to install and start LogCollector, including the anonymous identity for AK/SK-free log collection. Ensure LogCollector version is V2.2.7 or later.

```Shell
sudo ./logcollector.sh install --region {region} --endpoint {endpoint} --endpoint_strategy {endpoint_strategy} --anonymous_identities {anonymous_identities} --label {label} 

```

--------------------------------

### Log Collection and Retrieval Examples (Go)

Source: https://www.volcengine.com/docs/6470/116567

Demonstrates log collection and retrieval, including resource creation, data ingestion, index configuration, and querying. Find these examples on GitHub.

```Go
日志管理​| 日志采集和检索的示例代码，包括创建相关资源、采集日志数据、配置索引并查询分析日志。
```

--------------------------------

### Python SDK: Log Project Management Examples

Source: https://www.volcengine.com/docs/6470/145368

Provides example code for managing log projects, including creation, modification, viewing, and deletion.

```python
from volcengine_log_service.log_client import LogClient
from volcengine_log_service.models.log_request import CreateProjectRequest, DeleteProjectRequest, GetProjectRequest, UpdateProjectRequest

# Initialize the client
client = LogClient(region='cn-beijing', ak='YOUR_AK', sk='YOUR_SK')

# Create a log project
create_req = CreateProjectRequest(project_name='my-log-project')
create_resp = client.create_project(create_req)
print(f"Create Project Response: {create_resp}")

# Get a log project
get_req = GetProjectRequest(project_name='my-log-project')
get_resp = client.get_project(get_req)
print(f"Get Project Response: {get_resp}")

# Update a log project
update_req = UpdateProjectRequest(project_name='my-log-project', description='Updated project description')
update_resp = client.update_project(update_req)
print(f"Update Project Response: {update_resp}")

# Delete a log project
delete_req = DeleteProjectRequest(project_name='my-log-project')
delete_resp = client.delete_project(delete_req)
print(f"Delete Project Response: {delete_resp}")
```

--------------------------------

### GEOHASH Function Example

Source: https://www.volcengine.com/docs/6470/1206726

This example demonstrates using IP_TO_GEO to get coordinates from an IP address and then encoding them using the GEOHASH function. Ensure the input field 'test_ip' contains valid IP addresses.

```SQL
* | SELECT GEOHASH(IP_TO_GEO(test_ip))
```

--------------------------------

### Python SDK: Collection Configuration Management Examples

Source: https://www.volcengine.com/docs/6470/145368

Provides example code for managing collection configurations, including creation, modification, deletion, applying to machine groups, and removing from machine groups.

```python
from volcengine_log_service.log_client import LogClient
from volcengine_log_service.models.log_request import CreateCollectionRequest, DeleteCollectionRequest, GetCollectionRequest, UpdateCollectionRequest, ApplyCollectionToGroupRequest, DeleteCollectionFromGroupRequest

# Initialize the client
client = LogClient(region='cn-beijing', ak='YOUR_AK', sk='YOUR_SK')

# Create a collection configuration
collection_config = {
    "log_path": "/var/log/app.log",
    "log_type": "json",
    "extract_rule": {
        "log_template": "{{log_message}}",
        "template_format": "json"
    }
}
create_req = CreateCollectionRequest(project_name='my-log-project', collection_name='my-collection-config', collection_config=collection_config)
create_resp = client.create_collection(create_req)
print(f"Create Collection Response: {create_resp}")

# Get a collection configuration
get_req = GetCollectionRequest(project_name='my-log-project', collection_name='my-collection-config')
get_resp = client.get_collection(get_req)
print(f"Get Collection Response: {get_resp}")

# Update a collection configuration
updated_collection_config = {
    "log_path": "/var/log/app.log",
    "log_type": "json",
    "extract_rule": {
        "log_template": "{{log_message}}",
        "template_format": "json"
    },
    "enable_docker_stdout": True
}
update_req = UpdateCollectionRequest(project_name='my-log-project', collection_name='my-collection-config', collection_config=updated_collection_config)
update_resp = client.update_collection(update_req)
print(f"Update Collection Response: {update_resp}")

# Apply collection configuration to a machine group
apply_req = ApplyCollectionToGroupRequest(project_name='my-log-project', collection_name='my-collection-config', machine_group_name='my-machine-group')
apply_resp = client.apply_collection_to_group(apply_req)
print(f"Apply Collection to Group Response: {apply_resp}")

# Delete collection configuration from a machine group
delete_from_group_req = DeleteCollectionFromGroupRequest(project_name='my-log-project', collection_name='my-collection-config', machine_group_name='my-machine-group')
delete_from_group_resp = client.delete_collection_from_group(delete_from_group_req)
print(f"Delete Collection from Group Response: {delete_from_group_resp}")

# Delete a collection configuration
delete_req = DeleteCollectionRequest(project_name='my-log-project', collection_name='my-collection-config')
delete_resp = client.delete_collection(delete_req)
print(f"Delete Collection Response: {delete_resp}")
```

--------------------------------

### Truncate a string from the beginning

Source: https://www.volcengine.com/docs/6470/163078

Use trunc to get a substring from the start of the string up to a specified index (exclusive).

```Python
{{trunc(5,"hello world")}}
```

--------------------------------

### Create Project

Source: https://www.volcengine.com/docs/6470/160162?lang=zh

Demonstrates how to create a new log project.

```APIDOC
## Create Project

### Description
Creates a new log project with the specified name, region, and description.

### Method
`tls_service.create_project(create_project_request)`

### Parameters
- `create_project_request` (CreateProjectRequest): An object containing the project details.
  - `project_name` (string): The name of the project.
  - `region` (string): The region for the project.
  - `description` (string): A description for the project.

### Response
- `project_id` (string): The ID of the newly created project.
```

--------------------------------

### WebTracks API - GET Request

Source: https://www.volcengine.com/docs/6470/128972

This section details how to send log data to Log Service using an HTTP GET request via the WebTracks interface. It outlines the required and optional parameters and provides an example.

```APIDOC
## WebTracks API - GET Request

### Description
Send log data to a specified log topic using an HTTP GET request.

### Method
GET

### Endpoint
`http://${host}/WebTrack`

### Parameters
#### Query Parameters
- **ProjectId** (string) - Required - The ID of the log project.
- **TopicId** (string) - Optional - The ID of the log topic.
- **key1=val1&key2=val2** (string) - Required - Key-value pairs of log data. Multiple pairs are connected by '&'. The total length of log data must be less than 16 KiB.

### Request Example
```bash
curl --request GET 'http://${host}/WebTrack?ProjectId=abc&TopicId=def&key1=val1&key2=val2'
```

### Notes
- `${host}` is the Endpoint for the Log Service region. Refer to Service Addresses for details.
- Ensure the total length of log data is less than 16 KiB.
```

--------------------------------

### Install Go Snappy Package

Source: https://www.volcengine.com/docs/6470/1451289

Install the go-snappy package and tidy Go modules for decompressing Snappy files in Go.

```Shell
go get github.com/golang/snappy
go mod tidy

```