tencentcloud_cls_sdk_go

package module

Go to main page

Versions in this module

v1

v1.0.18

Sep 18, 2026

Changes in this version

type YunApiLogClient

+ func NewYunApiLogClientFromConfig(config YunApiLogClientConfig) (*YunApiLogClient, error)

v1.0.17

Sep 16, 2026

v1.0.16

Sep 1, 2026

Changes in this version

+ const MaxLogSize

+ var ErrLogSizeExceeded = errors.New("logs must be less than 20M")

v1.0.15

Aug 25, 2026

Changes in this version

+ const INVALID_UIN

+ func SignatureWithTC3(secretID, secretKey, service, method, path string, queryString string, ...) (string, error)

+ type APIError struct

+ Code string

+ Message string

type AsyncProducerClientConfig

+ Uin string

+ type ConsumerGroupEntity struct

+ ConsumerGroup string

+ Timeout int

+ Topics []string

+ type ConsumerGroupGetOffsetsResponse struct

+ Response struct{ ... }

+ type ConsumerGroupHeartBeatResponse struct

+ Response struct{ ... }

+ type ConsumerGroupUpdateOffsetsResponse struct

+ Response struct{ ... }

+ type CreateConsumerGroupRequest struct

+ ConsumerGroup string

+ LogsetId string

+ Timeout int

+ Topics []string

+ type CreateConsumerGroupResponse struct

+ Response struct{ ... }

type Credentials

+ Uin string

+ type DeleteConsumerGroupRequest struct

+ ConsumerGroup string

+ LogsetId string

+ type DeleteConsumerGroupResponse struct

+ Response struct{ ... }

+ type Field struct

+ Key string

+ Value interface{}

+ type GetOffsetsRequest struct

+ ConsumerGroup string

+ From string

+ LogsetId string

+ PartitionId string

+ TopicId string

+ type HeartbeatRequest struct

+ Consumer string

+ ConsumerGroup string

+ LogsetId string

+ PartitionStrategy int

+ TopicPartitionsInfo []PartitionInfo

+ type ListConsumerGroupRequest struct

+ LogsetId string

+ Topics []string

+ type ListConsumerGroupResponse struct

+ Response struct{ ... }

+ type Logger interface

+ Debug func(msg string, args ...Field)

+ Error func(msg string, args ...Field)

+ Info func(msg string, args ...Field)

+ Warn func(msg string, args ...Field)

+ type PartitionInfo struct

+ Partitions []int

+ TopicID string

+ type PartitionOffset struct

+ Offset int64

+ PartitionID int

+ type PullLogResponse struct

+ Headers map[string]string

+ LogGroups []*LogGroup

+ NextOffset int64

+ func ParsePullLogResponse(respBytes []byte) (*PullLogResponse, error)

+ func (r *PullLogResponse) GetLogCount() int

+ func (r *PullLogResponse) GetLogGroups() []*LogGroup

+ func (r *PullLogResponse) GetNextOffset() int64

+ type PullLogsClient struct

+ Endpoint string

+ SecretId string

+ SecretKey string

+ Token string

+ UserAgent string

+ func NewPullLogsClient(endpoint, secretId, secretKey, token, userAgent string) *PullLogsClient

+ func (c *PullLogsClient) PullLogs(topicId string, partitionId int, size int, startTime *int64, offset int64, ...) ([]byte, error)

+ func (c *PullLogsClient) PullLogsAndParse(topicId string, partitionId int, size int, startTime *int64, offset int64, ...) (*PullLogResponse, error)

+ type PullLogsRequest struct

+ CompressType string

+ EndTime *int64

+ PartitionId int

+ Query string

+ Size int

+ StartOffset int64

+ StartTime int64

type SyncProducerClientConfig

+ Uin string

+ type TopicPartitionOffsetsInfo struct

+ PartitionOffsets []PartitionOffset

+ TopicID string

+ type UpdateConsumerGroupRequest struct

+ ConsumerGroup string

+ LogsetId string

+ Timeout *int

+ Topics []string

+ type UpdateConsumerGroupResponse struct

+ Response struct{ ... }

+ type UpdateOffsetsRequest struct

+ Consumer string

+ ConsumerGroup string

+ LogsetId string

+ TopicPartitionOffsetsInfo []TopicPartitionOffsetsInfo

+ type YunApiLogClient struct

