tencent cloud

CLS Add-ons Overview

The CLS add-ons are deployed by CLS on each standard node in your cluster when you enable CLS in TKE. They are used to collect application logs generated by TKE and write them to consumers in Tencent Cloud, including CLS and Kafka.

The CLS add-ons are as follows:

Name	Resource Type	Description
tke-log-agent	DeamonSet	Each log-agent Pod contains a controller container and a loglistener sidecar container, which are responsible for collecting logs generated by all containers on the node.
cls-provisioner	Deployment	There is one instance per cluster, responsible for converting the CRD configuration into a collection configuration comprehensible by the loglistener to communicate with CLS.
logconfigs.cls.cloud.tencent.com	CRD	-

log-agent Release Notes

v1.1.7

Category	Content
Feature	Added the `logConfig-max-threshold` parameter. When the logconfig reaches the threshold, the informer is used to query the workload information after you upgrade or restart the add-on. Optimized the method to obtain docker root. You can obtain it via the API preferentially. Custom metadata is available to kafka collector, and SASL authentication is supported.
Bugfix	Fixed the problem where a kubelet parameter error occurred when starting the log-agent. Fixed the problem where a logset API calling error occurred when replacing the `topicID`. CLS is not case-sensitive. Fixed the case-sensitive issue of cls-provisioner. The log-agent supports CSI by default. The Provisioner of StorageClasses is no longer judged and compared separately.

v1.1.6

Category	Content
Feature	Added multi-line Regex matching with container standard output for the kafka collector. You can configure tag API address through environment variables.
Bugfix	Fixed the problem that the agent automatically created a topic but failed to sync it to the cluster tag in regions where CLS was not available, such as Shenzhen and Tianjin. Fixed the problem where the kafka collector’s metadata prefix captured the format issue of containerd. Fixed the problem where the incremental and full options were missing when cls-provisionert was synced to CLS. You can query the workload information through informer during logconfig loading to reduce the load on apiserver.

v1.1.5

Category	Content
Feature	Added São Paulo and Shanghai Auto-Driving Cloud Zone that can be shipped to by CLS.
Bugfix	-

v1.1.4

Category	Content
Feature	Supported collecting standard output logs of the init container. Supported the GBK encoding format for CLS log parsing. Supported namespace label selectors for CLS log collection rules.
Bugfix	Fixed the issue of frequent retries of the event queue. Optimized the queue processing algorithm for the LogConfig and Pod in the log-agent to prevent the queue from being blocked by a large number of repeated events. Fixed the issue where the standard output logs of the container were not collected when there were only namespaces but no labels.

v1.1.3

Category	Content
Feature	Supported index settings for CLS STANDARD_IA.
Bugfix	-

v1.1.2

Category	Content
Feature	Supported configuring a blocklist in CLS collection rules for container files and host files.
Bugfix	-

v1.1.1

Category	Content
Feature	Supported the multi-core CPU for the LogListener. Adapted the LogListener memory to the upper limit of 100 MB memory.
Bugfix	Fixed the issue where the log-agent failed to update the volume link and did not retry after the returned error was not processed during the update.

v1.1.0

Category	Content
Feature	Supported inheriting TKE clusters' tags when a topic was automatically created by CLS. Supported cross-region log shipping for CLS.
Bugfix	-

v1.0.9

Category	Content
Feature	-
Bugfix	Fixed the issue where an empty topic ID caused the logconfig to be deleted and recreated during topic replacement. Fixed the issue where the logconfigpro sync crashed as the logconfigpro informer was not started.

v1.0.8

Category	Content
Feature	Blocked the collection of loglistener logs under kube-system by default. Modified the index creation policy, so that the default index was created only when a topic was automatically created, and the topic index was not modified in other scenarios. Supported the Kafka collector to add metadata information to messages. Supported the following parsing modes in the Kafka collector: full text in a single line, JSON, and full text in multiple lines.
Bugfix	Fixed the issue where the container couldn't be specified when collecting the standard output in the workload scenario. Added the docker client to get Storage Driver, so that if there was no configuration file, the `info` information could be obtained through the client to get Storage Driver. Fixed the error of the specified metadatalabel when collecting container files. Fixed the scheme to get the kubelet root directory. Fixed the collection configuration match error caused by the incorrectly set prefix of the old collection configuration to be deleted. Fixed the issue where the `timestampKey` timestamp set for messages in the current Kafka collector was invalid.

v1.0.7

Category	Content
Feature	Supported creating key-value indexes during topic creation by cls-provisioner, including index name, type, word segmentation, and statistics collection status switch; if not supported, the `pod_name,namespace,container_name` index would be enabled by default. Supported specifying metadatalabels to write the specified Pod labels into metadata collection; if not supported, all Pod labels would be collected as metadata. Supported customizing the CLS TencentCloud API service backend address.
Bugfix	-

V1.0.6

Category	Content
Feature	Supported modifying the kubelet root directory and docker root directory in log-agent.
Bugfix	-

v1.0.5

Category	Content
Feature	Supported the label != operation (exclude labels) in the log collection configuration. Supported collecting only incremental logs by CLS. Supported selecting multiple namespaces and excluding namespaces in the log collection configuration. Supported configuring Pod labels with the same key but different values in log-agent. Supported configuring loglistener parameters.
Bugfix	Fixed a known issue with log-agent using configmap as source. Fixed an issue where the collector configuration was empty and caused verification failures under some conditions. Fixed the issue where the collector failed to delete the configuration when deleting the log rule. Fixed compatibility issues with logConfig configuration.

v1.0.1

Category	Content
Feature	Switched the API for cls-provisioner to access CLS to TencentCloud API. Supported TKE log collection and delivery to CKafka (for more information, see Configure Log Collection via the Console).
Bugfix	-

v0.2.28

Category	Content
Feature	-
Bugfix	Fixed the issue where one Pod corresponded to multiple logconfig files.

v0.2.27

Category	Content
Feature	-
Bugfix	Fixed the issue where the extraction mode configured on a topic was overwritten in some scenarios.

v0.2.26

Category	Content
Feature	-
Bugfix	Fixed the issue where the metadata couldn't be created in some cases when the collection configuration of the `stdout` type was deleted.

v0.2.25

Category	Content
Feature	-
Bugfix	Fixed the log-agent panic issue in some cases. Fixed the issue of soft connection deletion caused by workload cache. Fixed the metadata file creation failure.

v0.2.24

Category	Content
Feature	-
Bugfix	Fixed the issue where metadata was accidentally deleted during container restart in a Pod. Supported automatically cleaning up LogAgentRootDir before log-agent start so as to avoid dirty data. Fixed the panic of log-agent caused by extreme scenarios. Fixed the startup failure caused by log-agent's repeated mounting of the `/data` directory.