Docs

Torch Log Service

Installation and upgrade

Install LogCollector (host machine)

LogCollector is the log collection client provided by torch log service (TLS). It can be used for fast log data reporting. After installing LogCollector on the server, you can set collection rules and access TLS quickly via the console or configuration files.

This topic explains how to install, upgrade, or uninstall LogCollector on a Linux server.

Notice

Starting from LogCollector v2.2.0, the systemd service name is changed from filebeatd to logcollectord.

Preparations

An available Linux server is required.

LogCollector currently supports only Linux x86-64 (64-bit) operating systems and does not support ARM architecture or Windows operating systems.

Systemd and wget are installed on the Linux server.

Actions in this topic require using a user with root permission to log in to the Linux server.

Based on the server type and region, determine the required network type for installing LogCollector.

The IAM user has been created and the Access Key ID and Secret Access Key have been obtained. Besides, the user is granted at least the TLSLogCollectorAccess permission policy. For details about permissions, see IAM overview.

Install and start

1 Download LogCollector installation script

Based on region and network type of Linux server, run the corresponding download command to download LogCollector install script to a custom directory.

We recommend that you use private network downloading address. This helps you save public network traffic costs.

You need to replace Region ID in the download address with the actual region ID for your environment. For example, the region ID for North China 2 (Beijing) is cn-beijing. For supported regions, see Service address.

Private network download address

wget https://logcollector-Region ID.tos-Region ID.ivolces.com/logcollector.sh -O logcollector.sh; sudo chmod 755 logcollector.sh

Public network download address

wget https://logcollector-Region ID.tos-Region ID.volces.com/logcollector.sh -O logcollector.sh; sudo chmod 755 logcollector.sh

2 Install and start LogCollector

Run the following command to install LogCollector. After installation, the LogCollector process starts automatically.

Notice

If LogCollector is already installed, running the following command will prompt do you want to continue the installation? (y/n):. If you want to set continue the installation as a default action, add --continue_installation true into the command.

If LogCollector is running, running the following command will prompt logcollectord is running, please stop logcollectord first. If you want to set continue the installation as a default action, add --directly_stop true into the command.

Among the parameters, region, endpoint, secret_id, and secret_key are required parameters. Details are as follows.

Parameters	Required	Example value	Description
region	Yes	cn-beijing	The region where the log project is located. For TLS region and corresponding ID, see Service address.
endpoint	Yes	https://tls-cn-beijing.ivolces.com	TLS connection domain, i.e., the service address. Log in to Torch Log Service console, and you can view the connection domain name on the project details page. For more details, see Service address.
secret_id	Yes	AK********	Access Key ID for the Volcengine account or IAM account. You can obtain the Access Key ID on Access Key Management on IAM.
secret_key	Yes	TUdZ********	Secret Access Key of VolcanoEngine main account or IAM user. You can obtain the Secret Access Key on Key management page on IAM.
label	NO (recommended to set)	http_module	Label identifier for LogCollector. If you need to add this LogCollector to a host group of host identification type, the label parameter must be set. When creating a host group of Host identification type, set Host identification as the label. For details, see Host group overview. You can configure multiple label identifiers; separate the identifiers by commas (,). Simultaneously setting ip and label is not supported.
ip	No	10.1.1.*	IP address of LogCollector If you need to add this LogCollector to a host group of IP address type, we recommend that you set the ip parameter. The LogCollector IP address will then be the specified IP address. If ip is not set, LogCollector will automatically obtain the IP address based on certain policies. You can check the IP address recorded in the ip field in the agent_info.json file under the installation path. For details about IP address retrieval strategies, see Set IP addresses for hosts or containers. Simultaneously setting ip and label is not supported.
memory	No	2G	Default memory threshold for LogCollector is 2G. If memory usage exceeds the limit, OOM Killer is triggered.
cpu	No	200%	The CPU threshold allowed for LogCollector is 200% by default.

3 View the LogCollector running status

Run the following command to check LogCollector status. If the returned Active shows active (running)…, LogCollector is installed successfully and running normally.

Related operations

1 Modify LogCollector configuration file

During LogCollector operation, to update authentication parameters such as secret_id and secret_key, or identification parameters like label, execute the following command to edit the LogCollector configuration file.

See above for details on parameters such as region, endpoint, secret_id, and secret_key.

2 View software version

Run the following command to view the current LogCollector version installed on your device.

3 Process management

Actions	Command
Check the running status of LogCollector	sudo systemctl status logcollectord.service
Start LogCollector	sudo systemctl start logcollectord.service
Stop LogCollector	sudo systemctl stop logcollectord.service
Restart LogCollector	sudo systemctl restart logcollectord.service

4 Uninstall LogCollector

Notice

If LogCollector is running, running the following command will prompt logcollectord is running, please stop logcollectord first. If you want to set continue the uninstallation as a default action, add --directly_stop true to the command.

Run the following command as administrator to uninstall LogCollector.

Last updated: 2026.09.11 11:02:36