+ func NewYunApiLogClient(accessKeyId, accessKey string, internal bool, ...) *YunApiLogClient

+ func NewYunApiLogClientSimple(accessKeyId, accessKey string) *YunApiLogClient

+ func NewYunApiLogClientWithConfig(config YunApiLogClientConfig) *YunApiLogClient

+ func (c *YunApiLogClient) CreateConsumerGroup(logsetId, consumerGroup string, timeout int, topics []string) (*CreateConsumerGroupResponse, error)

+ func (c *YunApiLogClient) DeleteConsumerGroup(logsetId, consumerGroup string) (*DeleteConsumerGroupResponse, error)

+ func (c *YunApiLogClient) DoRequest(method string, resource string, params map[string]string, ...) ([]byte, error)

+ func (c *YunApiLogClient) GetOffsets(logsetId, consumerGroup, topicId string, partitionId int, position string) (*ConsumerGroupGetOffsetsResponse, error)

+ func (c *YunApiLogClient) Heartbeat(logsetId, consumerGroup, consumer string, partitions []PartitionInfo) (*ConsumerGroupHeartBeatResponse, error)

+ func (c *YunApiLogClient) ListConsumerGroup(logsetId string, topics []string) (*ListConsumerGroupResponse, error)

+ func (c *YunApiLogClient) UpdateConsumerGroup(logsetId, consumerGroup string, topics []string, timeout *int) (*UpdateConsumerGroupResponse, error)

+ func (c *YunApiLogClient) UpdateOffsets(logsetId, consumerGroup, consumer string, offsets []TopicPartitionOffsetsInfo) (*ConsumerGroupUpdateOffsetsResponse, error)

+ type YunApiLogClientConfig struct

+ AccessKey string

+ AccessKeyId string

+ Internal bool

+ Region string

+ SecurityToken string

+ Source string

+ type ZapLogger struct

+ func GetZapLoggerAdapter() *ZapLogger

+ func NewZapLogger(logger *zap.Logger) *ZapLogger

+ func (z *ZapLogger) Debug(msg string, args ...Field)

+ func (z *ZapLogger) Error(msg string, args ...Field)

+ func (z *ZapLogger) Info(msg string, args ...Field)

+ func (z *ZapLogger) Warn(msg string, args ...Field)

v1.0.14

Dec 1, 2025

Changes in this version

type Options

+ Scheme string

v1.0.14-polaris-v2

Sep 17, 2026

v1.0.14-polaris

Jul 8, 2026

v1.0.14-consumer

Jul 20, 2026

v1.0.13

Nov 27, 2025

Changes in this version

+ func DeflateCompress(data []byte) ([]byte, error)

v1.0.12

Aug 23, 2025

Changes in this version

type AsyncProducerClientConfig

+ func (config *AsyncProducerClientConfig) SetEndpointByRegionAndNetworkType(region Region, networkType NetworkType)

+ type NetworkType string

+ const Extranet

+ const Intranet

+ type Region string

+ const Ashburn

+ const Bangkok

+ const Beijing

+ const BeijingFSI

+ const Chengdu

+ const Chongqing

+ const Frankfurt

+ const Guangzhou

+ const Hongkong

+ const Jakarta

+ const Nanjing

+ const Saopaulo

+ const Seoul

+ const Shanghai

+ const ShanghaiADC

+ const ShanghaiFSI

+ const ShenzhenFSI

+ const Siliconvalley

+ const Singapore

+ const Tokyo

type SyncProducerClientConfig

+ func (config *SyncProducerClientConfig) SetEndpointByRegionAndNetworkType(region Region, networkType NetworkType)

v1.0.12-cloud-db

Aug 25, 2025

v1.0.11

Aug 7, 2024

v1.0.11-ssm-pb

Jan 9, 2025

v1.0.11-ssm

Jan 8, 2025

v1.0.10

Aug 7, 2024

v1.0.9

Apr 29, 2024

Changes in this version

+ func SetUserAgent(agent string)

+ func SetVersion(ver string)

v1.0.8

Feb 21, 2024

Changes in this version

+ var ErrIntOverflowLog = fmt.Errorf("proto: integer overflow")

+ var ErrInvalidLengthLog = fmt.Errorf("proto: negative length found during unmarshaling")

+ var ErrUnexpectedEndOfGroupLog = fmt.Errorf("proto: unexpected end of group")

