一、安装环境
LogListener 仅支持64位 Windows Server 操作系统环境。
| LogListener 版本 | 操作系统类别 | 确定可安装环境 |
| v2.8.9及以上 | Windows Server | Windows Server 2012R2、Windows Server 2016、Windows Server 2019、Windows Server 2022、Windows Server 2025 |
二、网络与端口说明
LogListener 以客户端方式主动连接 CLS 服务端域名上报日志，默认使用 TCP 80（HTTP）；如启用 HTTPS 加密传输，则使用 TCP 443。本地源端口由操作系统从临时端口范围（ephemeral port）中自动分配，无需你手动固定或放通。
注意：说明：
注意：请确保服务器安全组/防火墙的出站规则允许访问 CLS 服务域名的 80/443 端口，否则日志将无法上报。在默认的标准文件采集场景下，LogListener 不会在本地监听任何固定端口，也不需要任何入站放通，因此不会与你服务器上的其他服务产生端口冲突。若你使用自监控指标、Syslog 数据接收等可选功能，相关本地端口的说明请参见对应功能文档。
三、支持功能
注意：仅2.9.7及以上版本 LogListener 支持采集 Windows 操作系统环境下的文本日志。
·采集文本日志
·采集 Windows 事件日志
四、1. 下载 LogListener 安装包
文本日志采集Windows 事件日志采集
注意：该安装包仅适用于 采集文本日志。
通过以下链接，下载并解压缩 LogListener 安装包：
·内网下载链接
·外网下载链接
注意：该安装包仅适用于 Windows 事件日志 采集。
通过以下链接，下载并解压缩 LogListener 安装包：
·内网下载链接
·外网下载链接
五、2. 安装 LogListener
以管理员身份运行 Windows PowerShell，在解压缩后的路径下，执行以下命令安装 LogListener。
·内网环境
.\\loglistener_installer.exe install –secret_id AKID******************************** –secret_key whHwQfjdLnzzCE1jIf09xxxxxxxxxxxx –region ap-xxxxxx –network intra
·外网环境
.\\loglistener_installer.exe install –secret_id AKID******************************** –secret_key whHwQfjdLnzzCE1jIf09xxxxxxxxxxxx –region ap-xxxxxx –network internet
注意：说明：
六、参数说明
| 参数名 | 是否必填 | 类型描述 |
| secret_id | 是 | 云 API 密钥 的一部分，SecretId 用于标识 API 调用者身份。请确保云 API 密钥关联的账号具有相应的 LogListener 日志采集权限。 |
| secret_key | 是 | 云 API 密钥 的一部分，SecretKey 是用于加密签名字符串和服务器端验证签名字符串的密钥。请确保云 API 密钥关联的账号具有相应的 LogListener 日志采集权限。 |
| encryption | 否 | 是否对云 API 密钥进行加密存储。若要对密钥进行加密，则入参 true；若不需要对密钥进行加密，则入参 false。详情请参见 密钥加密存储。（仅文本日志采集的 LogListener 2.9.7.13及以上版本支持） |
| network | 否 | 表示 LogListener 通过哪种方式访问 CLS 服务，取值：intra 内网访问，internet 外网访问。内网访问：适用于腾讯云服务器，且服务器所在地域与机器组一致。外网访问：适用于非腾讯云服务器，或服务器所在地域与机器组不一致。 |
| region | 若配置了 endpoint，该参数无需配置，否则必填 | region 表示日志服务所在的 地域，此处填写域名简称，例如 ap-beijing、ap-guangzhou 等。 |
| endpoint | 若配置了 region，该参数无需配置，否则必填 | endpoint 表示日志服务所在地域的 域名。例如 ap-beijing.cls.tencentyun.com、ap-guangzhou.cls.tencentyun.com 等。 |
| ip | 否 | 机器的 IP 地址，机器组可通过所配 IP 地址与该机器关联，详情可参见 机器组。若不填写，LogListener 会自动获取本机的 IP 地址。 |
| label | 否 | 机器标识，填写后该机器将与同样带有所填机器标识的机器组关联，详情可参见 机器组。多个标识按逗号分隔。注意：若配置了机器标识， 该机器将只能通过机器标识与机器组关联， 无法通过 IP 进行关联；若不配置， 机器组只能通过 IP 关联该机器。 |
| check_net | 否 | 是否在安装过程中执行网络连通性校验，默认取值 true。若入参 true，当网络异常时将安装失败。若不需要对网络环境进行校验，则入参 false。（Windows 事件采集不支持） |
| switch_endpoint | 否 | 启用备用域名。默认为 false，若入参为 true，当主域名网络失败后会使用备用域名。入参 true 后，配置文件新增 backup_endpoints 字段（备用域名），系统会主动填充备用域名。若用户初始化为内网访问，backup_endpoints 主动填充为公网。若用户初始化为公网访问，backup_endpoints 主动填充为内网。你也可以在配置文件中手动修改备用域名（支持填充多个）。若主域名无法访问，LogListener 会按照备用域名的顺序依次进行访问直至访问成功。注意：仅 Windows 版 LogListener ≥ 2.9.7.15版本支持该参数。 Windows 事件采集暂不支持该参数。 |
| dynamic_ip | 否 | 用于控制是否开启动态 IP 自动检测能力，默认为 false。若入参为 true，当 IP 发生变更时可实时更新（仅机器标识场景支持，通过 IP 地址关联的场景不支持该能力）。注意：仅 Windows 版 LogListener ≥ 2.9.7.17版本支持该参数。 Windows 事件采集暂不支持该参数。 |
| use_http | 否 | 用于控制是否使用 HTTP 访问 CLS。默认值为 true；如需使用 HTTPS，请设置为 –use_http=false。注意：仅 Windows 版 LogListener ≥ 2.9.7.17版本支持该参数。 Windows 事件采集暂不支持该参数。 |
| auth_mode | 否 | 鉴权方式。设置为 role 表示使用 CVM 实例绑定的 CAM Role 进行鉴权，LogListener 将通过 CVM 元数据服务获取临时访问凭证，无需填写 SecretId 和 SecretKey。注意：仅 Windows 版 LogListener ≥ 2.9.7.17版本支持该参数。 Windows 事件采集暂不支持该参数。 |
| role_name | 否 | CAM Role 名称。填写 CVM 实例实际绑定的 CAM Role 名称，并在名称前添加 custom-role- 前缀。例如，CVM 实例绑定的 CAM Role 名称为 CLSLogListenerRole 时，填写 custom-role-CLSLogListenerRole。注意：仅 Windows 版 LogListener ≥ 2.9.7.17版本支持该参数。 Windows 事件采集暂不支持该参数。 |
注意：更多细节可使用 ./loglistener_operator install –help 查看。
注意：
七、3. 加入机器组
注意：安装了 LogListener Windows 版的服务器只可以加入系统环境为 Windows 的机器组。
完成 LogListener 安装并启动后，需在 日志服务控制台 创建或选择已有 机器组，并将服务器加入机器组中。
你可通过以下两种方式将服务器加入机器组：
·通过关联机器 IP 地址创建机器组
·通过机器标识创建机器组
注意：Windows 机器组暂不支持开启服务日志，也不支持自动升级。
注意：
八、4. 采集日志
将服务器加入机器组后， 即可配置 采集 Windows 事件日志 或 采集文本日志。
九、查看 LogListener 版本
此处以安装路径 C:\\Program Files (x86)\\Tencent\\LogListener 为例，以管理员身份运行 Windows PowerShell，在安装路径下，执行以下命令查看 LogListener 版本：
.\\loglistener_work.exe -v
十、停止 LogListener
注意：执行停止 LogListener 命令时，请确保 LogListener 安装路径下的所有文件均处于关闭状态，否则将无法停止 LogListener。
此处以安装路径 C:\\Program Files (x86)\\Tencent\\LogListener 为例，以管理员身份运行 Windows PowerShell，在安装路径下，执行以下命令停止 LogListener：
.\\loglistener_daemon.exe -action stop
十一、重启 LogListener
注意：执行重启 LogListener 命令时，请确保 LogListener 安装路径下的所有文件均处于关闭状态，否则将无法重启 LogListener。
此处以安装路径 C:\\Program Files (x86)\\Tencent\\LogListener 为例，以管理员身份运行 Windows PowerShell，在安装路径下，执行以下命令重启 LogListener：
.\\loglistener_daemon.exe -action restart
十二、检查 LogListener 心跳及配置
此处以安装路径 C:\\Program Files (x86)\\Tencent\\LogListener 为例，以管理员身份运行 Windows PowerShell，在安装路径下，执行以下命令检查 LogListener 心跳及配置：
.\\loglistener_work.exe check
返回样例：
十三、卸载 LogListener
1. 使用 停止命令 停止 LogListener。
2. 以管理员身份运行 Windows PowerShell，在安装包路径下，执行以下命令卸载 LogListener：
.\\loglistener_installer.exe uninstall
十四、通过服务列表操作 LogListener
1. 单击左下角搜索，并搜索 service。
2. 在服务列表中，找到并单击 LogListener Daemon。你可以单击左侧的操作按钮，停止或重启 LogListener。
十五、配置 LogListener
请参见 LogListener 配置指南。