采集自检工具使用指南
Download
聚焦模式
字号
在非 TKE 环境下使用 LogListener 日志采集自检工具
注意事项
操作系统：仅支持 Linux 系统。
运行权限：下载后需赋予执行权限，执行
chmod +x loglistener-check。前置条件：运行前请确保当前机器已安装并运行 LogListener，如未安装 LogListener，请参见 安装升级指南。工具需要读取 LogListener 的安装目录和配置文件，因此建议在 LogListener 所在的机器上直接运行。
网络要求：工具运行时需要访问 CLS 服务进行版本和配置校验，请确保机器网络可正常访问腾讯云相关域名。
下载工具
下载采集自检工具，下载地址：
https://mirrors.tencent.com/install/cls/loglistener-check/linux/loglistener-check开始使用
相关命令
Usage of ./loglistener-check:-h, --help help for loglistener--root_dir string (optional) install loglistener root dir (default is /usr/local/loglistener-*)--topic string (optional) topic ID
主要参数说明如下：
参数 | 类型 | 是否必填 | 说明 |
--root_dir | string | 否 | 指定 LogListener 安装根目录。默认值为 /usr/local/loglistener-*（工具会自动匹配该路径模式下的安装目录）。如果您通过自定义路径安装了 LogListener，请手动指定完整的安装路径。例如：使用默认路径安装了 LogListener 2.7.2版本，其根目录为 /usr/local/loglistener-2.7.2。 |
--topic | string | 否 | 若不指定此参数，工具将对该机器上所有关联的日志主题进行检查；指定后仅检查该 Topic 相关的采集配置，检查范围更加精确。 |
示例
使用检查工具，查看检查工具提示的问题，并基于提供的解决方案解决问题。例如，使用默认参数检查结果示例。
检查结果：
当前机器安装的 LogListener 版本过低，检查工具发现新版本，推荐用户升级，新版本修复了诸多问题并添加很多新特性。
inotify 参数设置不符合推荐值，建议用户修改，否则有可能会影响日志采集。
在 TKE 环境下使用 LogListener 日志采集自检工具
注意事项
操作系统：支持 Linux、macOS、Windows 系统。
运行权限：下载后需赋予执行权限，执行
chmod +x detect-tool。前置条件：运行前请确保已通过 kubectl 正常连接到目标 TKE 集群。工具依赖 kubeconfig 配置文件访问集群资源。
网络要求：工具运行时需要访问 Kubernetes API Server 和 CLS 服务，请确保运行环境网络通畅。
下载工具
根据您的操作系统，下载对应版本的采集自检工具：
Linux：
https://mirrors.tencent.com/install/cls/detect-tool/linux/detect-toolmacOS：
https://mirrors.tencent.com/install/cls/detect-tool/mac/detect-toolWindows：
https://mirrors.tencent.com/install/cls/detect-tool/windows/detect-tool开始使用
连接 TKE 集群
1. 登录 容器服务控制台。
2. 在左侧导航栏中，选择集群，进入集群管理页面。
3. 找到需要连接的集群，单击其 ID/名称，进入该集群管理页面。
4. 在左侧导航栏中，单击基本信息，进入基本信息页面。
5. 在集群 APIServer 信息栏中，按照 TKE 的指引，使用 kubectl 连接到 TKE 集群。具体操作可参见 配置 Kubeconfig。
相关命令
Usage of ./detect-tool:--kubeconfig string (optional) Path to a kubeconfig file, specifying how to connect to the API server. (default "/root/.kube/config")--logConfig string (optional) logconfig name--namespace string (optional) pod name namespace--pod string (optional) pod name--topic string (optional) topic id
主要参数说明如下：
参数 | 类型 | 是否必填 | 说明 |
--kubeconfig | string | 否 | 用于连接 Kubernetes 的配置文件路径。默认值为 /root/.kube/config。通常 kubectl 正常连接到集群后，无需特殊设置和指定。 |
--logConfig | string | 否 | 采集配置（LogConfig）名称，指定要检测的采集配置。可通过 kubectl get logconfigs 命令查看当前集群中的采集配置列表。 |
--pod | string | 否 | Pod 名称，指定需要检测的 Pod。若指定了 Pod，则必须同时指定 --namespace。 |
--namespace | string | 否 | 指定需要检测的 Pod 所在的 namespace。若指定了 namespace，则必须同时指定 --pod。 |
--topic | string | 否 | 指定需要检测的日志主题（Topic）ID，用于检查与该 Topic 关联的采集配置。一个集群可能会有多个采集配置关联到同一个 Topic。Topic ID 可在日志服务控制台获取，具体操作请参见 日志主题。 |
示例
使用检查工具，查看检查工具提示的问题，并基于提供的解决方案解决问题。
示例1：指定采集配置和 Pod 检查。
./detect-tool --logConfig=cls-log-config --pod=cls-provisioner-xxxxxxxxxxx --namespace=kube-system
示例2：指定 topic 检查。
./detect-tool --topic=1a2763e2-75f9-4a16-b921-1a80e3de7356
建议升级日志组件版本，当前集群不是最新的版本。
有两个采集配置关联了一个 topic，建议避免多个采集配置采集同一个文件。
文档反馈