type AsyncProducerClientConfig

+ HostName string

type Log

+ CollectTime *int64

+ func (m *Log) GetCollectTime() int64

type LogGroup

+ Hostname *string

+ func (m *LogGroup) GetHostname() string

type SyncProducerClientConfig

+ HostName string

v1.0.7

Dec 6, 2023

Changes in this version

+ func GenerateProducerHash(instanceID string) string

v1.0.6

Oct 7, 2023

Changes in this version

+ type Credentials struct

+ SecretID string

+ SecretKEY string

+ SecretToken string

type Options

+ Credentials Credentials

type SyncProducerClient

+ func (c *SyncProducerClient) SendLogGroupList(ctx context.Context, topicID string, logGroupList []*LogGroup) error

v1.0.4

Mar 6, 2023

v1.0.3

Mar 6, 2023

Changes in this version

+ type SyncProducerClient struct

+ func NewSyncProducerClient(config *SyncProducerClientConfig) (*SyncProducerClient, error)

+ func (c *SyncProducerClient) ResetSecretToken(secretID string, secretKEY string, secretToken string) error

+ func (c *SyncProducerClient) SendLogList(ctx context.Context, topicID string, logList []*Log) error

+ type SyncProducerClientConfig struct

+ AccessKeyID string

+ AccessKeySecret string

+ AccessToken string

+ CompressType string

+ Endpoint string

+ IdleConn int

+ NeedSource bool

+ Timeout int

+ func GetDefaultSyncProducerClientConfig() *SyncProducerClientConfig

v1.0.2

Apr 24, 2022

Changes in this version

+ const CompressionLevelDefault

+ func ZSTDCompress(params ZstdEncoderParams, dst, src []byte) ([]byte, error)

+ func ZSTDDecompress(params ZstdDecoderParams, dst, src []byte) ([]byte, error)

type AsyncProducerClientConfig

+ CompressType string

type Options

+ CompressType string

+ type ZstdDecoderParams struct

+ type ZstdEncoderParams struct

+ Level int

v1.0.1

Apr 13, 2022

Changes in this version

+ const BAD_REQUEST

+ const INTERNAL_SERVER_ERROR

+ const MISSING_HOST

+ const MISS_ACCESS_KEY_ID

+ const MISS_ACCESS_SECRET

+ const MISS_ACCESS_TOKEN

+ const UNKNOWN_ERROR

+ const WRITE_QUOTA_EXCEED

+ var ErrIntOverflowCls = fmt.Errorf("proto: integer overflow")

+ var ErrInvalidLengthCls = fmt.Errorf("proto: negative length found during unmarshaling")

+ var ErrUnexpectedEndOfGroupCls = fmt.Errorf("proto: unexpected end of group")

+ func GetLocalIP() (string, error)

+ func GetLogListSize(logList []*Log) (int, error)

+ func GetLogSizeCalculate(log *Log) (int, error)

+ func GetTimeMs(t int64) int64

+ func NewCLSClient(options *Options) (*CLSClient, *CLSError)

+ type Accumulator struct

+ func NewAccumulator(config *AsyncProducerClientConfig, worker *Worker, threadPool *SendThreadPool, ...) *Accumulator

+ type AsyncProducerClient struct

+ Client *CLSClient

+ func NewAsyncProducerClient(asyncProducerClientConfig *AsyncProducerClientConfig) (*AsyncProducerClient, error)

+ func (producer *AsyncProducerClient) Close(timeoutMs int64) error

+ func (producer *AsyncProducerClient) SendLog(topicId string, log *Log, callback CallBack) error

+ func (producer *AsyncProducerClient) SendLogList(topicId string, logList []*Log, callback CallBack) (err error)

+ func (producer *AsyncProducerClient) Start()

+ type AsyncProducerClientConfig struct

+ AccessKeyID string

+ AccessKeySecret string

+ AccessToken string

+ BaseRetryBackoffMs int64

+ Endpoint string

+ IdleConn int

+ LingerMs int64

+ MaxBatchCount int

+ MaxBatchSize int64

+ MaxBlockSec int

+ MaxReservedAttempts int

+ MaxRetryBackoffMs int64

+ MaxSendWorkerCount int64

+ Retries int

+ Source string

+ Timeout int

+ TotalSizeLnBytes int64

