LogListener is a log collector provided by CLS. You can install and deploy it on a server to collect logs quickly.
Installation Environment
LogListener supports only Linux 64-bit operating systems and does not support Windows now. It is compatible with mainstream Linux operating system versions. If LogListener is incompatible with the Linux operating system version you use, submit a ticket for assistance.
Key features supported by different LogListener versions are as listed below. For more information, see LogListener Updates.
LogListener Version
Supported Feature
Feature Description
Documentation
v2.8.0
GBK encoding for collection; optimization of the escape character in JSON extraction mode
LogListener can collect GBK-encoded log text.
-
v2.7.4
Host name collection (hostname)
LogListener collects and reports the machine host name as a default field and displays __HOSTNAME__ as a key, such as __HOSTNAME__:VM-108-centos.
-
v2.6.4
Combined parsing to customize complex log parsing rules
You can use LogListener's combined parsing mode to parse logs. This mode allows you to enter JSON code in the console to customize the log parsing pipeline logic.
You can select CVM instances in the console and batch distribute LogListener deployment tasks through an API to automatically complete LogListener installation and deployment (including accesskey, ID, and region configuration).
LogListener service logs are used to record the operation, collection, and monitoring activities of LogListener, and you can configure visual graphs to display such log data.
Download links of the latest version LogListener: Download via public network, Download via private network.
Download the LogListener installation package and decompress it to the installation path (/usr/local/ in this example). Then, go to the LogListener directory /usr/local/loglistener/tools and run the installation command.
Note:
No version number extensions are added to the installation package of LogListener on v2.8.3 and later. The latest version will be installed with loglistener-linux-x64 by default. To install a specific version, specify the version number, for example, replace loglistener-linux-x64 with loglistener-linux-x64-2.8.0 to install the 2.8.0 version.
Operation command for the public network:
wget http://mirrors.tencent.com/install/cls/loglistener-linux-x64.tar.gz && tar zxvf loglistener-linux-x64.tar.gz -C /usr/local/ && cd /usr/local/loglistener/tools && ./loglistener.sh install
Operation command for the private network:
wget http://mirrors.tencentyun.com/install/cls/loglistener-linux-x64.tar.gz && tar zxvf loglistener-linux-x64.tar.gz -C /usr/local/ && cd /usr/local/loglistener/tools && ./loglistener.sh install
2. Initializing LogListener
In the case of the /usr/local/ installation path, go to the /usr/local/loglistener/tools path and run the following command to initialize LogListener as the root user (by default, the private network is used to access the service):
You need to replace -secretid, -secretkey, -region, and -network in the command with the actual values. For more information, please see Parameter description below.
Parameter description
Parameter
Description
secretid
Part of the Cloud API key. Used to identify who calls the API.
secretkey
Part of the Cloud API key. Used to encrypt signature strings and verify server-side signature strings.
region
Region where CLS resides. Enter a region abbreviation here, such as ap-beijing or ap-guangzhou.
network
Type of the network through which LogListener accesses the service by domain name. Valid values: intra (private network), internet (public network). Default value: intra
IP
Machine IP. If this parameter is left empty, LogListener will automatically get the local IP address.
label
Machine group label, which is required if you want to identify the machine group. Multiple labels should be separated by comma.
A private network domain name is used by default:
If you need to access the service by domain name through the public network, run the following command to set the network parameter internet explicitly:
./loglistener.sh init -secretid AKIDPEtPyKabfW8Z3Uspdz83xxxxxxxxxxxx -secretkey whHwQfjdLnzzCE1jIf0xxxxxxxxxxxx -region ap-xxxxxx -network internet
Note:
We recommend that you use a collaborator key if the collaborator has been assigned the CLS read/write permission by the root account.
region indicates the region of the CLS you use, instead of the region where your business machine resides.
If your CVM instance and logset are in the same region, we recommend you access the service domain name over the private network; otherwise, use the public network.
LogListener is on v2.8.3 or later and the operating system has systemd.
systemctl start loglistenerd
LogListener is earlier than v2.8.3, or LogListener is on v2.8.3 or later but the operating system does not have systemd.
/etc/init.d/loglistenerd start
Common LogListener Operations
Note:
The operation commands used in this document are applicable only to LogListener v2.2.4 and later versions. For operation commands applicable to earlier versions, see Earlier-Version LogListener Installation Guide.
1. Checking the LogListener version
/etc/init.d/loglistenerd -v
2. Viewing LogListener help documentation
/etc/init.d/loglistenerd -h
3. Managing LogListener process
LogListener is on v2.8.3 or later and the operating system has systemd.
5. Checking LogListener heartbeat and configuration
/etc/init.d/loglistenerd check
Uninstalling LogListener
In the case of the /usr/local/ installation path, go to the /usr/local/loglistener/tools path and run the uninstallation command as the admin:
./loglistener.sh uninstall
Manually Updating LogListener
Reusing the breakpoint file (logs are not repeatedly collected)
1. Run the stop command to stop the existing LogListener.
2. Back up the breakpoint file directory (loglistener/data) on the earlier version; for example, back up the legacy breakpoint file to the /tmp/loglistener-backup directory.
Yes
No
Was this page helpful?