Docs

Volcengine Kubernetes Engine

Monitoring add-ons

log-collector

The log-collector is a cluster log collection add-on. This topic describes the functionality, core resources, and installation and upgrade methods of this add-on.

Add-on overview

The log-collector is a log collection client that runs on cluster nodes. Deployed as a DaemonSet on each node, it is used to discover and collect stdout logs and file logs from container applications on the node, and to send the logs to Torch Log Service (TLS). This provides a unified data source for subsequent log search, analysis, alerting, and visualization. After the add-on is installed in a cluster, the system will create the following Kubernetes resources under the kube-system namespace.

Resource name	Resource type	Resource description
log-collector	DaemonSet	The core collector of the add-on. It runs on each node and is used for log collection on the node.
log-collector-controller	Deployment	The add-on controller. It is used to synchronize cluster information to TLS to create a machine group and distribute the configured collection rules to each node.

tip

The preceding table only lists the main resources of the add-on, as well as resources that may be used when the add-on or the corresponding feature is configured. This helps you understand the main components of this add-on. Other resources, such as ConfigMap and Secret, related to the add-on are not described here. The actual resources in the cluster shall prevail.

Add-on versions

For information about the historical release records of the add-on, as well as new features and optimization descriptions for each version, see Add-on release records.

Installing add-ons

In the left navigation pane, click Cluster. Click the target cluster name to open the management page of this cluster.

In the left navigation bar of the cluster management page, click Addons. On the page that appears, click the Monitoring tab.

Move the pointer over the add-on card, click Deploy, and specify the related parameters for the add-on.

Parameter	Description
Deployment method	The deployment method of the add-on. This parameter is fixed and cannot be modified.
Management method	Select the management method of the add-on. Valid values: Managed: Indicates that the add-on is deployed in managed mode. Unmanaged: Indicates that the add-on is deployed in unmanaged mode. tip This parameter is required only when you install the add-on in a serverless cluster.
Deployment mode	This parameter is displayed only for clusters for which the vci-virtual-kubelet add-on is installed. You can deploy the add-on on the following two types of nodes. Elastic Compute Service deployment: Deploys the add-on on ECS nodes in the cluster. VCI deployment: Deploys the add-on on VCIs. Additional fees will be incurred if you use VCI. For a detailed description of fees, see VCI service billing.
LogCollector Configuration	Configure the resource quotas of LogCollector. CPU request: The minimum CPU that a container requires. CPU limit: The maximum CPU that can be allocated to a container. Containers will be terminated if the actual usage exceeds the limit. Memory request: The minimum memory required by the container. Memory limit: The maximum memory value that a container is allowed to use. Containers will be terminated if the actual usage exceeds the limit. Pod scheduling based on taints and tolerations: After you enable this feature, you can set taint toleration values. The core workloads of LogCollector can be scheduled onto nodes with specified taints.
LogController Configuration	Configure the resource quotas of LogCollector Controller. Valid values: CPU request: The minimum CPU that a container requires. CPU limit: The maximum CPU that can be allocated to a container. Containers will be terminated if the actual usage exceeds the limit. Memory request: The minimum memory required by the container. Memory limit: The maximum memory value that a container is allowed to use. Containers will be terminated if the actual usage exceeds the limit. Pod scheduling based on taints and tolerations: After you enable this feature, you can set taint toleration values. The core workloads of LogCollector Controller can be scheduled onto nodes with specified taints.
Allow access to Secrets	Specify whether to create collection configurations by mounting Secrets as environment variables. For more details, see Collecting container logs (DaemonSet-Pod environment variables).

Click Confirm to finish configuration.

Upgrading add-ons

warning

Before upgrading the add-on, carefully read the add-on release notes, especially the mentioned impacts after changes. For example, after you upgrade versions earlier than v1.2.0, the key-value index fields of some logs will change. This may affect your existing log query and alert rules.

The add-on is released in new versions at irregular intervals to provide new features or fix known bugs. When the add-on card displays that a new version is available, we recommend upgrading the add-on promptly. To ensure a smooth business transition, we recommend upgrading the add-on during business off-peak hours. For upgrade procedures and considerations, see Upgrading add-ons.