+ func GetDefaultAsyncProducerClientConfig() *AsyncProducerClientConfig

+ type Attempt struct

+ ErrorCode string

+ ErrorMessage string

+ RequestId string

+ Success bool

+ TimeStampMs int64

+ func NewAttempt(success bool, requestId, errorCode, errorMessage string, timeStampMs int64) *Attempt

+ type CLSClient struct

+ func (client *CLSClient) ResetSecretToken(secretID string, secretKEY string, secretToken string) *CLSError

+ func (client *CLSClient) Send(topicId string, group *LogGroup) *CLSError

+ type CLSError struct

+ Code string

+ HTTPCode int32

+ Message string

+ RequestID string

+ func NewError(httpCode int32, requestID, errorCode string, err error) *CLSError

+ func (e CLSError) Error() string

+ func (e CLSError) String() string

+ type CallBack interface

+ Fail func(result *Result)

+ Success func(result *Result)

+ type ErrorMessage struct

+ Code string

+ Message string

+ type Log struct

+ Contents []*Log_Content

+ Time *int64

+ XXX_NoUnkeyedLiteral struct{}

+ XXX_sizecache int32

+ XXX_unrecognized []byte

+ func NewCLSLog(logTime int64, addLogMap map[string]string) *Log

+ func (*Log) Descriptor() ([]byte, []int)

+ func (*Log) ProtoMessage()

+ func (m *Log) GetContents() []*Log_Content

+ func (m *Log) GetTime() int64

+ func (m *Log) Marshal() (dAtA []byte, err error)

+ func (m *Log) MarshalTo(dAtA []byte) (int, error)

+ func (m *Log) MarshalToSizedBuffer(dAtA []byte) (int, error)

+ func (m *Log) Reset()

+ func (m *Log) Size() (n int)

+ func (m *Log) String() string

+ func (m *Log) Unmarshal(dAtA []byte) error

+ func (m *Log) XXX_DiscardUnknown()

+ func (m *Log) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

+ func (m *Log) XXX_Merge(src proto.Message)

+ func (m *Log) XXX_Size() int

+ func (m *Log) XXX_Unmarshal(b []byte) error

+ type LogGroup struct

+ ContextFlow *string

+ Filename *string

+ LogTags []*LogTag

+ Logs []*Log

+ Source *string

+ XXX_NoUnkeyedLiteral struct{}

+ XXX_sizecache int32

+ XXX_unrecognized []byte

+ func (*LogGroup) Descriptor() ([]byte, []int)

+ func (*LogGroup) ProtoMessage()

+ func (m *LogGroup) GetContextFlow() string

+ func (m *LogGroup) GetFilename() string

+ func (m *LogGroup) GetLogTags() []*LogTag

+ func (m *LogGroup) GetLogs() []*Log

+ func (m *LogGroup) GetSource() string

+ func (m *LogGroup) Marshal() (dAtA []byte, err error)

+ func (m *LogGroup) MarshalTo(dAtA []byte) (int, error)

+ func (m *LogGroup) MarshalToSizedBuffer(dAtA []byte) (int, error)

+ func (m *LogGroup) Reset()

+ func (m *LogGroup) Size() (n int)

+ func (m *LogGroup) String() string

+ func (m *LogGroup) Unmarshal(dAtA []byte) error

+ func (m *LogGroup) XXX_DiscardUnknown()

+ func (m *LogGroup) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

+ func (m *LogGroup) XXX_Merge(src proto.Message)

+ func (m *LogGroup) XXX_Size() int

+ func (m *LogGroup) XXX_Unmarshal(b []byte) error

+ type LogGroupList struct

+ LogGroupList []*LogGroup

+ XXX_NoUnkeyedLiteral struct{}

+ XXX_sizecache int32

+ XXX_unrecognized []byte

+ func (*LogGroupList) Descriptor() ([]byte, []int)

+ func (*LogGroupList) ProtoMessage()

+ func (m *LogGroupList) GetLogGroupList() []*LogGroup

+ func (m *LogGroupList) Marshal() (dAtA []byte, err error)

+ func (m *LogGroupList) MarshalTo(dAtA []byte) (int, error)

+ func (m *LogGroupList) MarshalToSizedBuffer(dAtA []byte) (int, error)

+ func (m *LogGroupList) Reset()

+ func (m *LogGroupList) Size() (n int)

+ func (m *LogGroupList) String() string

