tencent cloud

LogListener Configuration Guide
Last updated:2026-03-05 16:59:52
LogListener Configuration Guide
Last updated: 2026-03-05 16:59:52
Linux
Windows
Take the installation path /usr/local/ as an example. You can run the following command in the path /usr/local/loglistener/etc to view and configure the LogListener configuration file.
vim loglistener.conf
Parameter Description
Parameter Name
Parameter Description
Default Value
Value Range
proxy_host
Access domain name of the target CLS service.
If the region (-region) and private and public network access mode (-network) are specified during LogListener initialization, the default value of this parameter is the CLS private or public network domain name corresponding to the specified region.
If no region (-region) but a domain name (-domain) is specified during LogListener initialization, the default value of this parameter is the domain name.
For configuration details, see Available Regions.
secret_id
API key ID.
The default value of this parameter is the key ID specified during LogListener initialization.
Go to API Key Management to obtain the key ID.
secret_key
API key.
The default value of this parameter is the key specified during LogListener initialization.
Go to API Key Management to obtain the key.
encryption
Whether secret_id and secret_key need to be decrypted during CLS service access and authentication. To modify the key storage mode, see Encrypted Storage of Keys.
If encryption (which indicates whether to encrypt the storage key information) is specified to true during LogListener initialization, the default value of this parameter is true. Otherwise, the default value is false.
true and false
group_ip
IP address. A machine group can be associated with a machine by using the configured IP address. For details, see Machine Group.
The NIC IP address is automatically obtained by default. If an IP address is specified during LogListener initialization, the default value of this parameter is the IP address specified during initialization.
-
group_label
Machine ID. A machine group can be associated with a machine by using the configured machine ID. For details, see Machine Group. You can configure multiple machine IDs by separating them with commas.
Note:
Machines configured with machine IDs can only be associated with machine groups by using machine IDs, instead of IP addresses.
-
-
max_connection
Maximum number of concurrent log upload requests at a moment.
10
Integer greater than 0.
max_mem
Maximum memory usage (Byte).
2097152000
Integer greater than 0.
max_dir
Maximum number of listened directories.
Note:
This configuration is supported only in LogListener 2.8.8 or later.
5000
Integer greater than 0.
max_file
Maximum number of listened files.
15000
Integer greater than 0.
cpu_usage_thres
Maximum CPU usage (%) of a single core. 0 indicates no limit.
0
0-100
max_send_rate
Maximum upload rate (Byte/s). 0 indicates no limit.
0
Integer greater than 0.
max_depth
Maximum collection directory depth. When the collection path contains this kind of wildcard, this configuration can control the probe depth for the directory. 0 indicates no probing.
10
Integer greater than 0.
request_compression
Whether to compress logs to be uploaded.
true
true and false
replace_special_characters
Whether to replace special characters in the collected logs with spaces.
Note:
This configuration is supported only in LogListener 2.8.8 or later.
false
true and false
memory_tight_mode
Whether to enable the memory saving mode.
false
true and false
max_send_retrys
Maximum number of retries when the log upload request fails. 0 indicates continuous retries.
0
Integer greater than 0.
max_send_retry_time
Maximum timeout (s) when the log upload request fails and is retried.
10800
Integer greater than 0.
send_retry_period
Maximum retry interval (s) when the log upload request fails.
3
Integer greater than 0.
After the configuration modification is completed, run the following command to restart LogListener for the configuration modification to take effect.
Executed by systemd
Not Executed by systemd
This method is applicable when LogListener 2.8.3 or later is deployed and systemd is deployed in the operating system.
systemctl restart loglistenerd
Run /etc/init.d/loglistenerd check to check whether the restart is successful.



This method is applicable when LogListener earlier than 2.8.3 is deployed, or when LogListener 2.8.3 or later is deployed and systemd is deployed in the operating system.
/etc/init.d/loglistenerd restart
Run /etc/init.d/loglistenerd check to check whether the restart is successful.


B
Take the installation path C:\\Program Files (x86)\\Tencent\\LogListener as an example. Find LogListener.yaml in the installation directory and open it with any editor.



Parameter Description
Parameter Name
Parameter Description
Default Value
Value Range
host
Access domain name of the target CLS service.
If the region (region) and private and public network access mode (network) are specified during LogListener initialization, the default value of this parameter is the CLS private or public network domain name corresponding to the specified region.
If no region (region) but a domain name (endpoint) is specified during LogListener initialization, the default value of this parameter is the domain name.
For configuration details, see Available Regions.
agent_ip
IP address. A machine group can be associated with a machine by using the configured IP address. For details, see Machine Group.
The NIC IP address is automatically obtained by default. If an IP address is specified during LogListener initialization, the default value of this parameter is the IP address specified during initialization.
-
secret_id
API key ID.
The default value of this parameter is the key ID specified during LogListener initialization.
Go to API Key Management to obtain the key ID.
secret_key
API key.
The default value of this parameter is the key specified during LogListener initialization.
Go to API Key Management to obtain the key.
agent_labels
Machine ID. A machine group can be associated with a machine by using the configured machine ID. For details, see Machine Group. You can configure multiple machine IDs by separating them with commas.
Note:
Machines configured with machine IDs can only be associated with machine groups by using machine IDs, instead of IP addresses.
-
-
After the configuration modification is completed, run the following command to restart LogListener for the configuration modification to take effect. Run Windows PowerShell as an administrator, and run the following command in the installation path C:\\Program Files (x86)\\Tencent\\LogListener to restart LogListener.
.\\loglistener_daemon.exe -action restart

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback