Categorygithub.com/mimzychou/tencentcloud-cls-sdk-go
repositorypackage
1.0.4
Repository: https://github.com/mimzychou/tencentcloud-cls-sdk-go.git
Documentation: pkg.go.dev
Overview
Dependencies
26
Dependents
0

# README

Tencent CLS Log SDK

"tencent cloud cls log sdk" 是专门为cls量身打造日志上传SDK。 一切只为满足您的需求～

USAGE

go get github.com/tencentcloud/tencentcloud-cls-sdk-go

为什么要使用CLS Log SDK

  • 异步发送：发送日志立即返回，无须等待，支持传入callback function。
  • 优雅关闭：通过调用close方法，producer会将所有其缓存的数据进行发送，防止日志丢失。
  • 感知每一条日志的成功状态： 用户可以自定义CallBack方法的实现，监控每一条日志的状态
  • 使用简单： 通过简单配置，就可以实现复杂的日志上传聚合、失败重试等逻辑
  • 失败重试： 429、500 等服务端错误，都会进行重试
  • 高性能： 得益于go语言的高并发能力

CLS Host

https://cloud.tencent.com/document/product/614/18940

Demo

func main() {
    producerConfig := GetDefaultAsyncProducerClientConfig()
	producerConfig.Endpoint = "ap-guangzhou.cls.tencentcs.com"
	producerConfig.AccessKeyID = ""
	producerConfig.AccessKeySecret = ""
	topicId := ""
	producerInstance, err := NewAsyncProducerClient(producerConfig)
	if err != nil {
		t.Error(err)
	}

	producerInstance.Start()
	var m sync.WaitGroup
	callBack := &Callback{}
	for i := 0; i < 10; i++ {
		m.Add(1)
		go func() {
			defer m.Done()
			for i := 0; i < 1000; i++ {
				log := NewCLSLog(time.Now().Unix(), map[string]string{"content": "hello world| I'm from Beijing", "content2": fmt.Sprintf("%v", i)})
				err = producerInstance.SendLog(topicId, log, callBack)
				if err != nil {
					t.Error(err)
				}
			}
		}()
	}
	m.Wait()
	producerInstance.Close(60000)
}

type Callback struct {
}

func (callback *Callback) Success(result *Result) {
	attemptList := result.GetReservedAttempts()
	for _, attempt := range attemptList {
		fmt.Printf("%+v \n", attempt)
	}
}

func (callback *Callback) Fail(result *Result) {
	fmt.Println(result.IsSuccessful())
	fmt.Println(result.GetErrorCode())
	fmt.Println(result.GetErrorMessage())
	fmt.Println(result.GetReservedAttempts())
	fmt.Println(result.GetRequestId())
	fmt.Println(result.GetTimeStampMs())
}

配置参数详解

参数类型描述
TotalSizeLnBytesInt64实例能缓存的日志大小上限，默认为 100MB。
MaxSendWorkerCountInt64client能并发的最多"goroutine"的数量，默认为50
MaxBlockSecInt如果client可用空间不足，调用者在 send 方法上的最大阻塞时间，默认为 60 秒。
如果超过这个时间后所需空间仍无法得到满足，send 方法会抛出TimeoutException。如果将该值设为0，当所需空间无法得到满足时，send 方法会立即抛出 TimeoutException。如果您希望 send 方法一直阻塞直到所需空间得到满足，可将该值设为负数。
MaxBatchSizeInt64当一个Batch中缓存的日志大小大于等于 batchSizeThresholdInBytes 时，该 batch 将被发送，默认为 512 KB，最大可设置成 5MB。
MaxBatchCountInt当一个Batch中缓存的日志条数大于等于 batchCountThreshold 时，该 batch 将被发送，默认为 4096，最大可设置成 40960。
LingerMsInt64Batch从创建到可发送的逗留时间，默认为 2 秒，最小可设置成 100 毫秒。
RetriesInt如果某个Batch首次发送失败，能够对其重试的次数，默认为 10 次。
如果 retries 小于等于 0，该 ProducerBatch 首次发送失败后将直接进入失败队列。
MaxReservedAttemptsInt每个Batch每次被尝试发送都对应着一个Attemp，此参数用来控制返回给用户的 attempt 个数，默认只保留最近的 11 次 attempt 信息。
该参数越大能让您追溯更多的信息，但同时也会消耗更多的内存。
BaseRetryBackoffMsInt64首次重试的退避时间，默认为 100 毫秒。 client采样指数退避算法，第 N 次重试的计划等待时间为 baseRetryBackoffMs * 2^(N-1)。
MaxRetryBackoffMsInt64重试的最大退避时间，默认为 50 秒。

generate cls log

protoc --gofast_out=. cls.proto

feature