+ func (m *LogGroupList) Unmarshal(dAtA []byte) error

+ func (m *LogGroupList) XXX_DiscardUnknown()

+ func (m *LogGroupList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

+ func (m *LogGroupList) XXX_Merge(src proto.Message)

+ func (m *LogGroupList) XXX_Size() int

+ func (m *LogGroupList) XXX_Unmarshal(b []byte) error

+ type LogSendRetryQueue struct

+ func NewRetryQueue() *LogSendRetryQueue

+ func (retryQueue *LogSendRetryQueue) Len() int

+ func (retryQueue *LogSendRetryQueue) Less(i, j int) bool

+ func (retryQueue *LogSendRetryQueue) Pop() interface{}

+ func (retryQueue *LogSendRetryQueue) Push(x interface{})

+ func (retryQueue *LogSendRetryQueue) Swap(i, j int)

+ type LogTag struct

+ Key *string

+ Value *string

+ XXX_NoUnkeyedLiteral struct{}

+ XXX_sizecache int32

+ XXX_unrecognized []byte

+ func (*LogTag) Descriptor() ([]byte, []int)

+ func (*LogTag) ProtoMessage()

+ func (m *LogTag) GetKey() string

+ func (m *LogTag) GetValue() string

+ func (m *LogTag) Marshal() (dAtA []byte, err error)

+ func (m *LogTag) MarshalTo(dAtA []byte) (int, error)

+ func (m *LogTag) MarshalToSizedBuffer(dAtA []byte) (int, error)

+ func (m *LogTag) Reset()

+ func (m *LogTag) Size() (n int)

+ func (m *LogTag) String() string

+ func (m *LogTag) Unmarshal(dAtA []byte) error

+ func (m *LogTag) XXX_DiscardUnknown()

+ func (m *LogTag) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

+ func (m *LogTag) XXX_Merge(src proto.Message)

+ func (m *LogTag) XXX_Size() int

+ func (m *LogTag) XXX_Unmarshal(b []byte) error

+ type Log_Content struct

+ Key *string

+ Value *string

+ XXX_NoUnkeyedLiteral struct{}

+ XXX_sizecache int32

+ XXX_unrecognized []byte

+ func (*Log_Content) Descriptor() ([]byte, []int)

+ func (*Log_Content) ProtoMessage()

+ func (m *Log_Content) GetKey() string

+ func (m *Log_Content) GetValue() string

+ func (m *Log_Content) Marshal() (dAtA []byte, err error)

+ func (m *Log_Content) MarshalTo(dAtA []byte) (int, error)

+ func (m *Log_Content) MarshalToSizedBuffer(dAtA []byte) (int, error)

+ func (m *Log_Content) Reset()

+ func (m *Log_Content) Size() (n int)

+ func (m *Log_Content) String() string

+ func (m *Log_Content) Unmarshal(dAtA []byte) error

+ func (m *Log_Content) XXX_DiscardUnknown()

+ func (m *Log_Content) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

+ func (m *Log_Content) XXX_Merge(src proto.Message)

+ func (m *Log_Content) XXX_Size() int

+ func (m *Log_Content) XXX_Unmarshal(b []byte) error

+ type Options struct

+ Host string

+ IdleConn int

+ SecretID string

+ SecretKEY string

+ SecretToken string

+ Timeout int

+ type ProducerBatch struct

+ func NewProducerBatch(topicID string, config *AsyncProducerClientConfig, callBackFunc CallBack, ...) *ProducerBatch

+ type Result struct

+ func NewResult() *Result

+ func (result *Result) GetErrorCode() string

+ func (result *Result) GetErrorMessage() string

+ func (result *Result) GetRequestId() string

+ func (result *Result) GetReservedAttempts() []*Attempt

+ func (result *Result) GetTimeStampMs() int64

+ func (result *Result) IsSuccessful() bool

+ type SendThreadPool struct

+ func NewSendThreadPool(worker *Worker) *SendThreadPool

+ type TimerSendLogTask struct

+ func NewTimerSendLogTask(logAccumulator *Accumulator, retryQueue *LogSendRetryQueue, ioWorker *Worker, ...) *TimerSendLogTask

+ type Worker struct

+ func NewWorker(clsClient *CLSClient, retryQueue *LogSendRetryQueue, maxSendWorkerCount int64, ...) *Worker

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL