LogListener 新架构安装升级指南

最近更新时间:2025-09-09 09:27:01

我的收藏
本文档介绍 LogListener 新架构(版本≥3.4.0)的安装和升级方法,所有操作统一通过 loglistener_operator 脚本完成,目前仅支持 Linux 版本。

准备工作

需先下载 loglistener_operator 脚本。
内网下载地址:
wget https://mirrors.tencentyun.com/install/cls/script/loglistener/loglistener_operator && chmod u+x loglistener_operator
公网下载地址:
wget https://mirrors.tencent.com/install/cls/script/loglistener/loglistener_operator && chmod u+x loglistener_operator

操作步骤

步骤1:安装 LogListener

使用 root 用户执行脚本,命令如下。
安装最新版本
安装指定版本
使用本地 package 安装
指定 URL 安装
./loglistener_operator install -s ${secret_id} -k ${secret_key} -r ${region}
./loglistener_operator install -s ${secret_id} -k ${secret_key} -r ${region} --version ${version}
注意:
该脚本只支持安装3.4.0以上版本的包。
./loglistener_operator install -s ${secret_id} -k ${secret_key} -r ${region} --package_path ${package_path}
./loglistener_operator install -s ${secret_id} -k ${secret_key} -r ${region} --url https://xxx.tar.gz
说明:
安装命令中 -secret_id-secret_key-region 为必填的参数,更多其他参数请见如下 参数说明
若主账号已授权协作者日志服务的读写权限,建议使用协作者密钥。
-region 为您所使用的日志服务区域,而非您的业务机器所处的区域。当您所使用的日志服务区域与您的业务机器所处的区域不一致时,请额外配置参数 -network 为 internet,即代表外网访问。
云服务器与日志集同地域的情况下,建议使用内网方式访问服务域名;云服务器与日志集在不同地域的情况下,建议使用外网方式访问服务域名。
关于日志采集权限详情,请参见 LogListener 日志采集权限
安装完成后返回结果如下:


参数说明

参数名
是否必填
描述
-s
云 API 密钥 的一部分,SecretId 用于标识 API 调用者身份。请确保云 API 密钥关联的账号具有相应的 LogListener 日志采集权限
-k
云 API 密钥 的一部分,SecretKey 是用于加密签名字符串和服务器端验证签名字符串的密钥。请确保云 API 密钥关联的账号具有相应的 LogListener 日志采集权限
-n
表示 LogListener 通过哪种方式访问服务域名,取值:internal内网访问(默认),internet 外网访问。
内网访问:适用于腾讯云服务器,且服务器所在地域与机器组一致。
外网访问:适用于非腾讯云服务器,或服务器所在地域与机器组不一致。
-r
region 表示日志服务所在的 地域,此处填写域名简称,例如 ap-beijing、ap-guangzhou 等。
注意:
当您所使用的日志服务区域与您的业务机器所处的区域不一致时,请配置参数 network 为 internet,即代表外网访问。
-d
表示日志服务所在地域的 域名。例如 ap-beijing.cls.tencentyun.com、ap-guangzhou.cls.tencentyun.com 等。
注意:
当您所使用的日志服务区域与您的业务机器所处的区域不一致时,请配置外网域名。例如 ap-beijing.cls.tencentcs.com。
-i
机器的 IP 地址,机器组可通过所配 IP 地址与该机器关联,详情请参见 机器组。若不填写,LogListener 会自动获取本机的 IP 地址。
-l
机器标识,填写后该机器将与同样带有所填机器标识的机器组关联,详情请参见 机器组。多个标识按逗号分隔。
注意:
若配置了机器标识, 该机器将只能通过机器标识与机器组关联, 无法通过 IP 进行关联;若不配置, 机器组只能通过 IP 关联该机器。
-p
端口,默认 80
-u
默认不上传机器标识到 CLS
--base_dir
LogListener 安装路径,默认安装在 /opt 目录下
--package_path
使用本地包安装时指定本地 package 的路径
--url
指定 URL 安装时使用,指定 mirrors 仓库的地址
--version
指定版本号安装,默认安装最新版本
注意:
更多细节可使用 ./loglistener_operator install --help 查看。


步骤2:启动 LogListener

systemctl start loglistener
执行 systemctl check loglistener 查看是否启动成功:


步骤3:加入机器组

完成 LogListener 安装并启动后,需在 日志服务控制台 创建或选择已有 机器组,并将服务器加入机器组中。您可通过以下两种方式将服务器加入机器组:

步骤4:采集日志

将服务器加入机器组后,即可 配置采集服务器上的文本日志

LogListener 常用操作

说明:
本文档示例的操作命令说明仅适用于 LogListener-3.4.0及以上版本。

查看 LogListener 版本

需要在 LogListener 的安装目录下(默认安装目录/opt/loglistener),执行如下命令即可查看版本。
./loglistener -v

查看 LogListener 帮助文档

需要在 LogListener 的安装目录下(默认安装目录/opt/loglistener),执行如下命令即可查看帮助说明。
./loglistener -h

停止 LogListener

systemctl stop loglistener

重启 LogListener

systemctl restart loglistener
执行 systemctl check loglistener 查看是否重启成功。

查看 LogListener 进程状态

systemctl status loglistener


检查 LogListener 心跳及配置

systemctl check loglistener

卸载 LogListener

1. 使用 停止命令systemctl stop loglistener停止运行旧版本的 LogListener。
systemctl stop loglistene
2. 需要在 loglistener 的安装目录下(默认安装目录/opt/loglistener),在/opt/loglistener/tools路径下在以管理员权限执行卸载命令:
./loglistener_operator uninstall

手动更新 LogListener

复用断点文件(不会重复采集日志)

1. 使用停止命令systemctl stop loglistener停止运行旧版本的 LogListener。
2. 以安装目录/opt/loglistener为例,前往安装目录下,备份旧版本中的断点文件目录./data。例如:将旧版的断点文件备份至/tmp/loglistener-backup目录下。
cp -r ./data /tmp/loglistener-backup/
3. 使用卸载命令 ./loglistener_operator uninstall卸载旧版本的 LogListener。
4. 重新下载安装最新版本的 LogListener。
5. 以安装目录/opt/loglistener,复制所备份的断点文件目录(步骤2)到新版本 LogListener 目录下。
cp -r /tmp/loglistener-backup/data ./
6. 使用启动命令systemctl start loglistener启动运行新版本 LogListener。

不复用断点文件(可能会重复采集日志)

1. 使用停止命令systemctl stop loglistener停止运行旧版本的 LogListener。
2. 使用 ./loglistener_operator uninstall卸载旧版本的 LogListener。
3. 重新下载安装最新版本的 LogListener。
4. 使用启动命令systemctl start loglistener启动运行新版本 LogListener。