TDengine 安装前检查工具 taosprecheck 详解环境预检命令、配置文件与全量检查项解析【免费下载链接】TDengineHigh-performance, scalable time-series database designed for Industrial IoT (IIoT) scenarios项目地址: https://gitcode.com/GitHub_Trending/tde/TDengineTDengine 的集群部署对操作系统的内核参数、网络、时区、安全策略等环境要素有明确依赖。本文以 TDengine 官方文档中的安装前检查工具taosprecheck为主体完整解析其命令行参数、配置文件的每个配置节、12 大类检查项的设计意图以及检查结果文件的产出与应用示例帮助你在一键安装 TDengine 之前系统性地消除环境隐患并将预检结果作为后续预配置taospreset与安装部署taosinstall的输入依据。一、背景与工具定位TDengine 的安装部署对环境系统有一定的依赖和要求安装部署前需要对环境进行安装前检查提前发现环境问题。taosprecheck就是 TDengine 巡检工具族中的“安装前检查”工具其定位是只检查、不改动——它按照配置文件描述的目标环境逐项核对节点的真实系统状态输出检查报告与配置建议供实施人员判断环境是否满足部署条件。在 TDengine 巡检工具族中各工具分工明确详见 巡检工具总览工具名称功能简介安装前检查taosprecheck部署前对 TDengine 安装部署的依赖环境进行安装前检查安装前配置taospreset部署前对 TDengine 安装部署的依赖环境进行安装前预配置安装部署taosinstall指定环境安装部署 TDengine例行巡检taosinspect基于 TDengine 环境进行例行巡检和告警基准性能测试taosperfTDengine 部署环境执行 IO 和网络的基准性能测试订阅服务功能测试taossubcribe订阅服务功能测试工具典型的落地流程是taosprecheck检查 → 人工确认报告 →taospreset预配置整改 →taosinstall安装部署。检查与预配置共用同一套节点配置文件检查项的判据即预配置的目标值二者天然衔接安装前预配置工具 taospreset。使用限制与支持范围根据 巡检工具文档 的说明使用该工具需要满足以下前提这些限制同样适用于taosprecheck版本范围巡检工具目前仅支持企业版用户暂不对社区版开放从仓库结构看README 中亦说明社区版构建不打包taosinspect等独立仓库提供的组件与“企业版配套交付”的定位一致。支持的平台Kylin V10、Ubuntu20.04.2、CentOS7.9、LinxOS6.0.99、openEuler23.09、Debian12。若在其它平台或版本上运行遇到问题需联系对接的交付人员。支持的 TDengine 版本3.1.x.x 及以上版本。运行前提条件运行工具需要 root 权限普通用户运行则需要 sudo 权限配置免密登录的环境运行工具的当前节点也需要配置自身免密运行环境 glibc 版本要求glibc 2.17 及以上x64 架构、glibc 2.27 及以上ARM 架构配置的 FQDN 和 IP 地址必须提前配置到/etc/hosts文件集群节点之间的 SSH 服务必须启用如果无法启用 SSH 服务则只能通过 local 模式在每个节点上单独运行工具。二、命令行用法与参数详解工具支持通过 help 参数查看支持的语法帮助输出如下usage: taosprecheck [-h] [--model {local,ssh}] [--config CONFIG] [--backend] [--result RESULT] [--version] [--log-level {debug,info}] Pre-check for Database installation optional arguments: -h, --help show this help message and exit --model {local,ssh}, -m {local,ssh} connection model, default: local --config CONFIG, -f CONFIG Full path of test config file --backend, -b Run process in backend. default: False --result RESULT, -r RESULT Result directory. default: ./ --version, -v Show version --log-level {debug,info}, -l {debug,info} Set log level, default: info (options: debug, info)各参数详细说明参数短选项说明model-m预配置工具运行模式分为 local 和 ssh。安装环境的多节点间支持 SSH 通信可选择 ssh 模式在任意节点上运行预配置工具会依次对所有节点环境完成预配置操作反之节点间不支持 SSH 通信时可选择 local 模式仅对工具运行所在机器完成预配置操作。默认为 local 模式config-f预配置工具加载的配置文件其具体配置方式详见下文“配置文件使用说明”章节。不配置 config 参数时配置文件默认路径为工具运行当前目录backend-b后台运行预配置工具默认为前台运行result-r安装前检查结果文档的输出路径。不配置 result 参数时默认路径为工具运行当前目录log-level-l输出日志级别目前支持 debug 和 info默认为 infoversion-v打印预配置工具版本信息从参数设计可以推断其工作方式-m ssh模式下工具会以配置文件中声明的所有节点为检查对象借助 SSH 通道逐一采集各节点的系统信息-m local模式则只检查运行工具的本机适用于节点间无法打通 SSH 的场景此时需要在每个节点分别执行再人工汇总多份报告。-b选项适合节点较多、单轮检查耗时较长的场景可挂到screen/tmux或 nohup 会话之外异步执行。三、配置文件使用说明taosprecheck的配置文件采用 INI 风格定义了“目标环境”的全部描述。工具会依据这份目标环境逐项核对节点现状。一个完整的配置示例如下保留官方文档原样# 安装部署 TDengine 的环境信息支持免密登录和 SSH 登录两种方式当环境配置了免密登录后可不用配置 password 信息 [test_env] # 节点间通过 SSH 协议访问 firstep192.168.0.1||fqdntdengine1||usernameroot||password123456||port22 secondep192.168.0.2||fqdntdengine2||usernameroot||password123456||port22 dnode3192.168.0.3||fqdntdengine3||usernameroot||username123456||port22 # 节点间配置免密登录 # firstep192.168.0.1||fqdntdengine1||usernameroot||port22 # secondep192.168.0.2||fqdntdengine2||usernameroot||port22 # dnode3192.168.0.3||fqdntdengine3||usernameroot||port22 # 系统时区工具会按照下面配置修改系统时区 [timezone] tzAsia/Shanghai # 系统服务状态工具会按照下面配置关闭对应的系统服务 [services] firewallinactive selinuxinactive # coredump 配置工具会按照下面配置 coredump 的生成路径 [coredump] kernel.core_pattern/data/taos/core/core-%%e-%%p # /etc/sysctl.conf 中系统参数工具会按照下面配置修改系统参数值 [sys_vars:/etc/sysctl.conf] fs.nr_open2147483584 fs.file-max2147483584 net.ipv4.ip_local_port_range10000 65534 # /etc/security/limits.conf 中系统参数工具会按照下面配置修改系统参数值 [sys_vars:/etc/security/limits.conf] * soft nproc65536 * soft nofile2147483584 * soft stack65536 * hard nproc65536 * hard nofile2147483584 * hard stack65536 root soft nproc65536 root soft nofile2147483584 root soft stack65536 root hard nproc65536 root hard nofile2147483584 root hard stack65536 # 预安装软件列表 [app_list] screen tmux gdb fio iperf iperf3 sysstat net-tools jansson snappy ntp chrony tree wget勘误提示官方示例中dnode3一行把password误写成了usernameusernameroot||username123456实际编写配置时应为password123456否则该节点的登录凭据无效。各配置节逐项说明1.[test_env]节点环境信息每行描述一个节点字段以||分隔ip||fqdn||username||password||port。支持两种认证方式SSH 口令登录填写password字段免密登录提前配置好 SSH 密钥后可以省略password字段如示例中被注释的部分。节点名firstep、secondep、dnode3等可自定义其 FQDN 会用于集群内部的域名寻址因此巡检工具文档要求所有 FQDN 和 IP 必须提前写入各节点的/etc/hosts。port为 SSH 端口默认 22若目标环境修改了 SSH 端口需如实填写。2.[timezone]系统时区tzAsia/Shanghai声明了集群统一的时区。时区一致性直接影响时序数据的写入、查询与流计算触发时间因此检查工具会核对各节点当前时区是否与该配置一致。3.[services]系统服务状态声明需要处于inactive状态的系统服务firewallinactive防火墙会拦截 6030TDengine 默认服务端口及节点间同步流量生产集群通常依赖统一安全组或独立防火墙策略管理网络故工具要求本地防火墙关闭并据此检查selinuxinactiveSELinux 的强制访问控制会干扰服务对数据目录、socket 的访问检查工具会确认其状态与配置一致。4.[coredump]coredump 路径kernel.core_pattern/data/taos/core/core-%%e-%%p指定了 core 文件的统一生成路径与命名格式%e为进程名、%p为进程号%%是转义后的字面量%。TDengine 出问题时 core 文件是排障的关键证据将 coredump 路径固定到独立数据盘既便于收集也避免 core 文件写满系统盘。检查项即核对各节点kernel.core_pattern是否已按该值配置。5.[sys_vars:/etc/sysctl.conf]内核参数fs.nr_open2147483584与fs.file-max2147483584将系统级文件描述符上限提升到约 21 亿量级。TDengine 的 taosd 进程需要维护大量文件句柄SMA/RDB 数据文件、WAL、网络 socket 等文件描述符不足会导致“too many open files”类故障这两项参数是高并发时序场景的基础保障net.ipv4.ip_local_port_range10000 65534扩大本地临时端口范围避免节点间大量长连接/短连接复用端口时出现端口耗尽。6.[sys_vars:/etc/security/limits.conf]用户级资源限制对*所有用户和root分别配置 soft/hard 三组上限nproc65536单用户可创建进程/线程数上限保证多节点、多进程组件运行不触及进程数天花板nofile2147483584单用户文件描述符上限与上面的fs.nr_open/fs.file-max配套避免“系统上限够、单用户被限住”的错配stack65536KB线程栈大小为深调用栈场景留足余量。检查工具会比对各节点实际limits.conf中的值是否与配置一致。7.[app_list]预安装软件列表screen、tmux、gdb、fio、iperf/iperf3、sysstat、net-tools、jansson、snappy、ntp、chrony、tree、wget等工具清单覆盖了部署交付screen/tmux/wget、故障排查gdb、性能诊断fio、iperf、sysstat、net-tools和时间同步ntp、chrony三类用途。检查时工具会核对这些软件是否已安装若已安装则记录其版本便于在报告里留档追溯。四、安装前检查范围全解taosprecheck共覆盖 12 大类检查项完整清单如下检查项目详细说明CPU 配置CPU 型号、核数内存配置物理内存和虚拟内存大小磁盘配置磁盘空间、磁盘类型、磁盘挂载信息、fsblk 信息和当前磁盘使用情况网络配置SSH 服务状态、22 端口是否可用和网络带宽系统配置系统名称、当前时区配置、防火墙和 SElinux 服务状态coredump 配置coredump 路径是否配置域名解析配置/etc/hosts文件是否包含安装 TDengine 集群所有节点的域名解析信息预安装软件指定的预装软件是否已安装若安装记录其版本SWAP 配置SWAP 状态和 SWAP 的当前配置KYSEC 配置KYSEC 服务是否关闭该项检查仅针对麒麟系统系统参数配置检查系统参数值是否与配置文件中指定系统参数的配置一致时间同步配置时间同步工具是否安装并计算各节点间的时间偏差精确到秒各类检查项背后的工程含义值得结合 TDengine 的部署形态理解CPU / 内存TDengine 作为内存与 CPU 密集型的时序引擎SMA 索引构建、压缩编码与查询执行都高度依赖这两项资源报告记录型号与容量后实施人员可据此判断资源配置是否匹配数据规模磁盘配置磁盘类型SSD/HDD、挂载点与 fsblk 信息决定了数据目录的落盘位置与可靠性磁盘使用情况则用于评估剩余容量能否承载预期写入量网络配置SSH 服务与 22 端口是ssh模式逐节点采集的前提网络带宽检查为集群节点间同步、跨节点查询提供容量基线该检查的基准带宽测试可与taosperf的 IO/网络基准性能测试互补系统配置系统名称、时区、防火墙与 SELinux 状态对应配置文件中的[timezone]与[services]节确保集群时区统一、网络策略不阻塞业务端口coredump / 系统参数 / SWAP分别对应[coredump]与两个[sys_vars:...]节以及交换分区的显式状态盘点时序库通常要求关闭或严格控制 SWAP防止数据页被换出造成毛刺域名解析集群以 FQDN 相互寻址/etc/hosts缺少任一节点条目都会导致 mnode/vnode 注册或同步失败因此单独列出KYSEC麒麟系统特有的安全模块与 SELinux 类似的强制访问控制框架仅在 Kylin 环境下生效时间同步时序数据库对节点间时钟一致性极其敏感——乱序写入、流计算窗口触发、集群仲裁都可能受时钟漂移影响因此工具不仅检查 ntp/chrony 是否安装还会计算各节点间的时间偏差并精确到秒给出可量化的结论。五、结果文件安装前检查工具运行后会在工具运行当前目录即--result指定目录下生成两个文件文件内容precheck_report.md检查结果逐节点、逐检查项的实际值与目标值对照precheck_advice.md基于检查结果给出的环境配置建议哪些项不符合目标环境、建议如何整改precheck_report.md回答“环境现在是什么状态”precheck_advice.md回答“离可部署还差什么”。建议将两份文件纳入交付文档前者作为部署前环境快照留档后者作为整改清单跟踪闭环。若使用-r指定了独立结果目录文件会生成在该目录下便于多轮检查的版本对比。六、应用示例在工具所在节点以 local 模式执行安装前检查默认模式、默认读取当前目录配置文件、结果输出到当前目录./taosprecheck以 SSH 模式在所有节点执行安装前检查./taosprecheck -m ssh指定配置文件并以 SSH 模式在所有节点执行安装前检查./taosprecheck -m ssh -f /path_to_file/precheck.cfg以 SSH 模式在所有节点执行安装前检查开启日志 debug 级别排查工具自身行为时使用./taosprecheck -m ssh -l debug将以上示例组合一个常见的企业级多节点交付检查流程是将precheck.cfg含[test_env]全部节点、[timezone]、[services]、[coredump]、两个[sys_vars:...]、[app_list]放到执行节点在任一节点执行./taosprecheck -m ssh -f precheck.cfg -r ./precheck_$(date %Y%m%d)得到precheck_report.md与precheck_advice.md按建议清单整改或由同族的 taospreset 按同一份配置文件自动完成时区、服务、sysctl、limits、coredump 等预配置复跑taosprecheck确认全部检查项通过再进入 安装部署工具 taosinstall 的部署阶段部署稳定后可周期性运行 例行巡检工具 taosinspect 保持环境健康。七、基于仓库的补充说明当前开源仓库仅包含该工具的用户文档中文文档 与 英文文档taosprecheck的可执行程序与实现源码未随开源仓库发布属于企业版配套交付物——这与 巡检工具总览 中“仅支持企业版用户”的声明一致。因此本文所有检查项、参数行为均以官方文档描述为准与taosprecheck同族的taospreset、taosinspect命令行结构高度同构均提供-m、-f、-b、-r、-v、-l等参数意味着同一份precheck.cfg可在预检与预配置之间直接复用降低了多阶段交付的配置维护成本若需要在社区版环境下做类似的环境自查可按本文“安装前检查范围”一节的清单手工核对各节点uname系统/内核、timedatectl时区、systemctl status firewalld/iptables与getenforce服务状态、cat /proc/sys/kernel/core_patterncoredump、sysctl fs.nr_open fs.file-max net.ipv4.ip_local_port_range、ulimit -n/-u/-slimits、/etc/hosts域名解析以及 ntp/chrony 的节点间时间差即可覆盖文档所列的大部分检查点。适用前提小结企业版用户、TDengine 3.1.x 及以上版本、root 或 sudo 权限、glibc 满足架构要求、FQDN 已写入/etc/hosts、节点间 SSH 可达否则用 local 模式逐节点执行——满足以上条件即可在 TDengine 集群正式部署前用taosprecheck完成一次系统化、可留档、可复跑的环境预检。【免费下载链接】TDengineHigh-performance, scalable time-series database designed for Industrial IoT (IIoT) scenarios项目地址: https://gitcode.com/GitHub_Trending/tde/TDengine创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
