管理指南

版本 2.9.15


文档贡献者须知:本文档每行格式化为 80 列,缩进使用偶数个空格,不使用制表符。请严格遵守这些规则,以便文档能够轻松地在任何地方打印。如果您添加章节,请更新下面的摘要以便于搜索。
1. 前提条件

2.

HAProxy 架构快速回顾

3.

启动 HAProxy

4.

停止和重启 HAProxy

5.

文件描述符限制

6.

内存管理

7.

CPU 使用率

8.

日志

9.

统计信息和监控
9.1.
9.2.
9.3.
9.4.
9.4.1.

10.

简化配置管理的技巧

11.

常见陷阱及避免方法

12.

调试和性能问题

13.

安全注意事项
本文档假设读者在类 UNIX 操作系统上拥有足够多的管理技能,日常使用 shell,并且熟悉 strace 和 tcpdump 等故障排除工具。
HAProxy 是一个多线程、事件驱动、非阻塞的守护进程。这意味着它使用事件多路复用调度其所有活动,而不是依赖系统在多个活动之间进行调度。在大多数情况下,它以单个进程运行,因此系统上“ps aux”的输出将只报告一个“haproxy”进程,除非正在进行软重载,并且有一个旧进程与新进程并行完成其工作。因此,使用 strace 实用程序跟踪其活动总是很容易的。为了根据可用处理器数量进行扩展,默认情况下 haproxy 将为每个允许运行的处理器启动一个工作线程。除非明确配置不同,否则传入流量会分散到所有这些线程上,所有线程都运行相同的事件循环。HAProxy 非常注重将线程间依赖关系限制在最低限度,以努力实现接近线性的可扩展性。这带来了一些影响,例如给定连接由单个线程服务。因此,为了使用所有可用的处理能力,需要至少有与线程数量一样多的连接,这几乎总是能够保证的。HAProxy 的设计是在启动期间将自身隔离到一个 chroot 监狱中,它无法在其中执行任何文件系统访问。它所依赖的库(例如:libc、libssl 等)也是如此。直接影响是,一个正在运行的进程将无法重新加载配置文件以应用更改,而是将使用更新的配置文件启动一个新进程。一些不太明显的影响是,libc 可能会在运行时尝试访问的某些时区文件或解析器文件将找不到,尽管这通常不应该发生,因为它们在启动后不再需要。这个原理的一个很好的结果是 HAProxy 进程是完全无状态的,并且在它被杀死后不需要进行任何清理,所以任何有效的杀死方法都会做正确的事情。HAProxy 不会写入日志文件,但它依赖标准的 syslog 协议将日志发送到远程服务器(通常位于同一系统上)。HAProxy 使用其内部时钟来强制执行超时,该时钟派生自系统时间,但会纠正意外漂移。这是通过限制在 poll() 中等待事件的时间并测量它实际花费的时间来完成的。实际上,它等待的时间从不超过一秒钟。这解释了为什么在对一个完全空闲的进程运行 strace 时,会注意到 poll()(或其任何变体)的定期调用被两个 gettimeofday() 调用包围。它们是正常的,完全无害的,而且开销很低,以至于它们所隐含的负载在系统规模上是完全检测不到的,因此没有什么不正常的。示例:16:35:40.002320 gettimeofday({1442759740, 2605}, NULL) = 0 16:35:40.002942 epoll_wait(0, {}, 200, 1000) = 0 16:35:41.007542 gettimeofday({1442759741, 7641}, NULL) = 0 16:35:41.007998 gettimeofday({1442759741, 8114}, NULL) = 0 16:35:41.008391 epoll_wait(0, {}, 200, 1000) = 0 16:35:42.011313 gettimeofday({1442759742, 11411}, NULL) = 0 HAProxy 是一个 TCP 代理,而不是路由器。它处理已由内核验证的已建立连接,而不是任何形式的数据包或处于其他状态的套接字(例如:没有 SYN_RECV 或 TIME_WAIT),尽管它们的存在可能会阻止它绑定端口。它依赖系统来接受传入连接并启动传出连接。由此产生的直接影响是,转发连接两侧观察到的数据包之间没有关系,它们的大小、数量甚至系列可能不同。由于连接只能从处于 LISTEN 状态的套接字接受,因此它正在侦听的所有套接字必然可以使用“netstat”实用程序显示正在侦听的套接字。示例:# netstat -ltnp Active Internet connections (only servers) Proto Recv-Q Send-Q Local Address Foreign Address State PID/Program name tcp 0 0 0.0.0.0:22 0.0.0.0:* LISTEN 1629/sshd tcp 0 0 0.0.0.0:80 0.0.0.0:* LISTEN 2847/haproxy tcp 0 0 0.0.0.0:443 0.0.0.0:* LISTEN 2847/haproxy
HAProxy 通过在命令行调用 "haproxy" 程序并带有一些参数来启动。实际语法是:$ haproxy [<options>]*
where [<options>]* 是任意数量的选项。选项始终以 "-" 开头
后面跟着一个或多个字母,并且可能后面跟着一个或多个额外的参数。如果没有选项,HAProxy 将显示帮助页面以及支持选项的提醒。可用选项可能会根据操作系统略有不同。其中相当一部分选项与“global”部分中的等效选项重叠。在这种情况下,命令行始终优先于配置文件,因此命令行可用于快速强制执行某些设置,而无需触动配置文件。当前选项列表为: -- <cfgfile>* : 跟在 "--" 后面的所有参数都是配置文件的路径/要加载和按声明顺序处理的目录。当依赖 shell 加载许多按数字排序的文件时,它最有用。另请参阅 "-f"。 "--" 和 "-f" 之间的区别在于,每个文件名之前必须放置一个 "-f",而所有文件名之前只需要一个 "--"。两个选项可以一起使用,命令行顺序仍然适用。当指定多个文件时,每个文件必须以节边界开头,因此每个文件的第一个关键字必须是“global”、“defaults”、“peers”、“listen”、“frontend”、“backend”等之一。例如,文件不能只包含服务器列表。 -f <cfgfile|cfgdir> : 将 <cfgfile> 添加到要加载的配置文件列表。如果 <cfgdir> 是一个目录,它包含的所有文件(且仅限文件)将按词法顺序(使用 LC_COLLATE=C)添加到要加载的配置文件列表;只添加扩展名为“.cfg”的文件,只添加非隐藏文件(不以“.”开头的文件)。配置文件按其声明顺序加载和处理。此选项可以指定多次以加载多个文件。另请参阅 "--"。 "--" 和 "-f" 之间的区别在于,每个文件名之前必须放置一个 "-f",而所有文件名之前只需要一个 "--"。两个选项可以一起使用,命令行顺序仍然适用。当指定多个文件时,每个文件必须以节边界开头,因此每个文件的第一个关键字必须是“global”、“defaults”、“peers”、“listen”、“frontend”、“backend”等之一。例如,文件不能只包含服务器列表。 -C <dir> : 在加载配置文件之前更改到目录 <dir>。这在使用相对路径时很有用。当在 "--" 之后使用通配符时要小心,因为它们实际上是在 haproxy 启动之前被 shell 替换的。 -D : 作为守护进程启动。进程在分叉后与当前终端分离,并且不再在终端中报告错误。它等同于配置的“global”部分中的“daemon”关键字。建议始终在任何 init 脚本中强制使用它,以便错误的配置不会阻止系统启动。 -L <name> : 将本地对等体名称更改为 <name>,默认为本地主机名。这仅用于对等体复制。您可以在配置文件中使用变量 $HAPROXY_LOCALPEER 来引用对等体名称。 -N <limit> : 将每个代理的默认 maxconn 设置为 <limit>,而不是内置默认值(通常为 2000)。仅用于调试。 -V : 启用详细模式(禁用安静模式)。恢复 "-q" 或 "quiet" 的效果。 -W : master-worker 模式。它等同于配置的“global”部分中的“master-worker”关键字。此模式将启动一个“master”来监控“workers”。使用此模式,您可以通过向 master 发送 SIGUSR2 信号来直接重载 HAProxy。master-worker 模式与前台或守护进程模式兼容。建议在多进程和 systemd 中使用此模式。 -Ws : master-worker 模式,支持 `notify` 类型的 systemd 服务。此选项仅在 HAProxy 使用 `USE_SYSTEMD` 构建选项构建时可用。 -c : 只执行配置文件的检查并在尝试绑定之前退出。如果一切正常,退出状态为零,如果遇到错误,则为非零。如果存在任何警告,将报告警告。 -cc : 评估配置条件块中使用的条件。如果条件为 true,退出状态为零,如果条件为 false,则为 1,如果遇到错误,则为 2。 -d : 启用调试模式。这会禁用守护进程模式,强制进程保持在前台并显示传入和传出事件。它绝不能用于 init 脚本中。 -dC[key] : 转储配置文件。它在行被标记化之后执行,因此注释被剥离并且强制缩进。如果指定了非零密钥,则在敏感/机密字段之前截断行,并且使用与 CLI 上匿名模式使用的相同算法对标识符和地址进行哈希处理。这意味着输出可以安全地与需要它的开发人员共享,以便找出使用相同密钥匿名的转储中发生的情况。另请参阅 CLI 的 "set anon" 命令。 -dD : 启用诊断模式。此模式将输出有关可疑配置语句的额外警告。即使在“零警告”模式下,这也不会阻止启动,也不会更改退出状态代码。 -dF : 禁用数据快速转发。它是一种优化数据转发的机制,通过将数据直接从一侧传递到另一侧,而无需唤醒流。通过此指令,可以禁用此优化。请注意,它也会禁用任何内核 tcp splicing。此命令不适用于常规使用,通常只有开发人员在复杂的调试会话中才会建议使用它。 -dG : 禁用使用 getaddrinfo() 将主机名解析为地址。当怀疑 getaddrinfo() 无法按预期工作时可以使用它。提供此选项是因为 getaddrinfo() 的许多错误实现在各种系统上都存在并导致难以排除故障的异常。 -dK<class[,class]*> : 转储每个类中注册的关键字列表。类列表可通过 "-dKhelp" 获得。可以使用 "-dKall" 转储所有类,否则可以指定帮助中显示的那些类的选择作为逗号分隔列表。输出格式将根据要转储的关键字类别而有所不同(例如,“cfg”将以类似于配置文件格式的格式显示已知的配置关键字,而“smp”将显示以兼容性矩阵为前缀的样本获取函数,其中包含每个规则集)。人类很少按原样使用这些,但对于试图检测新关键字在某些地方出现以自动更新某些文档、语法高亮文件、配置解析器、API 等的外部工具来说,它们可能非常有用。输出格式可能会随着时间的推移而有所演变,因此强烈建议主要使用此输出来检测与先前存档的差异。请注意,并非所有关键字都已列出,因为许多关键字在不同的关键字注册子系统创建之前就已经存在,并且它们没有出现在那里。然而,由于新关键字仅通过现代机制添加,因此可以合理地假设此输出可用于以高准确度检测语言添加。关键字仅在配置完全解析后才会转储,以便甚至可以转储动态创建的关键字。转储和退出的好方法是在现有配置上运行静默配置检查:./haproxy -dKall -q -c -f foo.cfg 如果没有配置文件可用,使用 "-f /dev/null" 也可以转储所有默认关键字,但随后返回状态将不为零,因为没有侦听器,并且必须忽略它。 -dL : 转储在配置处理结束时加载的动态共享库列表。这通常还包括深层依赖项,例如从 Lua 代码加载的任何内容,以及可执行文件本身。列表以一种格式打印,应该足够容易清理,以直接生成所有依赖项的 tarball。由于它不会停止程序的启动,因此建议仅将其与 "-c" 和 "-q" 结合使用,其中只显示已加载对象的列表(如果出错则不显示任何内容)。此外,请记住,在提供此类包以帮助分析核心文件时,大多数库实际上是符号链接,在创建存档时需要取消引用:./haproxy -W -q -c -dL -f foo.cfg | tar -T - -hzcf archive.tgz 在详细模式 (-V) 下启动时,还会枚举共享库的地址范围,除非使用安静模式 (-q)。 -dM[<byte>[,]][help|options,...] : 强制内存中毒,和/或更改内存其他调试选项。内存中毒意味着使用 malloc() 或 pool_alloc() 分配的每个内存区域在传递给调用者之前都会用 <byte> 填充。当未指定 <byte> 时,默认为 0x50 ('P')。虽然这会稍微降低操作速度,但它对于可靠地触发由于代码中缺少初始化而导致随机崩溃的问题很有用。请注意,-dM0 的效果是将任何 malloc() 变成 calloc()。无论如何,如果使用此选项时出现或消失了错误,则意味着 haproxy 中存在错误,因此请报告它。许多其他选项可单独使用或跟在字节后面的逗号之后使用。特殊选项 "help" 将列出当前支持的选项及其当前值。每个调试选项都可以强制打开或关闭。通常在构建时根据操作系统选择最优化选项,无需调整,除非开发人员建议。支持的调试选项包括(设置/清除): - fail / no-fail: 这会启用随机失败的内存分配,与全局 "tune.fail-alloc" 设置结合使用。这用于检测代码中缺少的错误检查。设置此选项会将比率预设为 1% 的失败率。 - no-merge / merge: 默认情况下,大小非常相似的池会合并,从而提高效率,但这会使某些内存转储的分析复杂化。此选项允许禁用此机制,并可能稍微增加内存使用量。 - cold-first / hot-first: 为了优化 CPU 缓存命中率,默认情况下,最近释放的对象(“hot”)会被回收用于新分配。但这样做也会使内存转储分析复杂化,并可能隐藏 use-after-free 错误。此选项允许改为首先选择最冷的对象,这可能会导致 CPU 使用率略有增加。 - integrity / no-integrity: 启用此选项后,将对分配的区域启用内存完整性检查,以验证自上次释放以来它是否未被修改。这与 "no-merge"、"cold-first" 和 "tag" 配合使用效果最佳。启用此选项会稍微增加 CPU 使用率。 - no-global / global: 根据操作系统,如果估计标准分配器对于线程来说太慢或效率低下,则可能会启用进程范围的全局内存缓存。此选项允许强制禁用或启用它。禁用它可能会导致效率低下的分配器增加 CPU 使用率。启用它可能会导致效率高的分配器增加内存使用量。 - no-cache / cache: 每个线程都使用非常快的本地对象缓存进行分配,默认情况下始终启用。此选项允许禁用它。由于全局缓存也通过本地缓存,这将有效地禁用所有缓存并直接从默认分配器分配。这可能会导致 CPU 使用率显着增加,但也可能会在微小系统上节省少量内存。 - caller / no-caller: 启用此选项会在每个分配的对象中保留一些额外空间,以存储分配或释放它的最后一个调用者的地址。这有助于开发人员在分析内存转储时回溯时间并猜测意外情况是如何发生的。 - tag / no-tag: 启用此选项会在每个分配的对象中保留一些额外空间,以存储一个标签,该标签允许检测诸如双重释放、释放无效对象和缓冲区溢出等错误。它提供了更强的可靠性保证,但代价是每次分配额外增加 4 或 8 个字节。它通常是检测内存损坏的第一步。 - poison / no-poison: 启用此选项将用固定模式填充分配的对象,这将确保如果新添加的字段被初始化例程错误地遗忘,则不会出现某些意外值(例如 0)。此类错误很少重现,尤其是当池未合并时。通常通过直接将字节值传递给 -dM 来启用此功能,但使用此选项允许禁用/启用使用先前设置的值。 -dR : 禁用侦听端口上的 SO_REUSEPORT 套接字选项。它等同于“global”部分的“noreuseport”关键字。这可以应用于多线程场景,当在 haproxy 线程之间观察到负载分布问题时(可以使用 top 进行监控)。 -dS : 禁用使用 splice() 系统调用。它等同于“global”部分的“nosplice”关键字。当怀疑 splice() 行为不当或导致性能问题时,或者在使用 strace 查看转发数据时(当使用 splice() 时不会出现)可以使用此选项。 -dV : 禁用服务器端的 SSL 验证。它等同于在“global”部分中设置“ssl-server-verify none”。这在尝试在生产环境之外重现生产问题时很有用。切勿在 init 脚本中使用此选项,因为它会降低服务器的 SSL 安全性。 -dW : 如果设置,haproxy 将在处理配置时发出任何警告时拒绝启动。这有助于检测细微错误并保持配置的干净和跨版本可移植性。建议在配置由人工管理时在服务脚本中设置此选项,但不建议将其用于生成的配置,因为后者往往会发出更多警告。它可以与 "-c" 结合使用,以使检查的配置中的警告失败。这等同于全局选项“zero-warning”。 -dZ : 禁用“零拷贝”模式下的数据转发。它等同于“global”部分的“tune.disable-zero-copy-forwarding”关键字。这在数据丢失或数据完整性问题的情况下可能会有所帮助,或者在使用 strace 查看转发数据时有所帮助,因为它也会禁用任何内核 tcp splicing。 -db : 禁用后台模式和多进程模式。进程保持在前台。它主要用于开发或小型测试期间,因为 Ctrl-C 足以停止进程。切勿在 init 脚本中使用它。 -de : 禁用使用 "epoll" 轮询器。它等同于“global”部分的关键字“noepoll”。它主要在怀疑与此轮询器相关的错误时有用。在支持 epoll 的系统上,回退通常是“poll”轮询器。 -dk : 禁用使用 "kqueue" 轮询器。它等同于“global”部分的关键字“nokqueue”。它主要在怀疑与此轮询器相关的错误时有用。在支持 kqueue 的系统上,回退通常是“poll”轮询器。 -dp : 禁用使用 "poll" 轮询器。它等同于“global”部分的关键字“nopoll”。它主要在怀疑与此轮询器相关的错误时有用。在支持 poll 的系统上,回退通常是“select”轮询器,它无法禁用,并且仅限于 1024 个文件描述符。 -dr : 忽略服务器地址解析失败。当在生产环境之外验证配置时,无法访问相同的解析器并导致服务器地址解析失败是很常见的,这使得测试配置变得困难。此选项只是将“none”方法附加到所有服务器的地址解析方法列表,确保即使 libc 无法解析地址,启动序列也不会中断。 -dt [<trace_desc>,...] : 在 stderr 上激活跟踪。不带参数时,这会在错误级别启用所有跟踪源。这对于检测来自客户端或服务器的协议违规特别有用。可选参数可用于指定各种跟踪配置列表,使用“,”作为分隔符。每个元素激活一个或所有跟踪源。此外,可以使用“:”作为内部分隔符来可选地指定每个元素的级别和详细程度。 -dv : 禁用使用 "evports" 轮询器。它等同于“global”部分的关键字“noevports”。它主要在怀疑与此轮询器相关的错误时有用。在支持事件端口的系统上(源自 Solaris 10 及更高版本的 SunOS),回退通常是“poll”轮询器。 -m <limit> : 将所有进程的总可分配内存限制为 <limit> 兆字节。这可能会导致一些连接拒绝或一些减速,具体取决于正常操作所需的内存量。这主要用于强制进程在受限资源使用场景中工作。重要的是要注意,内存在进程之间不共享,因此在多进程场景中,此值在分叉之前首先除以 global.nbproc。 -n <limit> : 将每个进程的连接限制限制为 <limit>。这等同于全局部分的关键字“maxconn”。它优先于此关键字。这可用于快速强制降低限制,以避免在资源限制过低的系统上发生服务中断。 -p <file> : 在启动期间将所有进程的 pid 写入 <file>。这等同于“global”部分的关键字“pidfile”。该文件在进入 chroot 监狱之前打开,并在执行 "-C" 所隐含的 chdir() 之后打开。每个 pid 出现在它自己的行上。 -q : 设置“quiet”模式。这会禁用输出消息。它可以与 "-c" 结合使用,以仅检查配置文件是否有效。 -S <bind>[,bind_options...]: 在 master-worker 模式下,绑定 master CLI,它允许访问每个进程,无论正在运行还是即将离开。出于安全原因,建议将 master CLI 绑定到本地 UNIX 套接字。绑定选项与配置文件中的关键字“bind”相同,单词之间用逗号而不是空格分隔。请注意,此套接字不能用于在无缝重载期间从旧进程检索侦听套接字。 -sf <pid>* : 在启动完成后向旧进程发送“finish”信号 (SIGUSR1),要求它们完成正在做的事情并离开。<pid> 是要发出信号的 pid 列表(每个参数一个)。列表以任何以“-”开头的选项结束。如果 pid 列表为空,则没有问题,因此可以根据“pidof”或“pgrep”之类的命令的结果即时构建它。 -st <pid>* : 在启动完成后向旧进程发送“terminate”信号 (SIGTERM),立即终止它们,而无需完成正在做的事情。<pid> 是要发出信号的 pid 列表(每个参数一个)。列表以任何以“-”开头的选项结束。如果 pid 列表为空,则没有问题,因此可以根据“pidof”或“pgrep”之类的命令的结果即时构建它。 -v : 报告版本和构建日期。 -vv : 显示版本、构建选项、库版本和可用的轮询器。在提交错误报告时,系统地要求提供此输出。 -x <unix_socket> : 连接到指定的套接字并尝试从旧进程检索任何侦听套接字,并使用它们而不是尝试绑定新套接字。这在 Linux 上重新加载配置时避免丢失任何新连接很有用。如果没有 master-worker 模式,必须使用配置中的 "expose-fd listeners" 在 stats 套接字上启用该功能。在 master-worker 模式下,不需要 "expose-fd listeners",master 将在重载时自动使用此选项和 "sockpair@" 语法,这允许 master 直接连接到 worker,而无需使用配置中声明的任何 stats 套接字。如果您想禁用此功能,可以传递 -x /dev/null。从 init 文件启动 HAProxy 的安全方法包括强制使用守护进程模式,将现有 pid 存储到 pid 文件中,并使用此 pid 文件通知旧进程在离开之前完成:haproxy -f /etc/haproxy.cfg \ -D -p /var/run/haproxy.pid -sf $(cat /var/run/haproxy.pid) 当配置被拆分为几个特定文件(例如:tcp vs http)时,建议使用“-f”选项:haproxy -f /etc/haproxy/global.cfg -f /etc/haproxy/stats.cfg \ -f /etc/haproxy/default-tcp.cfg -f /etc/haproxy/tcp.cfg \ -f /etc/haproxy/default-http.cfg -f /etc/haproxy/http.cfg \ -D -p /var/run/haproxy.pid -sf $(cat /var/run/haproxy.pid) 当预期有未知数量的文件(例如客户特定文件)时,建议为它们分配一个以固定大小序列号开头的名称,并使用 "--" 加载它们,可能在加载一些默认值之后:haproxy -f /etc/haproxy/global.cfg -f /etc/haproxy/stats.cfg \ -f /etc/haproxy/default-tcp.cfg -f /etc/haproxy/tcp.cfg \ -f /etc/haproxy/default-http.cfg -f /etc/haproxy/http.cfg \ -D -p /var/run/haproxy.pid -sf $(cat /var/run/haproxy.pid) \ -f /etc/haproxy/default-customers.cfg -- /etc/haproxy/customers/* 有时可能会因任何原因导致启动失败。然后重要的是验证您正在调用的 HAProxy 版本是否是预期的版本,以及它是否支持您期望的功能(例如:SSL、PCRE、压缩、Lua 等)。这可以使用 "haproxy -vv" 进行验证。某些重要信息(例如某些构建选项、目标系统和正在使用的库版本)会在其中报告。这也是您在发布错误报告时会被系统性要求提供的内容:$ haproxy -vv HAProxy version 1.6-dev7-a088d3-4 2015/10/08 Copyright 2000-2015 Willy Tarreau <willy@haproxy.org> Build options : TARGET = linux2628 CPU = generic CC = gcc CFLAGS = -pg -O0 -g -fno-strict-aliasing -Wdeclaration-after-statement \ -DBUFSIZE=8030 -DMAXREWRITE=1030 -DSO_MARK=36 -DTCP_REPAIR=19 OPTIONS = USE_ZLIB=1 USE_DLMALLOC=1 USE_OPENSSL=1 USE_LUA=1 USE_PCRE=1 Default settings : maxconn = 2000, bufsize = 8030, maxrewrite = 1030, maxpollevents = 200 Encrypted password support via crypt(3): yes Built with zlib version : 1.2.6 Compression algorithms supported : identity("identity"), deflate("deflate"), \ raw-deflate("deflate"), gzip("gzip") Built with OpenSSL version : OpenSSL 1.0.1o 12 Jun 2015 Running on OpenSSL version : OpenSSL 1.0.1o 12 Jun 2015 OpenSSL library supports TLS extensions : yes OpenSSL library supports SNI : yes OpenSSL library supports prefer-server-ciphers : yes Built with PCRE version : 8.12 2011-01-15 PCRE library supports JIT : no (USE_PCRE_JIT not set) Built with Lua version : Lua 5.3.1 Built with transparent proxy support using: IP_TRANSPARENT IP_FREEBIND Available polling systems : epoll : pref=300, test result OK poll : pref=200, test result OK select : pref=150, test result OK Total: 3 (3 usable), will use epoll. 许多非开发人员用户可以在此处验证的相关信息是: - 版本:上面的 1.6-dev7-a088d3-4 表示代码当前处于提交 ID "a088d3",这是在官方版本 "1.6-dev7" 之后的第 4 个。版本 1.6-dev7 将显示为 "1.6-dev7-8c1ad7"。这里重要的是 "1.6-dev7"。这是未来版本 1.6 的第 7 个开发版本。开发版本不适合在生产中使用(除非您确切知道自己在做什么)。稳定版本将显示为 3 个数字的版本,例如 "1.5.14-16f863",表示在版本 1.5 之上修复的第 14 级。这是一个可用于生产的版本。 - 发布日期:2015/10/08。它以通用的年/月/日格式表示。这里的意思是 2015 年 8 月 8 日。鉴于稳定版本每隔几个月发布一次(开始时 1-2 个月,一旦产品非常稳定,有时会是 6 个月),如果您在这里看到一个旧日期,则意味着您可能受到许多此后已修复的错误或安全问题的影响,因此可能值得在官方网站上查看。 - 构建选项:它们与自己构建软件包的人相关,它们可以解释为什么事情没有按预期运行。例如,上面的开发版本是为 Linux 2.6.28 或更高版本构建的,目标是通用 CPU(没有特定于 CPU 的优化),并且缺少任何代码优化(-O0),因此其性能会很差。 - 库版本:zlib 版本是根据库本身找到的报告的。通常 zlib 被认为是一个非常稳定的产品,几乎从不需要升级。OpenSSL 报告了两个版本,构建时使用的版本和正在使用的版本,如系统上找到的那样。这些版本可能在最后一个字母上有所不同,但在数字上永远不会不同。构建日期也会报告,因为大多数 OpenSSL 错误都是安全问题,需要认真对待,因此此库绝对需要保持最新。在这里看到一个 4 个月大的版本是非常可疑的,确实错过了一个更新。PCRE 提供非常快的正则表达式,强烈推荐。它的某些扩展(例如 JIT)并非在所有版本中都存在,而且还很年轻,因此有些人更喜欢不使用它们构建,这也是报告构建状态的原因。关于 Lua 脚本语言,HAProxy 期望版本 5.3,它非常年轻,因为它是 HAProxy 1.6 之前不久发布的。在 Lua 网站上检查是否为此分支提出了某些修复非常重要。 - 可用的轮询系统将影响处理超过大约一千个并发连接时进程的可扩展性。只有在构建期间在 TARGET 变量中指示了正确的系统时,这些才可用。强烈建议在 Linux 上使用 "epoll" 机制,强烈建议在 BSD 上使用 kqueue 机制。缺少它们将导致使用 poll() 甚至 select(),从而在处理大量连接时导致高 CPU 使用率。
HAProxy 支持平稳停止和硬停止。硬停止很简单,当 SIGTERM 信号发送到 haproxy 进程时,它会立即退出,并且所有已建立的连接都会关闭。平稳停止是在 SIGUSR1 信号发送到 haproxy 进程时触发的。它包括仅解除绑定侦听端口,但继续处理现有连接直到它们关闭。一旦最后一个连接关闭,进程就会退出。硬停止方法用于服务管理脚本的“stop”或“restart”操作。平稳停止用于“reload”操作,该操作会尝试在新进程中无缝重载新配置。这些信号中的任何一个都可以在重载或重新启动期间由新的 haproxy 进程本身发送,以便在最晚可能的时刻发送它们,并且只有在绝对需要时才发送。这就是“-st”(硬)和“-sf”(平稳)选项分别执行的操作。在 master-worker 模式下,不需要启动新的 haproxy 进程来重新加载配置。master 进程通过重新执行自身并带有 -sf 参数,后跟 worker 的 PIDs 来响应 SIGUSR2 信号。master 将解析配置文件并分叉新的 workers。为了更好地理解如何使用这些信号,重要的是要了解整个重新启动机制。首先,一个现有的 haproxy 进程正在运行。管理员使用系统特定命令(例如 "/etc/init.d/haproxy reload")来指示他们想要使新的配置文件生效。接下来发生的是以下情况。首先,服务脚本(/etc/init.d/haproxy 或等效脚本)将使用 "haproxy -c" 验证配置文件是否正确解析。之后,它将尝试使用此配置文件启动 haproxy,使用 "-st" 或 "-sf"。然后 HAProxy 尝试绑定到所有侦听端口。如果发生一些致命错误(例如:系统上不存在地址、权限被拒绝),进程会因错误而退出。如果套接字绑定失败,因为端口已被使用,则进程将首先向 "-st" 或 "-sf" pid 列表中指定的所有 pid 发送 SIGTTOU 信号。这就是所谓的“暂停”信号。它指示所有现有的 haproxy 进程暂时停止侦听它们的端口,以便新进程可以尝试再次绑定。在此期间,旧进程继续处理现有连接。如果绑定仍然失败(例如,因为端口与另一个守护程序共享),则新进程会向旧进程发送 SIGTTIN 信号,指示它们恢复操作,就像什么都没发生一样。旧进程将重新开始侦听端口并继续接受连接。请注意,此机制取决于系统,某些操作系统可能不支持多进程模式。如果新进程设法正确绑定到所有端口,则它会向所有进程发送 SIGTERM(在 "-st" 的情况下硬停止)或 SIGUSR1(在 "-sf" 的情况下平稳停止),以通知它们它现在负责操作,并且旧进程必须立即离开,或者在完成工作后离开。重要的是要注意,在此期间,有两个几毫秒的小窗口,在高负载下可能会注意到一些连接失败。通常观察到的故障率是在每秒 10000 个新连接的重载操作期间大约 1 次故障,这意味着以每秒 30000 个新连接运行的高负载站点在每次重载时可能会看到大约 3 个连接失败。发生这种情况的两种情况是: - 如果新进程由于旧进程的存在而无法绑定,它将首先经历 SIGTTOU+SIGTTIN 序列,这对于几十个前端来说通常持续大约一毫秒,在此期间某些端口将不会绑定到旧进程,也尚未绑定到新进程。HAProxy 在支持 SO_REUSEPORT 套接字选项的系统上解决了这个问题,因为它允许新进程绑定而无需先要求旧进程解除绑定。大多数 BSD 系统几乎一直支持这一点。Linux 在版本 2.0 中支持此功能,并在 2.2 左右放弃了它,但当时有一些补丁在流传。它在内核 3.9 中重新引入,因此如果您观察到的连接故障率高于上面提到的故障率,请确保您的内核是 3.9 或更高版本,或者相关的补丁已移植到您的内核(可能性较小)。 - 当旧进程关闭侦听端口时,内核可能不总是重新分配剩余在套接字积压中的任何挂起连接。在高负载下,SYN 数据包可能恰好发生在套接字关闭之前,并导致 RST 数据包发送到客户端。在某些即使一个丢弃也无法接受的关键环境中,有时会使用防火墙规则来处理这些丢弃,以在重新加载期间阻止 SYN 数据包,从而强制客户端重新传输。这完全取决于系统,因为某些系统可能能够访问其他侦听队列并避免此 RST。第二种情况涉及客户端在关闭之前处于 SYN_RECV 状态的本地套接字上的 ACK。此 ACK 将导致 RST 数据包,而 haproxy 进程仍然不知道它。这更难摆脱,尽管上面提到的防火墙过滤规则如果在重新启动进程前一秒左右应用会很好地工作。对于绝大多数用户来说,由于他们没有足够的负载来触发竞争条件,此类丢弃永远不会发生。对于大多数高流量用户,只要他们的系统上正确支持 SO_REUSEPORT,故障率仍然在噪声容限内。
为了确保所有传入连接都将成功服务,HAProxy 在加载时计算进程生命周期中所需的总文件描述符数。常规的 Unix 进程默认通常被授予 1024 个文件描述符,特权进程可以自己提高此限制。这是以 root 身份启动 HAProxy 并让它调整限制的原因之一。默认的 1024 个文件描述符限制大约允许处理 500 个并发连接。计算基于全局 maxconn 参数(限制每个进程的总连接数)、侦听器数量、启用健康检查的服务器数量、代理检查、对等体、日志记录器以及可能的一些其他技术要求。对该数字的一个简单的粗略估计是简单地将 maxconn 值加倍并添加几十个以获得所需文件描述符的近似数量。最初 HAProxy 不知道如何计算此值,有必要使用全局部分中的 "ulimit-n" 设置传递该值。这解释了为什么即使在今天,许多配置中仍然存在此设置。不幸的是,它经常被错误计算,导致在接近 maxconn 时连接失败,而不是在等待所需资源时限制传入连接。因此,重要的是删除可能从非常旧版本遗留下来的任何残留的 "ulimit-n" 设置。提高文件描述符的数量以接受中等负载是强制性的,但这需要进行一些特定于操作系统的调整。首先,select() 轮询系统限制为 1024 个文件描述符。事实上,在 Linux 上它曾经能够处理更多,但由于某些操作系统附带的 SELinux 策略过于严格,禁止使用超过 1024 个文件描述符的 select(),HAProxy 现在拒绝在此情况下启动,以避免在运行时出现任何问题。在所有受支持的操作系统上,poll() 可用且不会受到此限制。它会自动选择,因此无需执行任何操作即可获得工作配置。但是当文件描述符数量增加时,poll() 变得非常慢。虽然 HAProxy 尽力限制这种性能影响(例如:通过使用内部文件描述符缓存和批量处理),但一个好的经验法则是,使用 poll() 处理超过一千个并发连接将使用大量 CPU。对于基于内核 2.6 及更高版本的 Linux 系统,将使用 epoll() 系统调用。它是一种更具可扩展性的机制,依赖于内核中的回调,可确保恒定的唤醒时间,无论注册监控的文件描述符数量如何。在检测到它时会自动使用它,前提是 HAProxy 是为 Linux 风格之一构建的。可以使用 "haproxy -vv" 验证其存在和支持。对于支持它的 BSD 系统,kqueue() 可用作替代方案。由于它批量处理更改,它比 poll() 快得多,甚至比 epoll() 稍微快一些。至少 FreeBSD 和 OpenBSD 支持它。就像 Linux 的 epoll() 一样,其支持和可用性在 "haproxy -vv" 的输出中报告。拥有一个好的轮询器是一回事,但进程必须能够达到限制是强制性的。当 HAProxy 启动时,它会立即设置新进程的文件描述符限制并验证它是否成功。如果失败,它会在分叉之前报告它,以便管理员可以看到问题。只要进程以 root 身份启动,此设置就没有理由失败。但是,如果进程由非特权用户启动,则可能会失败。如果有一个令人信服的理由 *不* 以 root 身份启动 haproxy(例如:由最终用户或按应用程序帐户启动),则系统管理员可以为此特定用户提高文件描述符限制。可以通过从用户的命令行发出 "ulimit -n" 来验证设置的有效性。它应该反映新的限制。警告:当非特权用户的限制在此用户的帐户中更改时,这些值通常仅在用户登录时才被考虑,而在系统启动时或 cron 任务中运行的某些脚本中则完全不考虑。这完全取决于操作系统,请记住在以这种方式运行时在启动 haproxy 之前检查 "ulimit -n"。一般建议是永远不要以非特权用户身份启动 haproxy 用于生产目的。另一个很好的理由是它会阻止 haproxy 启用一些安全保护措施。一旦确定系统将允许 haproxy 进程使用所需的文件描述符数量,可能会遇到两个新的系统特定限制。第一个是系统范围的文件描述符限制,它是系统上打开的文件描述符总数,涵盖所有进程。当达到此限制时,accept() 或 socket() 通常会返回 ENFILE。第二个是每个进程的文件描述符硬限制,它阻止 setrlimit() 设置更高。两者都非常依赖于操作系统。在 Linux 上,系统限制在启动时根据内存量设置。可以使用 "fs.file-max" sysctl 进行更改。每个进程的硬限制默认设置为 1048576,但可以使用 "fs.nr_open" sysctl 进行更改。当设置得太低时,可以在运行的进程上观察到文件描述符限制。当进程限制达到时,strace 实用程序将报告 accept() 和 socket() 返回 "-1 EMFILE"。在这种情况下,只需提高 "ulimit-n" 值(或将其删除)即可解决问题。如果这些系统调用返回 "-1 ENFILE",则意味着内核的限制已达到,必须在系统范围的参数上采取措施。这些麻烦必须绝对解决,因为它们会导致高 CPU 使用率(当 accept() 失败时)和通常对用户可见的失败连接。一种解决方案还包括降低全局 maxconn 值以强制执行序列化,并可能禁用 HTTP keep-alive 以强制连接更快地释放和重用。
HAProxy 使用简单快速的基于池的内存管理。由于它依赖于少量不同的对象类型,因此从已经包含适当大小对象的池中选择新对象比为每个不同大小调用 malloc() 更高效。池被组织为堆栈或 LIFO,因此新分配的对象取自最近释放的对象,这些对象在 CPU 缓存中仍然很热。大小相似的池会合并在一起,以限制内存碎片。默认情况下,由于重点放在性能上,每个释放的对象都会放回它来自的池中,并且分配的对象永远不会被释放,因为它们预计很快就会被重用。在 CLI 上,可以通过 "show pools" 命令检查内存在池中的使用情况: > show pools Dumping pools usage. Use SIGQUIT to flush them. - Pool cache_st (16 bytes) : 0 allocated (0 bytes), 0 used, 0 failures, 1 users, @0x9ccc40=03 [SHARED] - Pool pipe (32 bytes) : 5 allocated (160 bytes), 5 used, 0 failures, 2 users, @0x9ccac0=00 [SHARED] - Pool comp_state (48 bytes) : 3 allocated (144 bytes), 3 used, 0 failures, 5 users, @0x9cccc0=04 [SHARED] - Pool filter (64 bytes) : 0 allocated (0 bytes), 0 used, 0 failures, 3 users, @0x9ccbc0=02 [SHARED] - Pool vars (80 bytes) : 0 allocated (0 bytes), 0 used, 0 failures, 2 users, @0x9ccb40=01 [SHARED] - Pool uniqueid (128 bytes) : 0 allocated (0 bytes), 0 used, 0 failures, 2 users, @0x9cd240=15 [SHARED] - Pool task (144 bytes) : 55 allocated (7920 bytes), 55 used, 0 failures, 1 users, @0x9cd040=11 [SHARED] - Pool session (160 bytes) : 1 allocated (160 bytes), 1 used, 0 failures, 1 users, @0x9cd140=13 [SHARED] - Pool h2s (208 bytes) : 0 allocated (0 bytes), 0 used, 0 failures, 2 users, @0x9ccec0=08 [SHARED] - Pool h2c (288 bytes) : 0 allocated (0 bytes), 0 used, 0 failures, 1 users, @0x9cce40=07 [SHARED] - Pool spoe_ctx (304 bytes) : 0 allocated (0 bytes), 0 used, 0 failures, 2 users, @0x9ccf40=09 [SHARED] - Pool connection (400 bytes) : 2 allocated (800 bytes), 2 used, 0 failures, 1 users, @0x9cd1c0=14 [SHARED] - Pool hdr_idx (416 bytes) : 0 allocated (0 bytes), 0 used, 0 failures, 1 users, @0x9cd340=17 [SHARED] - Pool dns_resolut (480 bytes) : 0 allocated (0 bytes), 0 used, 0 failures, 1 users, @0x9ccdc0=06 [SHARED] - Pool dns_answer_ (576 bytes) : 0 allocated (0 bytes), 0 used, 0 failures, 1 users, @0x9ccd40=05 [SHARED] - Pool stream (960 bytes) : 1 allocated (960 bytes), 1 used, 0 failures, 1 users, @0x9cd0c0=12 [SHARED] - Pool requri (1024 bytes) : 0 allocated (0 bytes), 0 used, 0 failures, 1 users, @0x9cd2c0=16 [SHARED] - Pool buffer (8030 bytes) : 3 allocated (24090 bytes), 2 used, 0 failures, 1 users, @0x9cd3c0=18 [SHARED] - Pool trash (8062 bytes) : 1 allocated (8062 bytes), 1 used, 0 failures, 1 users, @0x9cd440=19 Total: 19 pools, 42296 bytes allocated, 34266 used. 池名称仅供参考,它是使用此池的第一个对象类型的名称。括号中的大小是此池中对象的大小。对象大小总是向上舍入到最接近的 16 字节倍数。报告了当前分配的对象数和等效的字节数,以便轻松了解哪个池负责最高的内存使用量。当前正在使用的对象数也在“used”字段中报告。 “allocated”和“used”之间的差值对应于已释放且可立即使用的对象。行尾的地址是池的地址,后面的数字是池索引(如果存在),如果未分配索引,则报告为 -1。可以使用 "-m" 命令行选项限制每个进程分配的内存量,后跟兆字节数。它涵盖了进程的所有可寻址空间,因此包括一些库使用的内存以及堆栈,但在构建资源受限系统时,它是一个可靠的限制。它的工作方式与具有它的系统上的 "ulimit -v" 或其他系统上的 "ulimit -d" 相同。如果内存分配因达到内存限制或系统没有足够的内存而失败,则 haproxy 将首先开始释放所有池中所有可用的对象,然后再尝试再次分配内存。可以通过向 haproxy 进程发送 SIGQUIT 信号来触发这种释放未使用内存的机制。这样做时,当进程在前台运行时,刷新之前的池状态也将报告给 stderr。在重载操作期间,切换到平稳停止状态的进程也会在释放任何连接后自动执行一些刷新,以便释放所有可能的内存以将其保存给新进程。
HAProxy 通常将大部分时间花在系统上,一小部分时间花在用户空间上。一个经过精细调优的 3.5 GHz CPU 可以在单个核心上以 100% CPU 持续每秒约 80000 次端到端连接建立和关闭。当一个核心饱和时,典型数字是: - 95% 系统,5% 用户用于长时间 TCP 连接或大型 HTTP 对象 - 85% 系统,15% 用户用于短 TCP 连接或小型 HTTP 对象处于关闭模式 - 70% 系统,30% 用户用于小型 HTTP 对象处于保持连接模式 规则处理和正则表达式的数量将增加用户空间部分。系统中的防火墙规则、连接跟踪、复杂路由表的出现将反而增加系统部分。在大多数系统上,在网络传输期间观察到的 CPU 时间可以分为 4 个部分: - 中断部分,涉及 I/O 接收时执行的所有处理,甚至在目标进程已知之前。通常 Rx 数据包计入中断。在某些系统(例如 Linux)上,中断处理可能会推迟到专用线程,它可能显示为 softirq,线程称为 ksoftirqd/0(对于 CPU 0)。负责此负载的 CPU 通常由硬件设置定义,尽管在 softirq 的情况下,通常可以将处理重新映射到另一个 CPU。这个中断部分通常会被认为是寄生的,因为它不与任何进程相关联,但它实际上是正在为进程准备工作而完成的一些处理。 - 系统部分,涉及使用从用户空间调用的内核代码完成的所有处理。例如,系统调用计为系统时间。所有同步交付的 Tx 数据包都将计为系统时间。如果某些数据包由于队列填满而必须推迟,那么它们可能会稍后在中断上下文中处理(例如:在接收到打开 TCP 窗口的 ACK 时)。 - 用户部分,它专门在用户空间中运行应用程序代码。HAProxy 专门在此部分运行,尽管它大量使用系统调用。规则处理、正则表达式、压缩、加密都增加了 CPU 消耗的用户部分。 - 空闲部分,这是 CPU 在无事可做时所做的事情。例如,HAProxy 等待传入连接,或等待一些数据离开,这意味着系统正在等待来自客户端的 ACK 来推送这些数据。在实践中,关于 HAProxy 的活动,通常相当准确(但不完全准确)地认为中断/softirq 是由内核驱动程序中的 Rx 处理引起的,用户空间是由 HAProxy 中的第 7 层处理引起的,系统时间是由 Tx 路径上的网络处理引起的。由于 HAProxy 围绕事件循环运行,它使用 poll()(或任何替代方法)等待新事件,并尽快处理所有这些事件,然后再返回 poll() 等待新事件。它测量在 poll() 中等待的时间与处理事件所花费的时间相比。轮询时间与总时间的比率称为“空闲”时间,它是等待某些事情发生所花费的时间量。此比率在 stats 页面上的“idle”行上报告,或在 CLI 上的“Idle_pct”上报告。当它接近 100% 时,意味着负载极低。当它接近 0% 时,意味着不断有一些活动。虽然在过载系统上可能不是很准确,因为其他进程可能会抢占 haproxy 进程的 CPU,但它仍然提供了 HAProxy 如何考虑它正在工作的良好估计:如果负载低且空闲率也低,则可能表明 HAProxy 有很多工作要做,可能是由于必须处理非常昂贵的规则。相反,如果 HAProxy 指示空闲率接近 100% 而事情很慢,则意味着它无法做任何事情来加快速度,因为它已经在等待传入数据进行处理。在下面的示例中,haproxy 完全空闲:$ echo "show info" | socat - /var/run/haproxy.sock | grep ^Idle Idle_pct: 100 当空闲率开始变得非常低时,重要的是调整系统并正确放置进程和中断,以便为所有任务节省尽可能多的 CPU 资源。如果存在防火墙,则可能值得尝试禁用它或调整它以确保它不会对性能限制负主要责任。值得注意的是,卸载有状态防火墙通常会减少中断/softirq 和系统使用量,因为此类防火墙作用于 Rx 和 Tx 路径。在 Linux 上,卸载 nf_conntrack 和 ip_conntrack 模块将显示是否有任何收获。如果是这样,则模块使用默认设置运行,您必须弄清楚如何调整它以获得更好的性能。通常这包括大大增加哈希表大小。在 FreeBSD 上,"pfctl -d" 将同时禁用 "pf" 防火墙及其有状态引擎。如果观察到大量时间花在中断/softirq 上,重要的是确保它们不在同一个 CPU 上运行。大多数系统倾向于将任务固定在接收网络流量的 CPU 上,因为对于某些工作负载,它会改善情况。但是对于繁重的网络绑定工作负载,情况正好相反,因为 haproxy 进程必须与其内核对应物竞争。将 haproxy 固定到一个 CPU 核心并将中断固定到另一个 CPU 核心(所有这些都共享相同的 L3 缓存)往往会显着提高网络性能,因为在实践中 haproxy 和网络堆栈的工作量非常接近,因此它们几乎可以填满每个完整的 CPU。在 Linux 上,这是使用 taskset(对于 haproxy)或使用 cpu-map(来自 haproxy config)完成的,中断分配在 /proc/irq 下。许多网络接口支持多个队列和多个中断。通常,将它们分散到少量 CPU 核心上会有所帮助,前提是它们都共享相同的 L3 缓存。请始终停止 irq_balance,它在此类工作负载上总是做最糟糕的事情。对于包含大量 SSL 流量或大量压缩的 CPU 绑定工作负载,可能值得使用专用于某些任务的多个进程,尽管这里没有通用规则,必须进行试验。为了增加 CPU 容量,可以使用全局部分中的 "nbproc" 指令使 HAProxy 作为多个进程运行。但是有一些限制: - 健康检查按进程运行,因此目标服务器将获得与正在运行的进程一样多的检查; - maxconn 值和队列是按进程的,因此必须设置正确的值以避免使服务器过载; - 出站连接应避免使用端口范围以避免冲突 - 粘性表是按进程的,并且在进程之间不共享; - 每个对等部分一次只能在一个进程上运行; - CLI 操作一次只会作用于一个进程。考虑到这一点,最简单的设置通常包括第一层运行在多个进程上并负责繁重处理,将流量传递给在单个进程中运行的第二层。此机制适用于 SSL 和压缩,它们是两个 CPU 密集型功能。实例可以通过 UNIX 套接字(比 TCP 套接字便宜且不浪费端口)轻松链接,并且代理协议有助于将客户端信息传递到下一阶段。这样做时,通常最好将所有单进程任务绑定到进程号 1,并将额外任务绑定到下一个进程,因为这将使得为不同的机器生成相似的配置更容易。在 Linux 版本 3.9 及更高版本上,当每个进程在同一 IP:port 上使用不同的侦听套接字时,在多进程模式下运行 HAProxy 效率更高;这将使内核将负载均匀地分配给所有进程,而不是唤醒所有进程。有关更多信息,请查看配置手册中“bind”关键字行的“process”选项。
对于日志记录,HAProxy 始终依赖 syslog 服务器,因为它不执行任何文件系统访问。使用它的标准方法是通过 UDP 将日志发送到日志服务器(默认端口 514)。这通常配置为 127.0.0.1,本地 syslog 守护程序正在运行,但它也用于通过网络登录到中心服务器。中心服务器提供了额外的优势,尤其是在 active-active 场景中,希望按到达顺序合并日志。HAProxy 也可以使用 UNIX 套接字将其日志发送到本地 syslog 守护程序,但根本不推荐,因为如果 syslog 服务器在 haproxy 运行时重新启动,套接字将被替换,并且新日志将丢失。由于 HAProxy 将被隔离在 chroot 监狱中,它将无法重新连接到新套接字。在现场也观察到,UNIX 套接字中使用的日志缓冲区非常小,即使在非常轻微的负载下也会导致消息丢失。但这对于测试来说可能没问题。建议在“global”部分添加以下指令,使 HAProxy 使用 facility “local0”记录到本地守护程序:log 127.0.0.1:514 local0 然后将以下指令添加到每个“defaults”部分或每个前端和后端部分:log global 这样,所有日志都将通过日志服务器位置的全局定义集中化。某些 syslog 守护程序默认不侦听 UDP 流量,因此根据使用的守护程序,启用此功能的语法会有所不同: - 在 sysklogd 上,您需要在守护程序的命令行上传递参数 "-r",以便它侦听“远程”日志的 UDP 套接字;请注意,无法将其限制为地址 127.0.0.1,因此它也将接收来自远程系统的日志; - 在 rsyslogd 上,必须将以下行添加到配置文件中:$ModLoad imudp $UDPServerAddress * $UDPServerRun 514 - 在 syslog-ng 上,可以按以下方式创建新源,然后需要将其添加为“log”指令中的有效源:source s_udp { udp(ip(127.0.0.1) port(514)); }; 有关更多信息,请参阅您的 syslog 守护程序手册。如果在系统的日志文件中看不到日志,请考虑以下测试: - 重新启动 haproxy。每个前端和后端都会记录一行,指示它正在启动。如果收到这些日志,则意味着日志正在工作。 - 运行 "strace -tt -s100 -etrace=sendmsg -p <haproxy's pid>" 并执行您期望记录的一些活动。您应该在那里看到使用 sendmsg() 发送的日志消息。如果它们没有出现,请在 haproxy 上使用 strace 重新启动。如果您仍然看不到日志,则明确表示您的配置有问题。 - 运行 tcpdump 以监视端口 514,例如在环回接口上(如果流量正在本地发送):"tcpdump -As0 -ni lo port 514"。如果在那里看到数据包,则证明它们已发送,然后需要对 syslogd 守护程序进行故障排除。虽然流量日志是从前端(接受传入连接的地方)发送的,但后端也需要能够发送日志,以便报告健康检查后服务器状态更改。有关所有可能的日志设置的更多信息,请参阅 HAProxy 的配置手册。选择一个未被其他守护程序使用的 facility 很方便。HAProxy 示例通常建议使用 "local0" 用于流量日志,使用 "local1" 用于管理日志,因为它们在现场从未使用过。单个 facility 也足够了。拥有单独的日志便于日志分析,但重要的是要记住日志有时可能会传输机密信息,因此不得将其与其他可能意外移交给未经授权人员的日志混合。对于在不影响服务器容量的情况下进行现场故障排除,建议使用 HAProxy 提供的 "halog" 实用程序。这是一种类似 grep 的实用程序,旨在以非常快的数据速率处理 HAProxy 日志文件。典型数字范围在每秒 1 到 2 GB 的日志之间。它能够仅提取某些日志(例如:搜索某些类别的 HTTP 状态代码、连接终止状态、按响应时间范围搜索、仅查找错误)、计算行数、将输出限制为一定行数,并执行一些更高级的统计数据,例如按响应时间或错误计数对服务器进行排序、按时间或计数对 URL 进行排序、按访问计数对客户端地址进行排序等。快速发现异常(例如机器人在站点上循环)并阻止它们非常方便。
可以查询 HAProxy 的状态。最常用的机制是 HTTP 统计页面。该页面还提供了一种替代的 CSV 输出格式,供监控工具使用。Unix 套接字也提供相同的格式。统计信息按类别分组,标记为域,对应于 HAProxy 的多个组件。有两个可用的域:proxy 和 dns。如果未指定,则选择 proxy 域。请注意,HTTP 页面上只打印 proxy 统计信息。

9.1. CSV 格式

统计信息可以通过unix socket或HTTP页面查询。两种方式都提供CSV格式,其字段如下。第一行以井号('#')开头,每个以逗号分隔的字段包含一个单词,代表列标题。从第二行开始的所有其他行使用经典的CSV格式,以逗号作为分隔符,双引号('"')作为可选文本分隔符,但仅当封闭文本有歧义时(如果它包含引号或逗号)。文本中的双引号字符('"')会加倍('""'),这是大多数工具识别的格式。请不要在这些列之前插入任何列,以免破坏使用硬编码列位置的工具。对于代理统计信息,在每个字段名称之后,括号中指定了该字段可能具有值的类型。类型为L(监听器)、F(前端)、B(后端)和S(服务器)。有一组固定的静态字段,始终以相同的顺序提供。包含字符'-'的列表示静态字段的结束,在此之后字段的存在或顺序不保证。以下是使用代理统计域的静态字段列表: 0. pxname [LFBS]: 代理名称 1. svname [LFBS]: 服务名称(FRONTEND用于前端,BACKEND用于后端,任何名称用于服务器/监听器) 2. qcur [..BS]: 当前排队请求数。对于后端,这报告的是没有分配服务器的排队请求数。 3. qmax [..BS]: qcur的最大值 4. scur [LFBS]: 当前会话数 5. smax [LFBS]: 最大会话数 6. slim [LFBS]: 配置的会话限制 7. stot [LFBS]: 累计会话数 8. bin [LFBS]: 输入字节数 9. bout [LFBS]: 输出字节数 10. dreq [LFB.]: 由于安全问题而被拒绝的请求数。 - 对于tcp,这是因为匹配了tcp-request内容规则。 - 对于http,这是因为匹配了http-request或tarpit规则。 11. dresp [LFBS]: 由于安全问题而被拒绝的响应数。 - 对于http,这是因为匹配了http-request规则或"option checkcache"。 12. ereq [LF..]: 请求错误数。一些可能的原因是: - 客户端早期终止,在请求发送之前。 - 客户端读取错误 - 客户端超时 - 客户端关闭连接 - 客户端的各种错误请求。 - 请求被tarpitted。 13. econ [..BS]: 尝试连接到后端服务器时遇到错误的请求数。后端统计信息是该后端所有服务器统计信息的总和,加上与特定服务器无关的任何连接错误(例如后端没有活动服务器)。 14. eresp [..BS]: 响应错误数。srv_abrt也会在此处计算。其他一些错误包括: - 客户端socket上的写入错误(不会计入服务器统计信息) - 应用过滤器到响应失败。 15. wretr [..BS]: 连接到服务器重试的次数。 16. wredis [..BS]: 请求被重新调度到另一台服务器的次数。服务器值计算该服务器被切换走的次数。 17. status [LFBS]: 状态(UP/DOWN/NOLB/MAINT/MAINT(via)/MAINT(resolution)...) 18. weight [..BS]: 总有效权重(后端),有效权重(服务器) 19. act [..BS]: 活动服务器数(后端),服务器是否活动(服务器) 20. bck [..BS]: 备份服务器数(后端),服务器是否备份(服务器) 21. chkfail [...S]: 检查失败次数。(仅计算服务器启动时失败的检查。) 22. chkdown [..BS]: UP->DOWN转换次数。后端计数器计算整个后端宕机的转换,而不是每个服务器计数器的总和。 23. lastchg [..BS]: 自上次UP<->DOWN转换以来的秒数 24. downtime [..BS]: 总停机时间(秒)。后端的值是整个后端的停机时间,而不是服务器停机时间的总和。 25. qlimit [...S]: 为服务器配置的最大队列数,如果值为0(默认值,表示无限制)则为空。 26. pid [LFBS]: 进程ID(0为第一个实例,1为第二个,...) 27. iid [LFBS]: 唯一代理ID 28. sid [L..S]: 服务器ID(在代理内唯一) 29. throttle [...S]: 服务器当前的节流百分比,当慢启动激活时,如果不在慢启动中则无值。 30. lbtot [..BS]: 服务器被选中的总次数,无论是新会话还是重新调度。服务器计数器是该服务器被选中的次数。 31. tracked [...S]: 如果启用跟踪,则为代理/服务器的ID。 32. type [LFBS]: (0=frontend, 1=backend, 2=server, 3=socket/listener) 33. rate [.FBS]: 过去一秒的每秒会话数 34. rate_lim [.F..]: 配置的每秒新会话限制 35. rate_max [.FBS]: 每秒新会话的最大数 36. check_status [...S]: 上次健康检查状态,之一: UNK -> 未知 INI -> 初始化中 SOCKERR -> socket错误 L4OK -> 第4层检查通过,未启用上层测试 L4TOUT -> 第1-4层超时 L4CON -> 第1-4层连接问题,例如"Connection refused" (tcp rst) 或 "No route to host" (icmp) L6OK -> 第6层检查通过 L6TOUT -> 第6层(SSL)超时 L6RSP -> 第6层无效响应 - 协议错误 L7OK -> 第7层检查通过 L7OKC -> 第7层条件检查通过,例如带有disable-on-404的404 L7TOUT -> 第7层(HTTP/SMTP)超时 L7RSP -> 第7层无效响应 - 协议错误 L7STS -> 第7层响应错误,例如HTTP 5xx 注意:如果检查当前正在运行,将报告最后已知的状态,前缀为"* "。例如 "* L7OK"。 37. check_code [...S]: 第5-7层代码(如果可用) 38. check_duration [...S]: 完成上次健康检查所需的时间(毫秒) 39. hrsp_1xx [.FBS]: 带有1xx代码的http响应 40. hrsp_2xx [.FBS]: 带有2xx代码的http响应 41. hrsp_3xx [.FBS]: 带有3xx代码的http响应 42. hrsp_4xx [.FBS]: 带有4xx代码的http响应 43. hrsp_5xx [.FBS]: 带有5xx代码的http响应 44. hrsp_other [.FBS]: 带有其他代码的http响应(协议错误) 45. hanafail [...S]: 健康检查失败详情 46. req_rate [.F..]: 过去一秒的每秒HTTP请求数 47. req_rate_max [.F..]: 观察到的每秒HTTP请求的最大数 48. req_tot [.FB.]: 收到的HTTP请求总数 49. cli_abrt [..BS]: 客户端中止的数据传输次数 50. srv_abrt [..BS]: 服务器中止的数据传输次数(包括在eresp中) 51. comp_in [.FB.]: 送入压缩器的HTTP响应字节数 52. comp_out [.FB.]: 压缩器发出的HTTP响应字节数 53. comp_byp [.FB.]: 绕过HTTP压缩器的字节数(CPU/带宽限制) 54. comp_rsp [.FB.]: 被压缩的HTTP响应数 55. lastsess [..BS]: 自上次会话分配给服务器/后端以来的秒数 56. last_chk [...S]: 最后健康检查内容或文本错误 57. last_agt [...S]: 最后代理检查内容或文本错误 58. qtime [..BS]: 过去1024个请求的平均队列时间(毫秒) 59. ctime [..BS]: 过去1024个请求的平均连接时间(毫秒) 60. rtime [..BS]: 过去1024个请求的平均响应时间(毫秒)(TCP为0) 61. ttime [..BS]: 过去1024个请求的平均总会话时间(毫秒) 62. agent_status [...S]: 上次代理检查状态,之一: UNK -> 未知 INI -> 初始化中 SOCKERR -> socket错误 L4OK -> 第4层检查通过,未启用上层测试 L4TOUT -> 第1-4层超时 L4CON -> 第1-4层连接问题,例如"Connection refused" (tcp rst) 或 "No route to host" (icmp) L7OK -> 代理报告"up" L7STS -> 代理报告"fail", "stop", or "down" 63. agent_code [...S]: 代理报告的数字代码(如果适用)(目前未使用) 64. agent_duration [...S]: 完成上次检查所需的时间(毫秒) 65. check_desc [...S]: check_status的简短人类可读描述 66. agent_desc [...S]: agent_status的简短人类可读描述 67. check_rise [...S]: 检查使用的服务器"rise"参数 68. check_fall [...S]: 检查使用的服务器"fall"参数 69. check_health [...S]: 服务器的健康检查值,介于0和rise+fall-1之间 70. agent_rise [...S]: 代理的"rise"参数,通常为1 71. agent_fall [...S]: 代理的"fall"参数,通常为1 72. agent_health [...S]: 代理的健康参数,介于0和rise+fall-1之间 73. addr [L..S]: 地址:端口或"unix"。IPv6地址用方括号括起来。 74: cookie [..BS]: 服务器的cookie值或后端的cookie名称 75: mode [LFBS]: 代理模式 (tcp, http, health, unknown) 76: algo [..B.]: 负载均衡算法 77: conn_rate [.F..]: 过去一秒的连接数 78: conn_rate_max [.F..]: 已知的最高conn_rate 79: conn_tot [.F..]: 累计连接数 80: intercepted [.FB.]: 累计拦截请求数(监控,统计) 81: dcon [LF..]: 被"tcp-request connection"规则拒绝的请求数 82: dses [LF..]: 被"tcp-request session"规则拒绝的请求数 83: wrew [LFBS]: 失败的头部重写警告累计数 84: connect [..BS]: 连接建立尝试累计数 85: reuse [..BS]: 连接重用累计数 86: cache_lookups [.FB.]: 缓存查找累计数 87: cache_hits [.FB.]: 缓存命中累计数 88: srv_icur [...S]: 当前可重用的空闲连接数 89: src_ilim [...S]: 可用空闲连接数的限制 90. qtime_max [..BS]: 观察到的最大队列时间(毫秒) 91. ctime_max [..BS]: 观察到的最大连接时间(毫秒) 92. rtime_max [..BS]: 观察到的最大响应时间(毫秒)(TCP为0) 93. ttime_max [..BS]: 观察到的最大总会话时间(毫秒) 94. eint [LFBS]: 内部错误累计数 95. idle_conn_cur [...S]: 当前不安全的空闲连接数 96. safe_conn_cur [...S]: 当前安全的空闲连接数 97. used_conn_cur [...S]: 当前正在使用的连接数 98. need_conn_est [...S]: 估计需要的连接数 99. uweight [..BS]: 总用户权重(后端),服务器用户权重(服务器) 对于所有其他统计域,不保证字段的存在或顺序。在这种情况下,应始终使用标题行来解析CSV数据。

9.2. 类型化输出格式

show info” 和 “show stat” 都支持一种模式,其中每个输出值都附带其类型和足够的信息,以便了解该值应如何在进程之间聚合以及如何演变。在所有情况下,输出都由每行一个值组成,所有信息都由冒号(':')分隔的字段分割。第一列指定被转储的对象或指标。其格式特定于生成此输出的命令,并且不会在本节中描述。通常,它由一系列标识符和字段名称组成。第二列包含3个字符,分别指示所报告值的来源、性质和范围。第一个字符(来源)指示值从何处提取。可能的字符有: M 该值是一个指标。它在某个瞬间有效,并可能根据其性质而变化。 S 该值是一个状态。它代表一个离散值,根据定义不能聚合。它可能是服务器的状态(“UP”或“DOWN”)、进程的PID等。 K 该值是一个排序键。它代表一个标识符,可用于将某些值组合在一起,因为它在其类别中是唯一的。所有内部标识符都是键。如果某些名称是唯一的(例如:前端名称是唯一的),则它们可以被列为键。通常键来自配置,即使其中一些可能自动分配。对于大多数目的,键可以被视为等同于配置。 C 该值来自配置。某些配置值在输出上有意义,例如并发连接限制或cookie名称。根据定义,这些值在从同一配置文件启动的所有进程中都是相同的。 P 该值来自产品本身。这种值很少,最常见的用途是报告产品名称、版本和发布日期。这些元素在所有进程中也是相同的。第二个字符(性质)指示字段所携带信息的性质,以便聚合器决定使用什么操作来聚合多个值。可能的字符有: A 该值代表自上次事件以来的时长。这与持续时间略有不同,因为时长是根据当前日期自动计算的。一个典型的例子是服务器上最后一次会话发生的时间。时长通常通过取最小值来聚合,并且不需要存储。 a 该值代表一个已平均的值。平均响应时间和服务器权重属于这种性质。平均值通常可以在进程之间平均。 C 该值代表一个累加计数器。此类度量会不断增加,直到溢出为止。一些监控协议需要区分计数器和仪表来报告不同类型。通常,计数器可以简单地求和,因为它们代表事件或数量。此类指标的示例包括连接数或字节数。 D 该值代表状态的持续时间。这有几种用法,其中大部分包括上次健康检查所花费的时间以及服务器宕机的时间。持续时间通常不求和,大多数情况下会保留最大值来计算SLA。 G 该值代表一个仪表。它是在某个瞬间的度量。内存使用量或当前活动连接数属于这种性质。此类指标通常在聚合期间求和。 L 该值代表一个限制(通常是配置的限制)。从本质上讲,限制更难聚合,因为它们特定于检索它们的位置。在某些情况下,它们可以求和或保持分离。 M 该值代表一个最大值。通常它将应用于仪表并保留已知的最高值。此类指标的示例可能是产品生命周期中遇到的最大并发连接数。为了正确聚合最大值,您应该输出一个范围,从所有最大值中的最大值到它们的总和。确实无法知道它们是否同时遇到。 m 该值代表一个最小值。通常它将应用于仪表并保留已知的最低值。此类指标的示例可能是产品生命周期中遇到的最小空闲内存池量。为了正确聚合最小值,您应该输出一个范围,从所有最小值中的最小值到它们的总和。确实无法知道它们是否同时遇到。 N 该值代表一个名称,因此它是一个字符串。它用于报告代理名称、服务器名称和cookie名称。名称的来源是配置或键,并且应在所有进程中相同。 O 该值代表自由文本输出。来自各种命令的输出、健康检查的返回、节点描述都属于这种性质。 R 该值代表一个事件速率。它是在某个瞬间的度量。它与仪表非常相似,只是接收者知道这个度量变化缓慢,并可能决定不保留所有值。此类指标的示例是测量的每秒连接数。此类指标通常在聚合期间求和。 T 该值代表日期或时间。发出当前日期的字段将属于此类型。聚合此类信息的方法留作实现选择。目前没有字段使用此类型。第三个字符(范围)指示值反映的范围。有些元素可能按进程,而其他元素可能按配置或按系统。这种区别对于知道在聚合期间是应保留单个值还是必须聚合值非常重要。目前支持以下字符: C 该值对于整个节点集群有效,该集群是通过对等协议通信的节点集。一个示例可能是复制到其他对等体的stick table中存在的条目数量。目前没有指标使用此范围。 P 该值仅对报告它的进程有效。大多数指标使用此范围。 S 该值对于整个服务有效,即从同一配置文件一起启动的进程集。所有源自配置的指标都使用此范围。某些其他指标也可能用于某些共享资源(例如:共享SSL缓存统计信息)。 s 该值对于整个系统有效,例如系统的主机名、当前日期或资源使用情况。目前没有指标使用此范围。这些信息的消费者通常有足够的这3个字符来确定如何准确地报告跨多个进程的聚合信息。在此列之后,第三列指示字段的类型,包括"s32"(有符号32位整数)、"s64"(有符号64位整数)、"u32"(无符号32位整数)、"u64"(无符号64位整数)、"str"(字符串)。在解析值之前了解类型非常重要,以便正确读取它。例如,只包含数字的字符串仍然是字符串而不是整数(例如:检查提取的错误代码)。然后第四列是值本身,根据其类型进行编码。字符串在冒号之后立即转储,没有任何前导空格。如果字符串包含冒号,它将正常出现。这意味着输出不应仅围绕冒号分割,否则某些检查输出或服务器地址可能会被截断。

9.3. Unix 套接字命令

默认情况下未启用stats socket。要启用它,需要在haproxy配置文件的global部分添加一行。建议添加第二行以设置更大的超时时间,这在手动发出命令时总是很方便: global stats socket /var/run/haproxy.sock mode 600 level admin stats timeout 2m 也可以通过重复该行来添加stats socket的多个实例,并使它们监听TCP端口而不是UNIX socket。默认情况下从不这样做,因为这很危险,但在某些情况下会很方便: global stats socket /var/run/haproxy.sock mode 600 level admin stats socket ipv4@192.168.0.1:9999 level admin stats timeout 2m 要访问socket,需要一个外部工具,例如"socat"。Socat是一个连接任何东西到任何东西的瑞士军刀。我们用它将终端连接到socket,或者将stdin/stdout管道连接到socket用于脚本。我们将使用的两种主要语法如下: # socat /var/run/haproxy.sock stdio # socat /var/run/haproxy.sock readline 第一种用于脚本。可以将脚本的输出发送给haproxy,并将haproxy的输出传递给另一个脚本。这对于检索计数器或攻击跟踪非常有用。第二种仅用于手动发出命令。它的好处是终端由readline库处理,该库支持行编辑和历史记录,这在发出重复命令时非常方便(例如:观察计数器)。socket支持两种操作模式: - 交互式 - 非交互式 当socat连接到socket时,非交互模式是默认模式。在这种模式下,可以发送单行命令。它作为一个整体被处理,响应被发送回来,连接在响应结束后关闭。这是脚本和监控工具使用的模式。可以在此模式下发送多个命令,它们需要用分号(';')分隔。例如: # echo "show info;show stat;show table" | socat /var/run/haproxy stdio 如果命令需要使用分号或反斜杠(例如:在值中),则必须在其前面加上反斜杠('\')。交互模式显示一个提示符('>')并等待在行上输入命令,然后处理它们,并再次显示提示符以等待新命令。此模式通过"prompt"命令进入,该命令必须在非交互模式的第一行发送。该模式是一个翻转开关,如果在交互模式下发送"prompt",它将被禁用,并且连接将在处理同一行的最后一个命令后关闭。因此,当手动调试时,通常从"prompt"命令开始: # socat /var/run/haproxy readline prompt > show info ... > (可选)进程的运行时间可以显示在提示符中。要启用此功能,"prompt timed"命令将启用提示符并切换时间的显示。运行时间以"d:hh:mm:ss"格式显示,其中"d"是天数,"hh"、"mm"、"ss"分别是小时、分钟和秒数,每个数字占两位: # socat /var/run/haproxy readline prompt timed [23:03:34:39]> show version 2.8-dev9-e5e622-18 [23:03:34:41]> quit 当在master CLI上设置 timed prompt 时,提示符将显示当前选定进程的运行时间,因此这适用于master、当前worker或较旧的worker: master> prompt timed [0:00:00:50] master> show proc (...) [0:00:00:58] master> @!11955 <-- master, switch to current worker [0:00:01:03] 11955> @!11942 <-- current worker, switch to older worker [0:00:02:17] 11942> @ <-- older worker, switch back to master [0:00:01:10] master> 由于可以一次发出多个命令,haproxy使用空行作为分隔符来标记每个命令输出的结束,并确保没有命令可以在输出中发出空行。因此,即使在单行上管道化了多个命令,脚本也可以轻松解析输出。某些命令可能需要一个可选的有效载荷(payload)。要为命令添加有效载荷,第一行需要以"<<\n"模式结尾。接下来的行将被视为有效载荷,并且可以包含任意多行。要验证带有有效载荷的命令,它需要以空行结尾。有效载荷模式可以自定义,以更改有效载荷结束的方式。为了使有效载荷以空行以外的内容结束,可以在'<<'和'\n'之间设置自定义模式。除了'<<'之外,只能使用7个字符,否则这不会被视为有效载荷。例如,要使用包含空行和注释的PEM文件: # echo -e "set ssl cert common.pem <<%EOF%\n$(cat common.pem)\n%EOF%\n" | \ socat /var/run/haproxy.stat - 存在限制:传递给CLI的整个缓冲区长度不得大于tune.bfsize,并且模式"<<"不得粘在行的最后一个单词上。当在交互模式下输入有效载荷时,提示符将从"> "变为"+ "。重要的是要理解,当多个haproxy进程在同一socket上启动时,任何进程都可能接收请求并输出其自己的统计信息。下面提供了stats socket上当前支持的命令列表。如果发送未知命令,haproxy会显示用法消息,其中提醒所有受支持的命令。某些命令支持更复杂的语法,通常在发生这种情况时会解释命令的哪个部分无效。某些命令需要更高的权限级别才能工作。如果您没有足够的权限,您将收到错误"Permission denied"。有关更多信息,请查看配置手册中"bind"关键字行的"level"选项。
中止并销毁一个临时的 CA 文件更新事务。另见 "set ssl ca-file" 和 "commit ssl ca-file"。
abort ssl cert <filename>
中止并销毁一个临时的 SSL 证书更新事务。另见 "set ssl cert" 和 "commit ssl cert"。
中止并销毁一个临时的 CRL 文件更新事务。另见 "set ssl crl-file" 和 "commit ssl crl-file"。
add acl [@<ver>] <acl> <pattern>
在 acl <acl> 中添加一个条目。<acl> 是由“show acl”返回的 #<id> 或 <file>。此命令不验证该条目是否已存在。条目被添加到 ACL 的当前版本,除非使用 "@<ver>" 指定了特定版本。此版本号必须预先由“prepare acl”分配,并且它将在“show acl”输出中报告的 "curr_ver" 和 "next_ver" 版本之间。使用特定版本号添加的条目在对其执行 "commit acl" 操作之前不会匹配。但是,可以使用 "show acl @<ver>" 命令查询它们,并使用 "clear acl @<ver>" 命令清除它们。如果引用的 <acl> 是一个也与 map 一起使用的文件,则不能使用此命令。在这种情况下,必须改用“add map”命令。
add map [@<ver>] <map> <key> <value>
add map [@<ver>] <map> <payload>
向map <map>中添加条目,将值 <value> 与键 <key> 相关联。此命令不验证条目是否已存在。它主要用于在"clear"或"prepare"操作后填充map。条目被添加到ACL的当前版本中,除非使用"@<ver>"指定了特定版本。此版本号必须事先已通过"prepare acl"分配,并且它将包含在"show acl"输出中报告的"curr_ver"和"next_ver"版本之间。使用特定版本号添加的条目在对其执行"commit map"操作之前不会匹配。但是,可以使用"show map @<ver>"命令查询它们,并使用"clear acl @<ver>"命令清除它们。如果指定的map也被用作ACL,则ACL将仅匹配<key>部分并忽略<value>部分。使用有效载荷语法,可以通过在单独的行上输入多个键/值对来添加它们。在每行上,第一个单词是键,行的其余部分被认为是值,甚至可以包含空格。
示例
# socat /tmp/sock1 - prompt > add map #-1 << + key1 value1 + key2 value2 with spaces + key3 value3 also with spaces + key4 value4 >
add server <backend>/<server> [args]*
实例化一个附加到后端 <backend> 的新服务器。<server> 名称不得已在后端中使用。对后端有一个特殊限制,它必须使用动态负载均衡算法。可以使用server配置文件语句中的一部分关键字来配置服务器行为。另请注意,不会重用同一后端中假定的 'default-server' 语句中的任何设置。目前,动态服务器使用"none" init-addr方法静态初始化。这意味着如果指定了FQDN作为地址,即使服务器创建将通过验证,也不会进行解析。为了支持重新加载操作,通过CLI创建的服务器也应手动插入相关的haproxy配置文件中。配置中不存在的动态服务器在重新加载操作后不会恢复。动态服务器可以使用"track"关键字来跟踪配置中另一个服务器的检查状态。但是,无法跟踪另一个动态服务器。这是为了确保即使在删除动态服务器的情况下,跟踪链也能保持一致。使用"check"关键字启用健康检查支持。请注意,健康检查默认是禁用的,必须使用"enable health"命令独立于服务器启用。对于代理检查,使用"agent-check"关键字和"enable agent"命令。请注意,在这种情况下,服务器可能会根据报告的状态通过代理激活,而无需显式的"enable server"命令。这也意味着在删除带有代理检查的动态服务器时需要格外小心。应首先通过"disable agent"停用代理,以便在删除之前将服务器置于所需的维护模式。使用大量动态服务器时,可能会达到fd限制。在这种情况下,请参阅"u-limit"全局关键字文档。以下是当前支持的关键字列表: - agent-addr - agent-check - agent-inter - agent-port - agent-send - allow-0rtt - alpn - addr - backup - ca-file - check - check-alpn - check-proto - check-send-proxy - check-sni - check-ssl - check-via-socks4 - ciphers - ciphersuites - cookie - crl-file - crt - disabled - downinter - enabled - error-limit - fall - fastinter - force-sslv3/tlsv10/tlsv11/tlsv12/tlsv13 - id - inter - maxconn - maxqueue - minconn - no-ssl-reuse - no-sslv3/tlsv10/tlsv11/tlsv12/tlsv13 - no-tls-tickets - npn - observe - on-error - on-marked-down - on-marked-up - pool-low-conn - pool-max-conn - pool-purge-delay - port - proto - proxy-v2-options - rise - send-proxy - send-proxy-v2 - send-proxy-v2-ssl - send-proxy-v2-ssl-cn - slowstart - sni - source - ssl - ssl-max-ver - ssl-min-ver - tfo - tls-tickets - track - usesrc - verify - verifyhost - weight - ws 它们的语法类似于配置文件的服务器行,请参阅各自的文档了解详细信息。
add ssl ca-file <cafile> <payload> 向 ca-file 添加新证书。当您达到 CLI 上的缓冲区大小限制并希望添加多个证书时,此命令很有用。您能够单独添加每个证书,而不是用所有证书执行 "set" 操作。一个 "set ssl ca-file" 将重置 ca-file。
示例
echo -e "set ssl ca-file cafile.pem <<\n$(cat rootCA.crt)\n" | \ socat /var/run/haproxy.stat - echo -e "add ssl ca-file cafile.pem <<\n$(cat intermediate1.crt)\n" | \ socat /var/run/haproxy.stat - echo -e "add ssl ca-file cafile.pem <<\n$(cat intermediate2.crt)\n" | \ socat /var/run/haproxy.stat - echo "commit ssl ca-file cafile.pem" | socat /var/run/haproxy.stat -
add ssl crt-list <crtlist> <certificate>
add ssl crt-list <crtlist> <payload>
在 crt-list 中添加一个证书。它也可以用于目录,因为现在目录的加载方式与 crt-list 相同。此命令允许您在参数中使用证书名称,要使用 SSL 选项或过滤器,必须将 crt-list 行作为有效负载发送。有效负载中只支持一个 crt-list 行。此命令将为使用 crt-list 的每个 bind 行加载证书。要将新证书推送到 HAProxy,必须使用 "new ssl cert" 和 "set ssl cert" 命令。
示例
$ echo "new ssl cert foobar.pem" | socat /tmp/sock1 - $ echo -e "set ssl cert foobar.pem <<\n$(cat foobar.pem)\n" | socat /tmp/sock1 - $ echo "commit ssl cert foobar.pem" | socat /tmp/sock1 - $ echo "add ssl crt-list certlist1 foobar.pem" | socat /tmp/sock1 - $ echo -e 'add ssl crt-list certlist1 <<\nfoobar.pem [allow-0rtt] foo.bar.com !test1.com\n' | socat /tmp/sock1 -
清除每个代理(前端和后端)和每个服务器中统计计数器的最大值。累积的计数器不受影响。由 "show activity" 报告的内部活动计数器也会被重置。这可用于在事件发生后获得干净的计数器,而无需重新启动或清除流量计数器。此命令受限制,只能在配置为“operator”或“admin”级别的套接字上发出。
清除每个代理(前端和后端)和每个服务器中的所有统计计数器。这与重新启动具有相同的效果。此命令受限制,只能在配置为“admin”级别的套接字上发出。
clear acl [@<ver>] <acl>
从 acl <acl> 中移除所有条目。<acl> 是由“show acl”返回的 #<id> 或 <file>。请注意,如果引用的 <acl> 是一个文件并且与一个 map 共享,那么这个 map 也会被清除。默认情况下,只清除 ACL 的当前版本(正在被匹配的版本)。但是,可以使用'@'后跟版本号来指定另一个版本。
clear map [@<ver>] <map>
从 map <map> 中移除所有条目。<map> 是由“show map”返回的 #<id> 或 <file>。请注意,如果引用的 <map> 是一个文件并且与一个 acl 共享,那么这个 acl 也会被清除。默认情况下,只清除 map 的当前版本(正在被匹配的版本)。但是,可以使用'@'后跟版本号来指定另一个版本。
clear table <table> [ data.<type> <operator> <value> ] | [ key <key> ]
从stick-table <table> 中删除条目。这通常用于解除被滥用拒绝访问服务的用户,但也可以用于清除与即将被替换的服务器匹配的一些粘性条目(详见下面的"show table")。请注意,有时删除条目会被拒绝,因为它当前正被某个会话跟踪。在会话结束后几秒钟重试通常就足够了。在没有给出任何选项参数的情况下,所有条目都将被删除。当使用"data."形式时,将删除与使用存储数据应用的过滤器匹配的条目(请参阅第4.2节中的"stick-table")。必须在<type>中指定存储数据类型,并且此数据类型必须存储在表中,否则会报告错误。数据根据<operator>与64位整数<value>进行比较。操作符与ACL相同: - eq : 匹配数据等于此值的条目 - ne : 匹配数据不等于此值的条目 - le : 匹配数据小于或等于此值的条目 - ge : 匹配数据大于或等于此值的条目 - lt : 匹配数据小于此值的条目 - gt : 匹配数据大于此值的条目 当使用key形式时,条目<key>被删除。键必须与表具有相同的类型,目前仅限于IPv4、IPv6、整数和字符串。
示例
$ echo "show table http_proxy" | socat stdio /tmp/sock1 >>> # table: http_proxy, type: ip, size:204800, used:2 >>> 0x80e6a4c: key=127.0.0.1 use=0 exp=3594729 gpc0=0 conn_rate(30000)=1 \ bytes_out_rate(60000)=187 >>> 0x80e6a80: key=127.0.0.2 use=0 exp=3594740 gpc0=1 conn_rate(30000)=10 \ bytes_out_rate(60000)=191 $ echo "clear table http_proxy key 127.0.0.1" | socat stdio /tmp/sock1 $ echo "show table http_proxy" | socat stdio /tmp/sock1 >>> # table: http_proxy, type: ip, size:204800, used:1 >>> 0x80e6a80: key=127.0.0.2 use=0 exp=3594740 gpc0=1 conn_rate(30000)=10 \ bytes_out_rate(60000)=191 $ echo "clear table http_proxy data.gpc0 eq 1" | socat stdio /tmp/sock1 $ echo "show table http_proxy" | socat stdio /tmp/sock1 >>> # table: http_proxy, type: ip, size:204800, used:1
commit acl @<ver> <acl> 提交对ACL <acl> 版本 <ver> 所做的所有更改,并删除所有过去版本。<acl> 是"show acl"返回的 #<id> 或 <file>。版本号必须在"show acl"中报告的"curr_ver"+1和"next_ver"之间。如果需要,可以使用"show acl @<ver> <acl>"查询要提交到ACL的内容。指定的版本号通常是使用"prepare acl"命令创建的。替换是原子性的。它包括原子性地将当前版本更新为指定版本,这将立即导致其他版本中的所有条目不可见,新版本中的所有条目可见。也可以使用此命令执行ACL所有可见条目的原子删除,方法是先调用"prepare acl",然后不添加任何条目地提交。如果引用的 <acl> 也是用作map的文件,则不能使用此命令。在这种情况下,必须使用"commit map"命令代替。 commit map @<ver> <map> 提交对map <map> 版本 <ver> 所做的所有更改,并删除所有过去版本。<map> 是"show map"返回的 #<id> 或 <file>。版本号必须在"show map"中报告的"curr_ver"+1和"next_ver"之间。如果需要,可以使用"show map @<ver> <map>"查询要提交到map的内容。指定的版本号通常是使用"prepare map"命令创建的。替换是原子性的。它包括原子性地将当前版本更新为指定版本,这将立即导致其他版本中的所有条目不可见,新版本中的所有条目可见。也可以使用此命令执行map所有可见条目的原子删除,方法是先调用"prepare map",然后不添加任何条目地提交。
提交临时SSL CA文件更新事务。对于现有CA文件(在"show ssl ca-file"中处于"Used"状态),新的CA文件树条目将插入到CA文件树中,并重建所有使用该CA文件条目的实例,以及所需的SSL上下文。以前由重建实例使用的所有上下文都将被删除。成功后,以前的CA文件条目将从树中删除。失败后,不会删除任何内容,所有原始SSL上下文都将保留并使用。一旦临时事务被提交,它就会被销毁。对于新的CA文件(在"new ssl ca-file"之后并在"show ssl ca-file"中处于"Unused"状态),CA文件将插入到CA文件树中,但在HAProxy中不会被任何地方使用。要使用它并生成使用它的SSL上下文,您需要使用"add ssl crt-list"将其添加到crt-list中。另请参阅"new ssl ca-file"、"set ssl ca-file"、"add ssl ca-file"、"abort ssl ca-file"和"add ssl crt-list"。
commit ssl cert <filename>
提交临时SSL证书更新事务。对于现有证书(在"show ssl cert"中处于"Used"状态),生成它需要的所有SSL上下文和SNI,插入它们,并删除以前的。在配置中使用 <filename> 的所有地方替换内存中的以前的SSL证书。失败后,它不会删除或插入任何内容。一旦临时事务被提交,它就会被销毁。对于新证书(在"new ssl cert"之后并在"show ssl cert"中处于"Unused"状态),证书将提交到证书存储中,但在haproxy中不会被任何地方使用。要使用它并生成其SNI,您需要使用"add ssl crt-list"将其添加到crt-list或目录中。另请参阅"new ssl cert"、"set ssl cert"、"abort ssl cert"和"add ssl crt-list"。
提交临时SSL CRL文件更新事务。对于现有CRL文件(在"show ssl crl-file"中处于"Used"状态),新的CRL文件条目将插入到CA文件树中(其中包含CA文件和CRL文件),并重建所有使用该CRL文件条目的实例,以及所需的SSL上下文。以前由重建实例使用的所有上下文都将被删除。成功后,以前的CRL文件条目将从树中删除。失败后,不会删除任何内容,所有原始SSL上下文都将保留并使用。一旦临时事务被提交,它就会被销毁。对于新的CRL文件(在"new ssl crl-file"之后并在"show ssl crl-file"中处于"Unused"状态),CRL文件将插入到CRL文件树中,但在HAProxy中不会被任何地方使用。要使用它并生成使用它的SSL上下文,您需要使用"add ssl crt-list"将其添加到crt-list中。另请参阅"new ssl crl-file"、"set ssl crl-file"、"abort ssl crl-file"和"add ssl crt-list"。
debug dev <command> [args]*
调用开发者专用的命令。仅在以专家模式(expert mode)运行的 CLI 连接上支持(参见 "expert-mode on")。此类命令极其危险且不可恢复,任何误用都可能导致进程崩溃。它们仅供专家使用,除非得到明确指示,否则绝对不应使用。其中一些命令仅在 haproxy 编译时定义了 DEBUG_DEV 时才可用,因为它们可能存在安全隐患。所有这些命令都需要管理员权限,并且为了避免不熟悉源代码的人员滥用,我们特意没有将它们写入文档。
del acl <acl> [<key>|#<ref>]
从 acl <acl> 中删除所有与键 <key> 对应的 acl 条目。<acl> 是由“show acl”返回的 #<id> 或 <file>。如果使用了 <ref>,此命令仅删除列出的引用。引用可以通过列出 acl 的内容找到。请注意,如果引用的 <acl> 是一个文件并且与 map 共享,该条目也将在 map 中被删除。
del map <map> [<key>|#<ref>]
从 map <map> 中删除所有与键 <key> 对应的 map 条目。<map> 是由“show map”返回的 #<id> 或 <file>。如果使用了 <ref>,此命令仅删除列出的引用。引用可以通过列出 map 的内容找到。请注意,如果引用的 <map> 是一个文件并且与 acl 共享,该条目也将在 acl 中被删除。
从 HAProxy 中删除一个 CA 文件树条目。该 CA 文件必须未被使用,并已从任何 crt-list 中移除。"show ssl ca-file" 命令显示 CA 文件的状态。此删除操作对通过配置中的 "ca-file" 或 "ca-verify-file" 指令直接引用的证书无效。
del ssl cert <certfile>
从 HAProxy 中删除一个证书存储。该证书必须是未使用的,并且已从任何 crt-list 或目录中移除。“show ssl cert”显示证书的状态。此删除操作不适用于在配置中通过“crt”指令直接引用的证书。
从 HAProxy 中删除一个 CRL 文件树条目。该 CRL 文件必须未被使用,并已从任何 crt-list 中移除。"show ssl crl-file" 命令显示 CRL 文件的状态。此删除操作对通过配置中的 "crl-file" 指令直接引用的证书无效。
del ssl crt-list <filename> <certfile[:line]>
删除 crt-list 中的一个条目。这将删除前端中用于此条目的所有 SNI。如果一个证书在 crt-list 中被多次使用,您需要提供想要删除的行号。要显示行号,请使用 "show ssl crt-list -n <crtlist>"。
del server <backend>/<server>
移除一个附加到后端 <backend> 的服务器。所有服务器都有资格被移除,除非该服务器被其他配置元素引用。服务器在删除之前必须被置于维护模式。如果服务器仍有活动或空闲连接,或者其连接队列不为空,则操作将被取消。
disable agent <backend>/<server>
将辅助代理检查标记为临时停止。在代理检查作为辅助检查运行的情况下(由于服务器指令的 agent-check 参数),只有当代理处于启用状态时才会初始化新的检查。因此,disable agent 将阻止任何新的代理检查被启动,直到使用 enable agent 重新启用代理。当代理被禁用时,对在代理启用时启动的辅助代理检查的处理如下:所有会改变权重的结果,特别是 "drain" 或代理返回的权重,都将被忽略。代理检查的其他处理方式保持不变。此功能的动机是允许暂停代理检查的权重更改效果,以便可以使用 set weight 配置服务器的权重,而不会被代理覆盖。此命令受限,并且只能在配置为 "admin" 级别的套接字上发出。
为后端 <backend> 禁用动态 cookie 的生成。
disable frontend <frontend>
将前端标记为临时停止。这对应于软重启期间使用的模式:前端释放端口,但如果需要可以再次启用。应谨慎使用此命令,因为一些非 Linux 操作系统无法重新启用它。这旨在用于那些甚至无法想象停止代理但必须修复配置错误的代理的环境中。这样就有可能释放端口并将其绑定到另一个进程以恢复操作。前端将在统计页面上显示为 "STOP" 状态。前端可以通过其名称或其数字 ID(前缀为井号 '#')指定。此命令受限,并且只能在配置为 "admin" 级别的套接字上发出。
disable health <backend>/<server>
将主健康检查标记为临时停止。这将禁用发送健康检查,并且最后的健康检查结果将被忽略。服务器将处于未检查状态并被认为是 UP,除非辅助代理检查强制其 down。此命令受限,并且只能在配置为 "admin" 级别的套接字上发出。
disable server <backend>/<server>
将服务器标记为 DOWN 进行维护。在此模式下,直到服务器离开维护模式,否则不会再对其进行检查。如果该服务器被其他服务器跟踪,那些服务器在维护期间也将被设置为 DOWN。在统计页面上,处于维护状态的服务器将显示 "MAINT" 状态,其跟踪服务器将显示 "MAINT(via)" 状态。后端和服务器都可以通过其名称或其数字 ID(前缀为井号 '#')指定。此命令受限,并且只能在配置为 "admin" 级别的套接字上发出。
enable agent <backend>/<server>
恢复临时停止的辅助代理检查。有关临时启动和停止辅助代理的效果的详细信息,请参见 "disable agent"。此命令受限,并且只能在配置为 "admin" 级别的套接字上发出。
为后端 <backend> 启用动态 cookie 的生成。还必须提供一个密钥。
enable frontend <frontend>
恢复一个临时停止的前端。某些监听端口可能无法再次绑定(例如:自'disable frontend'操作以来,另一个进程占用了它们)。如果发生这种情况,将显示错误。某些操作系统可能无法恢复被禁用的前端。前端可以通过其名称或其数字 ID(前缀为井号 '#')指定。此命令受限,并且只能在配置为 "admin" 级别的套接字上发出。
enable health <backend>/<server>
恢复一个临时停止的主健康检查。这将再次启用发送健康检查。详情请参见 "disable health"。此命令受限,并且只能在配置为 "admin" 级别的套接字上发出。
enable server <backend>/<server>
如果服务器之前被标记为 DOWN 进行维护,此命令将服务器标记为 UP 并重新启用检查。后端和服务器都可以通过其名称或其数字 ID(前缀为井号 '#')指定。此命令受限,并且只能在配置为 "admin" 级别的套接字上发出。
不带选项时,此命令指示当前连接的实验模式是启用还是禁用。当传递 "on" 时,它仅为当前 CLI 连接打开实验模式。使用 "off" 则关闭它。实验模式用于访问仍在开发中的额外功能。这些功能目前不稳定,应谨慎使用。它们可能会在不同版本之间发生重大变更。当从主 CLI 使用此命令时,不应带有前缀,因为它将在连接到任何工作进程的 CLI 时为其设置模式。
示例
echo "@1; experimental-mode on; <experimental_cmd>..." | socat /var/run/haproxy.master - echo "experimental-mode on; @1 <experimental_cmd>..." | socat /var/run/haproxy.master -
expert-mode [on|off]
此命令类似于 experimental-mode,但用于切换专家模式。专家模式启用显示专家命令,这些命令对进程可能极其危险,但偶尔可以帮助开发人员收集有关复杂错误的重要信息。任何滥用这些功能都可能导致进程崩溃。除非被邀请,否则不要使用此选项。请注意,此命令特意未在帮助信息中列出。此命令仅在 admin 级别下可用。切换到其他级别会自动重置专家模式。当从主 CLI 使用此命令时,不应带有前缀,因为它将在连接到任何工作进程的 CLI 时为其设置模式。
示例
echo "@1; expert-mode on; debug dev exit 1" | socat /var/run/haproxy.master - echo "expert-mode on; @1 debug dev exit 1" | socat /var/run/haproxy.master -
get map <map> <value>
get acl <acl> <value>
在map <map> 或 ACL <acl> 中查找值 <value>。<map> 或 <acl> 是"show map"或"show acl"返回的 #<id> 或 <file>。此命令返回与此map关联的所有匹配模式。这对于调试map和ACL非常有用。输出格式由每种匹配类型的一行组成。每行由空格分隔的一系列单词组成。前两个单词是: <match method>:应用的匹配方法。可以是"found"、"bool"、"int"、"ip"、"bin"、"len"、"str"、"beg"、"sub"、"dir"、"dom"、"end"或"reg"。 <match result>:结果。可以是"match"或"no-match"。只有当模式匹配一个条目时,才会返回以下单词。 <index type>:"tree"或"list"。内部查找算法。 <case>:"case-insensitive"或"case-sensitive"。大小写解释。 <entry matched>:match="<entry>"。返回匹配的模式。它对于正则表达式很有用。最后两个单词用于显示返回值及其类型。对于"acl"情况,模式不存在。 return=nothing:没有返回值,因为没有"map"。 return="<value>":以字符串格式返回的值。 return=cannot-display:该值无法转换为字符串。 type="<type>":返回样本的类型。
get var <name>
显示进程范围变量 'name' 的存在、类型和内容。只有进程范围的变量是可读的,所以名称必须以 'proc.' 开头,否则将找不到任何变量。此命令需要 "operator" 或 "admin" 级别。
get weight <backend>/<server>
报告后端 <backend> 中服务器 <server> 的当前权重和初始权重,如果任一不存在则报告错误。初始权重是配置文件中出现的权重。除非当前权重已被更改,否则两者通常相等。后端和服务器都可以通过其名称或其数字 ID(前缀为井号 '#')指定。
help [<command>]
打印已知关键字及其基本用法的列表,或与请求的命令匹配的命令。对于未知命令,也会显示相同的帮助屏幕。
httpclient <method> <URI>
发起一个 HTTP 客户端请求并在 CLI 上打印响应。仅在专家模式下运行的 CLI 连接上支持(参见 "expert-mode on")。这仅用于调试。httpclient 能够使用 "default" 解析器部分解析 URL 中的服务器名称,该部分默认填充了您 /etc/resolv.conf 中的 DNS 服务器。但是,如果您不使用可以解析这些主机的本地 dns 守护程序,它将无法解析 /etc/hosts 中的主机。
创建一个新的空 CA 文件树条目,用于填充一组 CA 证书并添加到 crt-list 中。此命令应与 "set ssl ca-file"、"add ssl ca-file" 和 "add ssl crt-list" 结合使用。
new ssl cert <filename>
创建一个新的空 SSL 证书存储,用于填充证书并添加到目录或 crt-list 中。此命令应与 "set ssl cert" 和 "add ssl crt-list" 结合使用。
创建一个新的空 CRL 文件树条目,用于填充一组 CRL 并添加到 crt-list 中。此命令应与 "set ssl crl-file" 和 "add ssl crt-list" 结合使用。
在 ACL <acl> 中分配一个新的版本号,用于原子替换。<acl> 是由“show acl”返回的 #<id> 或 <file>。新的版本号在响应中显示在 "New version created:" 之后。这个号码随后可用于准备向 ACL 中添加新条目,这些条目在提交后将原子地替换当前条目。它在“show acl”中报告为 "next_ver"。分配新版本没有影响,因为一旦提交了更新的版本,未使用的版本将自动被移除。版本号是无符号的 32 位值,在达到最大值后会回绕,因此在外部程序中比较它们时必须小心。如果引用的 <acl> 是一个也用作 map 的文件,则不能使用此命令。在这种情况下,必须改用“prepare map”命令。
在 map <map> 中分配一个新的版本号,用于原子替换。<map> 是由“show map”返回的 #<id> 或 <file>。新的版本号在响应中显示在 "New version created:" 之后。这个号码随后可用于准备向 map 中添加新条目,这些条目在提交后将原子地替换当前条目。它在“show map”中报告为 "next_ver"。分配新版本没有影响,因为一旦提交了更新的版本,未使用的版本将自动被移除。版本号是无符号的 32 位值,在达到最大值后会回绕,因此在外部程序中比较它们时必须小心。
切换行首的提示符,并进入或离开交互模式。在交互模式下,命令完成后连接不会关闭。相反,提示符会再次出现,表示解释器正在等待新命令。提示符由一个右尖括号后跟一个空格“> ”组成。当希望定期检查信息(如统计数据或错误)时,此模式特别方便。在发出“help”命令之前进入交互模式也是一个好主意。
在交互模式下关闭连接。
set anon [on|off] [<key>]
此命令启用或禁用当前CLI会话的“匿名模式”,该模式将命令输出中被认为敏感或机密的某些字段替换为哈希值,这些哈希值在元素之间保持足够的连贯性,以帮助开发人员在尝试发现错误时识别元素之间的关系,但位计数足够低(24位),由于可能的匹配数量很高,使其不可逆转。当开启时,如果没有指定键,将使用全局键(由配置文件中的"anonkey"指定,或通过CLI命令"set anon global-key"设置)。如果未设置此类键,将生成一个随机键。否则,可以指定用于当前会话的32位键,例如,重用以前转储中使用的键以帮助比较输出。开发人员永远不需要此键,建议永远不要共享它,因为它可能允许确认/否认关于某些哈希值可能隐藏的内容的猜测。
修改用于生成动态持久性 cookie 的密钥。这将破坏现有会话。
此命令将全局匿名化密钥设置为 <key>,该值必须是 0 到 4294967295 之间的 32 位整数(0 表示禁用全局密钥)。此命令需要管理员权限。
set map <map> [<key>|#<ref>] <value>
修改 map <map> 中每个键 <key> 对应的值。<map> 是由“show map”返回的 #<id> 或 <file>。如果使用 <ref> 代替 <key>,则只更改 <ref> 指向的条目。新值为 <value>。
set maxconn frontend <frontend> <value>
动态更改指定前端的 maxconn 设置。允许任何正值,包括零,但设置大于全局 maxconn 的值没有太大意义。如果限制增加并且有待处理的连接,它们将立即被接受。如果限制降低到低于当前连接数的水平,新连接的接受将被延迟,直到达到阈值。前端可以通过其名称或其前缀为井号('#')的数字 ID 来指定。
set maxconn server <backend/server> <value>
动态更改指定服务器的 maxconn 设置。允许任何正值,包括零,但设置大于全局 maxconn 的值没有太大意义。
在初始全局 maxconn 设置定义的范围内动态更改全局 maxconn 设置。如果它被增加并且有待处理的连接,它们将立即被接受。如果它被降低到低于当前连接数的水平,新连接的接受将被延迟,直到达到阈值。值为零将恢复初始设置。
set profiling { tasks | memory } { auto | on | off }
为指定的子系统启用或禁用 CPU 或内存分析。这相当于在配置文件的 "global" 部分设置或清除 "profiling" 设置。另请参阅 "show profiling"。请注意,手动将任务分析设置为 "on" 会自动重置调度器统计信息,从而允许检查给定时间间隔内的活动。内存分析仅限于某些操作系统(已知在 linux-glibc 目标上有效),并且需要在编译时设置 USE_MEMORY_PROFILING。
更改进程范围的连接速率限制,该限制由全局 'maxconnrate' 设置。值为零表示禁用限制。此限制适用于所有前端,并且更改会立即生效。值以每秒连接数的形式传递。
更改最大输入压缩速率,该速率由全局 'maxcomprate' 设置。值为零表示禁用限制。值以每秒千字节数的形式传递。该值可在 "show info" 的 "CompressBpsRateLim" 行中以字节为单位查看。
更改进程范围的会话速率限制,该限制由全局 'maxsessrate' 设置。值为零表示禁用限制。此限制适用于所有前端,并且更改会立即生效。值以每秒会话数的形式传递。
更改进程范围的 SSL 会话速率限制,该限制由全局 'maxsslrate' 设置。值为零表示禁用限制。此限制适用于所有前端,并且更改会立即生效。值以每秒发送到 SSL 堆栈的会话数的形式传递。它在握手之前应用,以保护堆栈免受握手滥用。
set server <backend>/<server> addr <ip4 or ip6 address> [port <port>]
用提供的 IP 地址替换服务器的当前 IP 地址。可选地,可以使用 'port' 参数更改端口。请注意,更改端口也支持从端口映射(表示为 +X 或 -Y)切换或切换到端口映射,前提是为健康检查配置了端口。
set server <backend>/<server> agent [ up | down ]
强制服务器的代理进入新状态。例如,这对于不考虑某些缓慢的代理检查而立即切换服务器状态非常有用。请注意,如果有跟踪服务器,此更改将传播到它们。
set server <backend>/<server> agent-addr <addr> [port <port>]
更改服务器代理检查的地址。允许在运行时将代理检查迁移到另一个地址。您可以指定 IP 和主机名,它将被解析。可选地,更改代理端口。
set server <backend>/<server> agent-port <port>
更改用于代理检查的端口。
set server <backend>/<server> agent-send <value>
更改发送到代理检查目标的代理字符串。允许在更改服务器地址时更新字符串以保持两者匹配。
set server <backend>/<server> health [ up | stopping | down ]
强制服务器的健康状态进入新状态。例如,这对于不考虑某些缓慢的健康检查而立即切换服务器状态非常有用。请注意,如果有跟踪服务器,此更改将传播到它们。
set server <backend>/<server> check-addr <ip4 | ip6> [port <port>]
更改用于服务器健康检查的 IP 地址。可选地,更改用于服务器健康检查的端口。
set server <backend>/<server> check-port <port>
将用于健康检查的端口更改为 <port>
set server <backend>/<server> state [ ready | drain | maint ]
强制服务器的管理状态进入新状态。这对于禁用负载均衡和/或到服务器的任何流量非常有用。将状态设置为 "ready" 会使服务器进入正常模式,该命令等同于 "enable server" 命令。将状态设置为 "maint" 会禁用任何到服务器的流量以及任何健康检查。这等同于 "disable server" 命令。将模式设置为 "drain" 只会从负载均衡中移除服务器,但仍允许其被检查并接受新的持久连接。如果有跟踪服务器,更改将传播到它们。
set server <backend>/<server> weight <weight>[%]
将服务器的权重更改为参数中传递的值。这与下面的 "set weight" 命令完全等效。
set server <backend>/<server> fqdn <FQDN>
将服务器的 FQDN 更改为参数中传递的值。这要求为该服务器配置并启用了内部运行时 DNS 解析器。
set server <backend>/<server> ssl [ on | off ] (已弃用)
此选项配置到服务器的出向连接的 SSL 加密。关闭时,所有流量都变为明文;健康检查路径不变。此命令已弃用,请改用 "add server" 命令动态创建带或不带 SSL 的新服务器。
set severity-output [ none | number | string ]
更改当前会话期间连接的 stats socket 的严重性输出格式。
set ssl ca-file <cafile> <payload>
此命令是事务系统的一部分,可能需要 "commit ssl ca-file" 和 "abort ssl ca-file" 命令。如果没有正在进行的事务,它将创建一个 CA 文件树条目,其中将存储 payload 中包含的证书。该 CA 文件条目不会存储在 CA 文件树中,只会保存在一个临时事务中。如果已存在同名文件的事务,则前一个 CA 文件条目将被删除并由新的替换。完成修改后,您必须通过调用 "commit ssl ca-file" 来提交事务。如果您想分别添加多个证书,可以使用 "add ssl ca-file" 命令。
示例
echo -e "set ssl ca-file cafile.pem <<\n$(cat rootCA.crt)\n" | \ socat /var/run/haproxy.stat - echo "commit ssl ca-file cafile.pem" | socat /var/run/haproxy.stat -
set ssl cert <filename> <payload>
此命令是事务系统的一部分,可能需要"commit ssl cert"和"abort ssl cert"命令。整个事务系统适用于"show ssl cert"命令显示的任何证书,因此适用于任何前端或后端证书。如果没有正在进行的事务,它将在内存中复制证书 <filename> 到一个临时事务中,然后使用有效载荷中的PEM文件更新此事务。如果存在具有相同文件名的事务,它将更新此事务。也可以更新与证书链接的文件(.issuer、.sctl、.oscp等)。修改完成后,您必须"commit ssl cert"该事务。通过CLI注入文件时必须小心,因为空行用于通知有效载荷的结束。建议注入经过清理的PEM文件。一个简单的方法是删除所有空行,只保留PEM部分中的内容。这可以通过sed命令实现。
示例
# 经过一些简单清理 echo -e "set ssl cert localhost.pem <<\n$(sed -n '/^$/d;/-BEGIN/,/-END/p' 127.0.0.1.pem)\n" | \ socat /var/run/haproxy.stat - # 包含提交的完整示例 echo -e "set ssl cert localhost.pem <<\n$(cat 127.0.0.1.pem)\n" | \ socat /var/run/haproxy.stat - echo -e \ "set ssl cert localhost.pem.issuer <<\n $(cat 127.0.0.1.pem.issuer)\n" | \ socat /var/run/haproxy.stat - echo -e \ "set ssl cert localhost.pem.ocsp <<\n$(base64 -w 1000 127.0.0.1.pem.ocsp)\n" | \ socat /var/run/haproxy.stat - echo "commit ssl cert localhost.pem" | socat /var/run/haproxy.stat -
set ssl crl-file <crlfile> <payload>
此命令是事务系统的一部分,可能需要 "commit ssl crl-file" 和 "abort ssl crl-file" 命令。如果没有正在进行的事务,它将创建一个 CRL 文件树条目,其中将存储 payload 中包含的撤销列表。CRL 文件条目不会存储在 CRL 文件树中,只会保存在一个临时事务中。如果已存在同名文件的事务,则前一个 CRL 文件条目将被删除并由新的替换。完成修改后,您必须通过调用 "commit ssl crl-file" 来提交事务。
示例
echo -e "set ssl crl-file crlfile.pem <<\n$(cat rootCRL.pem)\n" | \ socat /var/run/haproxy.stat - echo "commit ssl crl-file crlfile.pem" | socat /var/run/haproxy.stat -
set ssl ocsp-response <response | payload>
此命令用于更新证书的 OCSP 响应(参见 "bind" 行上的 "crt")。执行的控制与初始加载响应时相同。<response> 必须作为来自 OCSP 服务器的 DER 编码响应的 base64 编码字符串传递。BoringSSL 不支持此命令。
示例
openssl ocsp -issuer issuer.pem -cert server.pem \ -host ocsp.issuer.com:80 -respout resp.der echo "set ssl ocsp-response $(base64 -w 10000 resp.der)" | \ socat stdio /var/run/haproxy.stat 使用 payload 语法:echo -e "set ssl ocsp-response <<\n$(base64 resp.der)\n" | \ socat stdio /var/run/haproxy.stat
set ssl tls-key <id> <tlskey>
将 <id> 侦听器的下一个 TLS 密钥设置为 <tlskey>。此密钥成为最终密钥,而倒数第二个密钥用于加密(其他密钥仅用于解密)。最旧的 TLS 密钥将被覆盖。<id> 是由 "show tls-keys" 返回的数字 #<id> 或 <file>。<tlskey> 是 base64 编码的 48 位或 80 位 TLS 票证密钥(例如:openssl rand 80 | openssl base64 -A)。
set table <table> key <key> [data.<data_type> <value>]*
在 stick-table 中创建或更新一个条目。如果键不存在,则插入一个条目。请参阅 4.2 节 中的 stick-table 以查找 <data_type> 的所有可能值。最常见的用途是动态输入源 IP 地址的条目,并在 gpc0 中设置一个标志来动态阻止 IP 地址或影响其服务质量。可以在单次调用中传递多个 data_type。
更改当前连接的 CLI 接口超时。这在长时间的调试会话中非常有用,用户需要不断检查一些指标而不会被断开连接。延迟以秒为单位传递。
set var <name> <expression>
set var <name> expr <expression>
set var <name> fmt <format>
允许使用表达式 <expression> 或格式字符串 <format> 的结果来设置或覆盖进程范围的变量 'name'。只能使用进程范围的变量,因此名称必须以 'proc.' 开头,否则不会设置任何变量。<expression> 和 <format> 只能涉及“内部”样本获取关键字和转换器,尽管最可能有用的将是 str('something')、int()、简单字符串或其他变量的引用。请注意,命令行解析器不识别引号,因此表达式中的任何空格都必须以反斜杠开头。此命令需要 "operator" 或 "admin" 级别。此命令仅在以实验模式(experimental-mode on)运行的 CLI 连接上受支持。
set weight <backend>/<server> <weight>[%]
将服务器的权重更改为参数中传递的值。如果值以 '%' 符号结尾,则新权重将相对于初始配置的权重。绝对权重允许在0到256之间。相对权重必须为正,且 resulting absolute weight is capped at 256(resulting absolute weight is capped at 256)。运行静态负载均衡算法的服务器组具有更严格的限制,因为权重一旦设置就无法更改。因此,对于这些服务器,唯一接受的值是0和100%(或0和初始权重)。更改会立即生效,尽管某些LB算法需要一定数量的请求才能考虑更改。此命令的典型用法是在更新期间通过将其权重设置为零来禁用服务器,然后在更新后通过将其权重设置回100%来再次启用它。此命令受限制,只能在配置为"admin"级别的socket上发出。后端和服务器都可以通过其名称或数字ID指定,并以井号('#')为前缀。
show acl [[@<ver>] <acl>]
转储有关 acl 转换器的信息。不带参数时,返回所有可用 acl 的列表。如果指定了 <acl>,则转储其内容。<acl> 是 #<id> 或 <file>。默认情况下,显示 ACL 的当前版本(当前用于匹配并报告为 ACL 列表中的 'curr_ver' 的版本)。可以通过在 ACL 标识符前加上 '@<ver>' 来转储其他版本。版本用作过滤器,不存在的版本将不会报告任何结果。转储格式与 map 相同,即使对于样本值也是如此。返回的数据不是可用 ACL 的列表,而是构成任何 ACL 的所有模式的列表。这些模式中的许多可以与 map 共享。'entry_cnt' 值表示所有 ACL 条目的计数,而不仅仅是活动条目,这意味着它也包括当前正在添加的条目。
显示匿名模式的当前状态(启用或禁用)和当前会话的密钥。
转储正在运行的进程中可用的后端列表。
显示当前 CLI 会话的 CLI 级别。结果可能是 'admin'、'operator' 或 'user'。另请参阅 'operator' 和 'user' 命令。
示例
$ socat /tmp/sock1 readline prompt > operator > show cli level operator > user > show cli level user > operator 权限被拒绝
将当前 CLI 会话的 CLI 级别降低到 operator。此级别无法提升。它还会放弃专家模式和实验模式。另请参阅 "show cli level"。
将当前 CLI 会话的 CLI 级别降低到 user。此级别无法提升。它还会放弃专家模式和实验模式。另请参阅 "show cli level"。
show activity [-1 | 0 | thread_num]
报告有关内部事件的一些计数器,这些计数器将帮助开发人员以及更一般地了解haproxy的人缩小异常行为报告的原因。一个典型的例子是正常运行的进程从不休眠并占用100%的CPU。输出字段将由每行一个指标组成,同一行上包含按线程的计数器。这些计数器是32位的,并且会在进程生命周期内溢出,这不是问题,因为通常会对该命令执行两次调用。这些字段故意未文档化,以便在代码中验证其确切含义,其中计数器被馈送。这些值也会被"clear counters"命令重置。在多线程部署中,第一列将指示所有线程的总计(或平均值,取决于指标的性质),所有线程的值列表将以线程顺序显示在方括号之间。可以选择在参数中指定要转储的线程号。特殊值"0"将报告聚合值(第一列),"-1"(默认值)将显示所有列。请注意,就像在单线程模式下一样,请求单列时不会有方括号。
列出 CLI 套接字。输出格式由 3 个以空格分隔的字段组成。第一个字段是套接字地址,可以是 unix 套接字、ipv4 地址:端口对或 ipv6 地址:端口对。其他类型的套接字不会被转储。第二个字段描述套接字的级别:'admin'、'user' 或 'operator'。最后一个字段列出套接字绑定的进程,用逗号分隔,可以是数字或 'all'。
示例
$ echo 'show cli sockets' | socat stdio /tmp/sock1 # socket lvl processes /tmp/sock1 admin all 127.0.0.1:9999 user 2,3,4 127.0.0.2:9969 user 2 [::1]:9999 operator 2
列出已配置的缓存以及每个缓存树中存储的对象。$ echo 'show cache' | socat stdio /tmp/sock1 0x7f6ac6c5b03a: foobar (shctx:0x7f6ac6c5b000, available blocks:3918) 1 2 3 4 1. 指向缓存结构的指针 2. 缓存名称 3. 指向 mmap 区域 (shctx) 的指针 4. shctx 中可供重用的块数 0x7f6ac6c5b4cc hash:286881868 vary:0x0011223344556677 size:39114 (39 blocks), refcount:9, expire:237 1 2 3 4 5 6 7 1. 指向缓存条目的指针 2. 哈希的前 32 位 3. 在 vary 的情况下条目的次要哈希 4. 对象的字节大小 5. 对象使用的块数 6. 使用该条目的事务数 7. 过期时间,如果已过期则可能为负数
此命令旨在集中HAProxy开发人员可能需要的一些信息,以便更好地理解给定问题的原因。它通常不为用户提供有用的信息,但这些信息允许开发人员消除某些假设。格式大致是一系列部分,其中包含每行一个元素的缩进行,例如OS类型和版本、CPU类型或启动时FD限制。为了避免重复或输出污染,某些字段将被省略(例如无限值)。未来可能会出现更多字段,有些可能会更改。此输出不适合脚本解析,不应被视为具有高度可靠性,它主要是为了节省能够阅读它的人的时间。从技术上讲,此类信息是从内部结构中按原样获取的,该结构在启动时将它们存储在一起,以便在崩溃后也可以在核心文件中找到它们。因此,开发人员可能会要求对行为良好的进程进行早期输出,以便与在核心转储中找到的内容进行比较,或在几次重新加载之间进行比较(例如,某些限制可能会更改)。如果启用了匿名化,任何可能的敏感值也将被匿名化(例如节点名称)。输出示例: $ socat stdio /tmp/sock1 <<< "show dev" Platform info machine vendor: To be filled by O.E.M machine family: Altra cpu model: Impl 0x41 Arch 8 Part 0xd0c r3p1 virtual machine: no container: no OS name: Linux OS release: 6.2.0-36-generic OS version: #37~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Mon Oct 9 18:01:07 UTC 2 OS architecture: aarch64 node name: 489aaf Process info pid: 1735846 boot uid: 509 boot gid: 1002 fd limit (soft): 1024 fd limit (hard): 1048576
show env [<name>]
转储进程已知的一个或所有环境变量。不带任何参数时,将转储所有变量。带一个参数时,如果指定的变量存在,则仅转储该变量。否则将输出 "Variable not found"。变量的转储格式与它们存储或由 "env" 实用程序返回的格式相同,即 "<name>=<value>"。这在调试大量使用环境变量的某些配置文件时非常方便,以确保它们包含预期的值。此命令受限,并且只能在配置为 "operator" 或 "admin" 级别的套接字上发出。
show errors [<iid>|<proxy>] [request|response]
转储前端和后端收集的最后已知请求和响应错误。如果指定了 <iid>,则将转储限制为与ID为 <iid> 的前端或后端相关的错误。代理ID "-1"将导致转储所有实例。如果指定了代理名称,则将其ID用作过滤器。如果在代理名称或ID之后添加"request"或"response",则仅转储请求或响应错误。此命令受到限制,只能在配置为"operator"或"admin"级别的socket上发出。可能收集的错误是由于协议违规导致的最后请求和响应错误,通常是由于头部名称中存在无效字符。报告精确地指示了哪个确切字符违反了协议。还会报告其他重要信息,例如检测到错误的精确日期、前端和后端名称、服务器名称(如果已知)、内部事务ID以及发起会话的源地址。所有字符都会返回,不可打印字符会被编码。最常见的字符(\t = 9, \n = 10, \r = 13 和 \e = 27)被编码为反斜杠后跟一个字母。反斜杠本身被编码为'\\'以避免混淆。其他不可打印字符被编码为'\xNN',其中NN是字符ASCII码的两位十六进制表示。行以其第一个字符的位置为前缀,从缓冲区的开头0开始。每行最多打印一行输入,大行将被分解为多个连续的输出行,以便输出宽度永远不会超过79个字符。很容易检测到一行是否被分解,因为它不会以'\n'结尾,并且下一行的偏移量后面会跟着一个'+'号,表示它是前一行的延续。
示例
$ echo "show errors -1 response" | socat stdio /tmp/sock1 >>> [04/Mar/2009:15:46:56.081] backend http-in (#2) : invalid response src 127.0.0.1, session #54, frontend fe-eth0 (#1), server s2 (#1) response length 213 bytes, error at position 23: 00000 HTTP/1.0 200 OK\r\n 00017 header/bizarre:blah\r\n 00038 Location: blah\r\n 00054 Long-line: this is a very long line which should b 00104+ e broken into multiple lines on the output buffer, 00154+ otherwise it would be too large to print in a ter 00204+ minal\r\n 00211 \r\n 在上面的示例中,我们看到内部ID为2的后端"http-in"阻止了来自内部ID为1的服务器s2的无效响应。该请求是在事务54(此处称为"session")上,由源127.0.0.1发起,并由ID为1的前端fe-eth0接收。检测到错误时,总响应长度为213字节,错误位于字节23处。这是头部名称"header/bizarre"中的斜杠('/'),它不是头部名称的有效HTTP字符。
show events [<sink>] [-w] [-n]
不带选项时,此命令列出所有已知的事件接收器及其类型。带选项时,如果指定的接收器类型为缓冲区,则会转储该接收器中的所有可用事件。如果在接收器名称后传递“-w”选项,则一旦到达缓冲区末尾,命令将等待新事件并显示它们。可以通过输入任何内容(将被丢弃)或关闭会话来停止操作。最后,“-n”选项用于直接定位到缓冲区的末尾,这通常在与“-w”结合使用时很方便,以便只报告新事件。为方便起见,可以使用“-wn”或“-nw”来同时启用这两个选项。
show fd [-!plcfbsd]* [<fd>]
转储所有打开文件描述符的列表,或者如果指定了数字 <fd>,则仅转储该描述符。可以选择性地传递一组标志来将转储限制为某些FD类型或省略某些FD类型。当遇到 '-' 或 '!' 时,选择将反转同一参数中后续字符的选择。反转在每个由空白分隔的参数词之前重置。可选的FD类型包括 'p' 用于管道,'l' 用于监听器,'c' 用于连接(任何类型),'f' 用于前端连接,'b' 用于后端连接(任何类型),'s' 用于到服务器的连接,'d' 用于到"dispatch"地址或后端透明地址的连接。因此,'b' 是 'sd' 的快捷方式,'c' 是 'fb' 或 'fsd' 的快捷方式。'c!f' 等同于 'b'("除前端连接外的任何连接"确实是后端连接)。这仅针对需要观察内部状态以调试复杂问题(例如异常CPU使用率)的开发人员。每行报告一个fd,对于每个fd,其在poller中的状态使用大写字母表示启用的标志,小写字母表示禁用的标志,其中"P"表示"polled"(轮询),"R"表示"ready"(就绪),"A"表示"active"(活动),事件状态使用"H"表示"hangup"(挂起),"E"表示"error"(错误),"O"表示"output"(输出),"P"表示"priority"(优先级),"I"表示"input"(输入),以及一些其他标志,例如"N"表示"new"(刚添加到fd缓存中),"U"表示"updated"(在fd缓存中收到更新),"L"表示"linger_risk","C"表示"cloned"(克隆),然后是缓存条目位置、指向内部所有者的指针、指向I/O回调的指针及其名称(如果已知)。当所有者是连接时,报告连接标志和目标(前端、代理或服务器)。当所有者是监听器时,报告监听器的状态及其前端。如果没有对内部有很好的了解,使用此命令毫无意义。值得注意的是,输出格式可能会随时间演变,因此此输出不得由旨在持久的工具解析。某些内部结构状态可能看起来可疑,在这种情况下,输出行将后缀一个感叹号('!')。这可能有助于在诊断事件时找到起点。
show info [typed|json] [desc] [float]
转储有关当前进程haproxy状态的信息。如果将"typed"作为可选参数传递,则还会发出字段编号、名称和类型,以便外部监控产品可以轻松检索、可能聚合,然后报告在它们不了解的字段中找到的信息。每个字段都转储在自己的行上。如果将"json"作为可选参数传递,则"typed"输出提供的信息将以JSON格式作为JSON对象列表提供。默认情况下,格式仅包含由冒号(':')分隔的两列。左边是字段名称,右边是值。非常重要的一点是,在typed output format中,单个对象的转储是连续的,因此消费者无需一次存储所有内容。如果将"float"作为可选参数传递,通常作为整数发出的某些字段可能会切换为浮点数以获得更高的精度。哪些字段受到影响故意未指定,因为这可能会随时间演变。使用此选项意味着消费者能够处理浮点数。使用的输出格式是sprintf("%f")。当使用typed output format时,每行由由冒号(':')分隔的4列组成。第一列是由点分隔的3个元素系列。第一个元素是字段在列表中的数字位置(从零开始)。这个位置不会随时间改变,但可能会出现空缺,具体取决于构建选项或将来是否删除某些字段。第二个元素是字段名称,它出现在默认的"show info"输出中。第三个元素是相对进程号,从1开始。从第一个冒号开始的行的其余部分遵循上面部分中描述的"typed output format"。简而言之,第二列(在第一个':'之后)指示变量的来源、性质和范围。第三列指示字段的类型,包括"s32"、"s64"、"u32"、"u64"和"str"。然后第四列是值本身,消费者根据第3列知道如何解析它,并根据第2列知道如何处理它。因此,在typed模式下,整体行格式为: <field_pos>.<field_name>.<process_num>:<tags>:<type>:<value> 当将"desc"附加到命令时,会附加一个额外的冒号,后面跟着一个带引号的字符串,其中包含对指标的描述。在撰写本文时,这仅支持"typed"和默认输出格式。
示例
> show info Name: HAProxy Version: 1.7-dev1-de52ea-146 Release_date: 2016/03/11 Nbproc: 1 Process_num: 1 Pid: 28105 Uptime: 0d 0h00m04s Uptime_sec: 4 Memmax_MB: 0 PoolAlloc_MB: 0 PoolUsed_MB: 0 PoolFailed: 0 (...) > show info typed 0.Name.1:POS:str:HAProxy 1.Version.1:POS:str:1.7-dev1-de52ea-146 2.Release_date.1:POS:str:2016/03/11 3.Nbproc.1:CGS:u32:1 4.Process_num.1:KGP:u32:1 5.Pid.1:SGP:u32:28105 6.Uptime.1:MDP:str:0d 0h00m08s 7.Uptime_sec.1:MDP:u32:8 8.Memmax_MB.1:CLP:u32:0 9.PoolAlloc_MB.1:MGP:u32:0 10.PoolUsed_MB.1:MGP:u32:0 11.PoolFailed.1:MCP:u32:0 (...)
在类型化格式中,第一列末尾的进程ID使得从多个进程的输出中进行视觉聚合变得非常容易。
示例
$ ( echo show info typed | socat /var/run/haproxy.sock1 ; \ echo show info typed | socat /var/run/haproxy.sock2 ) | \ sort -t . -k 1,1n -k 2,2 -k 3,3n 0.Name.1:POS:str:HAProxy 0.Name.2:POS:str:HAProxy 1.Version.1:POS:str:1.7-dev1-868ab3-148 1.Version.2:POS:str:1.7-dev1-868ab3-148 2.Release_date.1:POS:str:2016/03/11 2.Release_date.2:POS:str:2016/03/11 3.Nbproc.1:CGS:u32:2 3.Nbproc.2:CGS:u32:2 4.Process_num.1:KGP:u32:1 4.Process_num.2:KGP:u32:2 5.Pid.1:SGP:u32:30120 5.Pid.2:SGP:u32:30121 6.Uptime.1:MDP:str:0d 0h01m28s 6.Uptime.2:MDP:str:0d 0h01m28s (...)
JSON 输出的格式在一个 schema 中描述,可以使用“show schema json”输出该 schema。JSON 输出不包含额外的空白字符,以减少输出量。为了方便人类阅读,可以通过一个美化打印器来处理输出。示例:$ echo "show info json" | socat /var/run/haproxy.sock stdio | \ python -m json.tool JSON 输出不包含额外的空白字符,以减少输出量。为了方便人类阅读,可以通过一个美化打印器来处理输出。示例:$ echo "show info json" | socat /var/run/haproxy.sock stdio | \ python -m json.tool
在支持此功能的系统上,转储已加载的共享动态库和对象文件的列表。如果可用,对于每个共享对象,将指示虚拟地址范围、大小和对象路径。这可以用于例如尝试估计哪个库提供了出现在转储中的函数。请注意,在许多系统上,地址会在每次重启时改变(地址空间随机化),因此如果期望使用此列表来分析核心文件,则需要在启动时检索它。此命令只能在配置为“operator”或“admin”级别的套接字上发出。请注意,输出格式可能因操作系统、体系结构甚至 haproxy 版本而异,不应在脚本中依赖它。
show map [[@<ver>] <map>]
转储有关map转换器的信息。如果没有参数,则返回所有可用map的列表。如果指定了 <map>,则转储其内容。<map> 是 #<id> 或 <file>。默认情况下,显示map的当前版本(当前正在匹配的版本,在map列表中报告为'curr_ver')。可以通过在map标识符前添加'@<ver>'来转储其他版本。版本充当过滤器,不存在的版本将简单地报告没有结果。'entry_cnt'值表示所有map条目的计数,而不仅仅是活动条目,这意味着它还包括当前正在添加的条目。在输出中,第一列是唯一的条目标识符,可用作"del map"和"set map"操作的引用。第二列是模式,第三列是样本(如果可用)。返回的数据不是可用map的直接列表,而是构成任何map的所有模式的列表。其中许多模式可以与ACL共享。
show peers [dict|-] [<peers section>]
转储在"peers"部分配置的对等体信息。没有参数时,列出属于所有"peers"部分的所有对等体。如果指定了 <peers section>,则仅转储属于此"peers"部分的对等体信息。当在对等部分名称之前指定"dict"时,整个Tx/Rx字典缓存也将被转储(非常大)。可能需要传递"-"来转储名为"dict"的对等部分。这里有两个输出示例,其中hostA、hostB和hostC对等体属于"sharedlb"对等部分。只有hostA和hostB已连接。只有hostA向hostB发送了数据。 $ echo "show peers" | socat - /tmp/hostA 0x55deb0224320: [15/Apr/2019:11:28:01] id=sharedlb state=0 flags=0x3 \ resync_timeout=<PAST> task_calls=45122 0x55deb022b540: id=hostC(remote) addr=127.0.0.12:10002 status=CONN \ reconnect=4s confirm=0 flags=0x0 0x55deb022a440: id=hostA(local) addr=127.0.0.10:10000 status=NONE \ reconnect=<NEVER> confirm=0 flags=0x0 0x55deb0227d70: id=hostB(remote) addr=127.0.0.11:10001 status=ESTA reconnect=2s confirm=0 flags=0x20000200 appctx:0x55deb028fba0 st0=7 st1=0 task_calls=14456 \ state=EST xprt=RAW src=127.0.0.1:37257 addr=127.0.0.10:10000 remote_table:0x55deb0224a10 id=stkt local_id=1 remote_id=1 last_local_table:0x55deb0224a10 id=stkt local_id=1 remote_id=1 shared tables: 0x55deb0224a10 local_id=1 remote_id=1 flags=0x0 remote_data=0x65 last_acked=0 last_pushed=3 last_get=0 teaching_origin=0 update=3 table:0x55deb022d6a0 id=stkt update=3 localupdate=3 \ commitupdate=3 syncing=0 $ echo "show peers" | socat - /tmp/hostB 0x55871b5ab320: [15/Apr/2019:11:28:03] id=sharedlb state=0 flags=0x3 \ resync_timeout=<PAST> task_calls=3 0x55871b5b2540: id=hostC(remote) addr=127.0.0.12:10002 status=CONN \ reconnect=3s confirm=0 flags=0x0 0x55871b5b1440: id=hostB(local) addr=127.0.0.11:10001 status=NONE \ reconnect=<NEVER> confirm=0 flags=0x0 0x55871b5aed70: id=hostA(remote) addr=127.0.0.10:10000 status=ESTA \ reconnect=2s confirm=0 flags=0x20000200 appctx:0x7fa46800ee00 st0=7 st1=0 task_calls=62356 \ state=EST remote_table:0x55871b5ab960 id=stkt local_id=1 remote_id=1 last_local_table:0x55871b5ab960 id=stkt local_id=1 remote_id=1 shared tables: 0x55871b5ab960 local_id=1 remote_id=1 flags=0x0 remote_data=0x65 last_acked=3 last_pushed=0 last_get=3 teaching_origin=0 update=0 table:0x55871b5b46a0 id=stkt update=1 localupdate=0 \ commitupdate=0 syncing=0
show pools [byname|bysize|byusage] [match <pfx>] [<nb>]
转储内部内存池的状态。这对于在怀疑内存泄漏时跟踪内存使用情况非常有用。它与在前台运行时发送SIGQUIT完全相同,只是它不会刷新池。默认情况下,输出不排序。如果指定"byname",则按池名称排序;如果指定"bysize",则按项目大小降序排序;如果指定"byusage",则按总使用量降序排序,并且仅显示使用的条目。也可以将输出限制为前 <nb> 个条目(例如,按使用量排序时)。最后,如果指定"match"后跟一个前缀,则只显示名称以此前缀开头的池。报告的总数仅涉及与过滤条件匹配的池。示例: $ socat - /tmp/haproxy.sock <<< "show pools match quic byusage" Dumping pools usage. Use SIGQUIT to flush them. - Pool quic_conn_r (65560 bytes) : 1337 allocated (87653720 bytes), ... - Pool quic_crypto (1048 bytes) : 6685 allocated (7005880 bytes), ... - Pool quic_conn (4056 bytes) : 1337 allocated (5422872 bytes), ... - Pool quic_rxbuf (262168 bytes) : 8 allocated (2097344 bytes), ... - Pool quic_conne (184 bytes) : 9359 allocated (1722056 bytes), ... - Pool quic_frame (184 bytes) : 7938 allocated (1460592 bytes), ... - Pool quic_tx_pac (152 bytes) : 6454 allocated (981008 bytes), ... - Pool quic_tls_ke (56 bytes) : 12033 allocated (673848 bytes), ... - Pool quic_rx_pac (408 bytes) : 1596 allocated (651168 bytes), ... - Pool quic_tls_se (88 bytes) : 6685 allocated (588280 bytes), ... - Pool quic_cstrea (88 bytes) : 4011 allocated (352968 bytes), ... - Pool quic_tls_iv (24 bytes) : 12033 allocated (288792 bytes), ... - Pool quic_dgram (344 bytes) : 732 allocated (251808 bytes), ... - Pool quic_arng (56 bytes) : 4011 allocated (224616 bytes), ... - Pool quic_conn_c (152 bytes) : 1337 allocated (203224 bytes), ... Total: 15 pools, 109578176 bytes allocated, 109578176 used ...
show profiling [{all | status | tasks | memory}] [byaddr|bytime|aggr|<max_lines>]*
转储当前的分析设置,每行一个,以及更改它们所需的命令。启用任务分析时,调度程序收集的某些按函数统计信息也将发出,其中包括调用次数、总计/平均CPU时间和总计/平均延迟的摘要。启用内存分析时,将报告一些信息,例如分配/释放的数量及其大小。可以通过指定相应的关键字将转储限制为仅分析状态、任务或内存分析;默认情况下,将转储所有分析信息。也可以通过指定数字限制来限制每种类别的输出行数。如果可以请求按地址或按总执行时间而不是按使用量对输出进行排序,例如,以便于后续调用之间的比较或检查需要优化的地方,以及按被调用函数聚合任务活动而不是查看详细信息。请注意,分析本质上是针对开发人员的,因为它提供了有关CPU周期或内存浪费在代码中的位置的提示。那里没有任何有用的监控信息。
show resolvers [<resolvers section id>]
转储给定解析器部分的统计信息,如果未提供部分,则转储所有解析器部分。对于每个名称服务器,报告以下计数器:sent:发送到此服务器的 DNS 请求数 valid:从此服务器收到的有效 DNS 响应数 update:用于更新服务器 IP 地址的 DNS 响应数 cname:CNAME 响应数 cname_error:此服务器遇到的 CNAME 错误 any_err:空响应数(即:服务器不支持 ANY 类型) nx:从此服务器收到的不存在域的响应 timeout:此服务器超时未应答的次数 refused:此服务器拒绝的请求数 other:任何其他 DNS 错误 invalid:无效的 DNS 响应(从协议角度看) too_big:响应过大 outdated:响应到达太晚(在另一个名称服务器之后)
show quic [oneline|full] [all]
转储所有活动 QUIC 前端连接的信息。此命令受限制,只能在配置为“operator”或“admin”级别的套接字上发出。可以将可选格式指定为第一个参数来控制详细程度。当前支持的值是“oneline”(如果未指定格式,则为默认值)或“full”。默认情况下,不显示处于关闭或排空状态的连接。使用额外的参数“all”将它们包含在输出中。
show servers conn [<backend>]
转储属于指定后端(如果未指定,则为所有后端)的服务器的当前和空闲连接状态。可以使用后端名称或标识符。输出包括一个显示字段标题的标题行,然后是每个服务器一行,每行包含后端名称和 ID、服务器名称和 ID、地址、端口和一系列值。字段数量根据线程数而变化。鉴于空闲连接的线程特性,重要的是要理解某些值在读取后可能会发生变化,因此,行内的一致性不能保证。此输出主要作为调试工具提供,不适合常规监控或绘图。
show servers state [<backend>]
转储运行配置中找到的服务器状态。可以提供后端名称或标识符,以将输出限制为仅此后端。转储具有以下格式: - 第一行包含格式版本(在本规范中为1); - 第二行包含列标题,以井号('#')为前缀; - 第三行及后续行包含数据; - 以井号('#')开头的每行都被视为注释。由于输出的多个版本可能共存,下面是每个文件格式版本的字段列表及其顺序: 1: be_id: 后端唯一ID。 be_name: 后端标签。 srv_id: 服务器唯一ID(在后端内)。 srv_name: 服务器标签。 srv_addr: 服务器IP地址。 srv_op_state: 服务器操作状态(UP/DOWN/...)。 0 = SRV_ST_STOPPED 服务器已关闭。 1 = SRV_ST_STARTING 服务器正在预热(已启动但受节流)。 2 = SRV_ST_RUNNING 服务器完全启动。 3 = SRV_ST_STOPPING 服务器已启动但正在软停止(例如:404)。 srv_admin_state: 服务器管理状态(MAINT/DRAIN/...)。状态实际上是一个值掩码: 0x01 = SRV_ADMF_FMAINT 服务器被明确强制进入维护模式。 0x02 = SRV_ADMF_IMAINT 服务器从被跟踪的服务器继承了维护状态。 0x04 = SRV_ADMF_CMAINT 由于配置,服务器处于维护模式。 0x08 = SRV_ADMF_FDRAIN 服务器被明确强制进入排水状态。 0x10 = SRV_ADMF_IDRAIN 服务器从被跟踪的服务器继承了排水状态。 0x20 = SRV_ADMF_RMAINT 由于IP地址解析失败,服务器处于维护模式。 0x40 = SRV_ADMF_HMAINT 服务器FQDN通过stats socket设置。 srv_uweight: 用户可见的服务器权重。 srv_iweight: 服务器初始权重。 srv_time_since_last_change: 自上次操作更改以来的时间。 srv_check_status: 上次健康检查状态。 srv_check_result: 上次检查结果(FAILED/PASSED/...)。 0 = CHK_RES_UNKNOWN 默认初始化为此。 1 = CHK_RES_NEUTRAL 有效检查,但没有状态信息。 2 = CHK_RES_FAILED 检查失败。 3 = CHK_RES_PASSED 检查成功且服务器再次完全启动。 4 = CHK_RES_CONDPASS 检查报告服务器不希望新会话。 srv_check_health: 检查rise/fall当前计数器。 srv_check_state: 检查状态(ENABLED/PAUSED/...)。状态实际上是一个值掩码: 0x01 = CHK_ST_INPROGRESS 检查当前正在运行。 0x02 = CHK_ST_CONFIGURED 此检查已配置且可能已启用。 0x04 = CHK_ST_ENABLED 此检查当前已在管理上启用。 0x08 = CHK_ST_PAUSED 由于维护,检查暂停(仅限健康检查)。 srv_agent_state: 代理检查状态(ENABLED/PAUSED/...)。此状态使用与"srv_check_state"相同的掩码值,并添加此特定值: 0x10 = CHK_ST_AGENT 检查是代理检查(否则是健康检查)。 bk_f_forced_id: 标志,用于了解后端ID是否由配置强制。 srv_f_forced_id: 标志,用于了解服务器ID是否由配置强制。 srv_fqdn: 服务器FQDN。 srv_port: 服务器端口。 srvrecord: 与此SRV关联的DNS SRV记录。 srv_use_ssl: 服务器连接是否使用ssl。 srv_check_port: 服务器健康检查端口。 srv_check_addr: 服务器健康检查地址。 srv_agent_addr: 服务器健康代理地址。 srv_agent_port: 服务器健康代理端口。
转储所有已知的活动流(以前称为“会话”)。避免在慢速连接上执行此操作,因为这可能非常大。此命令受到限制,只能在配置为"operator"或"admin"级别的socket上发出。请注意,在具有快速回收连接的机器上,此输出报告的条目可能少于实际存在的条目,因为它将转储在输入命令之前创建的所有现有流,在此期间死亡的流将不会出现。
show sess <id> | older <age> | susp | all
显示有关匹配流的许多内部信息。在第一种形式中,仅显示与指定流标识符匹配的流。此标识符是 "show sess" 转储中行开头的第一个字段(它对应于流指针)。在第二种形式中,仅显示比 <age>(默认为秒)旧的流。传递 "susp" 将仅报告开发人员根据随时间或版本变化的标准而认为是可疑的条目。如果使用 "all",则将转储所有流。转储许多流可能会产生巨大的输出,花费大量时间并占用大量 CPU 资源,因此最好只转储所需的最少信息。这些信息对大多数用户无用,但可供 haproxy 开发人员用于排查复杂的错误。输出格式故意未记录,以便它可以根据需求自由演变。此输出旨在在检查 src/stream.c 中的函数 strm_dump_to_buffer() 时进行解释,以确定某些字段的确切含义。
show stat [domain <resolvers|proxy>] [{<iid>|<proxy>} <type> <sid>] \ [typed|json] [desc] [up|no-maint]
转储统计信息。domain 用于选择要打印的统计信息;目前可用的是 dns 和 proxy。默认情况下,使用 CSV 格式;如果在其他参数后传递 "typed",则可以激活上面部分描述的扩展类型化输出格式;或者如果在其他参数后传递 "json",则以 JSON 格式输出。通过传递 <id>、<type> 和 <sid>,可以仅转储选定的项目: - <iid> 是一个代理 ID,-1 表示转储所有内容。或者,可以指定代理名称 <proxy>。在这种情况下,此代理的 ID 将用作 ID 选择器。 - <type> 选择可转储对象的类型:1 表示前端,2 表示后端,4 表示服务器,-1 表示所有内容。这些值可以进行或运算,例如:1 + 2 = 3 -> 前端 + 后端。1 + 2 + 4 = 7 -> 前端 + 后端 + 服务器。 - <sid> 是一个服务器 ID,-1 表示转储所选代理的所有内容。
示例
$ echo "show info;show stat" | socat stdio unix-connect:/tmp/sock1 >>> Name: HAProxy Version: 1.4-dev2-49 Release_date: 2009/09/23 Nbproc: 1 Process_num: 1 (...) # pxname,svname,qcur,qmax,scur,smax,slim,stot,bin,bout,dreq, (...) stats,FRONTEND,,,0,0,1000,0,0,0,0,0,0,,,,,OPEN,,,,,,,,,1,1,0, (...) stats,BACKEND,0,0,0,0,1000,0,0,0,0,0,,0,0,0,0,UP,0,0,0,,0,250,(...) (...) www1,BACKEND,0,0,0,0,1000,0,0,0,0,0,,0,0,0,0,UP,1,1,0,,0,250, (...) $
在此示例中,同时发出了两个命令。这样可以很容易地在多进程模式下找到统计信息适用于哪个进程。在类型化输出格式中不需要这样做,因为进程号在每行上都会报告。请注意信息输出后的一行空行,它标志着第一块的结束。类似的空行出现在第二块(统计信息)的末尾,以便读者知道输出没有被截断。当指定 "typed" 时,输出格式更适合监控工具,因为它提供了数字位置并指示每个输出字段的类型。每个值都占据一行,包含进程号、元素号、性质、来源和范围。通过在 URI 后传递 ";typed",也可以通过 HTTP 统计信息获得相同的格式。需要注意的是,在类型化输出格式中,单个对象的转储是连续的,因此使用者无需一次存储所有内容。 "up" 修饰符将导致仅列出报告为“up”或未检查的服务器。那些“down”、“unresolved”或处于维护状态的服务器将不会被列出。这类似于 HTTP 统计信息中的 ";up" 选项。同样,"no-maint" 修饰符的作用类似于 ";no-maint" HTTP 修饰符,将导致不列出禁用的服务器。不同之处在于,那些已启用但处于“down”状态的服务器不会被驱逐。当使用类型化输出格式时,每行由用冒号(':')分隔的 4 列组成。第一列是由点分隔的 5 个元素的系列。第一个元素是一个字母,指示正在描述的对象的类型。目前已知以下对象类型:'F' 用于 frontend,'B' 用于 backend,'L' 用于 listener,'S' 用于 server。第二个元素是一个正整数,表示对象所属代理的唯一标识符。它等效于 CSV 输出的 "iid" 列,并与 frontend 或 backend 部分中可选 "id" 指令前面的值匹配。第三个元素是一个正整数,包含代理内部的唯一对象标识符,对应于 CSV 输出的 "sid" 列。转储 frontend 或 backend 时报告 ID 0。对于 listener 或 server,这对应于它们在代理内部的各自 ID。第四个元素是列表中字段的数字位置(从零开始)。此位置不应随时间改变,但根据构建选项或将来删除某些字段,可能会出现空洞。第五个元素是字段名称,如 CSV 输出中所示。第六个元素是一个正整数,是相对进程号,从 1 开始。第一列后的行其余部分遵循上面部分描述的“类型化输出格式”。简而言之,第二列(第一个 ':' 之后)指示变量的来源、性质和范围。第三列指示字段类型,包括 "s32"、"s64"、"u32"、"u64"、"flt" 和 "str"。第四列是值本身,使用者知道如何通过第 3 列解析它,并通过第 2 列处理它。当将 "desc" 附加到命令时,会附加一个额外的冒号,后跟一个带引号的字符串,其中包含对指标的描述。在撰写本文时,这仅支持 "typed" 输出格式。因此,类型化模式下的总体行格式为:<obj>.<px_id>.<id>.<fpos>.<fname>.<process_num>:<tags>:<type>:<value> 以下是类型化输出格式的示例:$ echo "show stat typed" | socat stdio unix-connect:/tmp/sock1 F.2.0.0.pxname.1:MGP:str:private-frontend F.2.0.1.svname.1:MGP:str:FRONTEND F.2.0.8.bin.1:MGP:u64:0 F.2.0.9.bout.1:MGP:u64:0 F.2.0.40.hrsp_2xx.1:MGP:u64:0 L.2.1.0.pxname.1:MGP:str:private-frontend L.2.1.1.svname.1:MGP:str:sock-1 L.2.1.17.status.1:MGP:str:OPEN L.2.1.73.addr.1:MGP:str:0.0.0.0:8001 S.3.13.60.rtime.1:MCP:u32:0 S.3.13.61.ttime.1:MCP:u32:0 S.3.13.62.agent_status.1:MGP:str:L4TOUT S.3.13.64.agent_duration.1:MGP:u64:2001 S.3.13.65.check_desc.1:MCP:str:Layer4 timeout S.3.13.66.agent_desc.1:MCP:str:Layer4 timeout S.3.13.67.check_rise.1:MCP:u32:2 S.3.13.68.check_fall.1:MCP:u32:3 S.3.13.69.check_health.1:SGP:u32:0 S.3.13.70.agent_rise.1:MaP:u32:1 S.3.13.71.agent_fall.1:SGP:u32:1 S.3.13.72.agent_health.1:SGP:u32:1 S.3.13.73.addr.1:MCP:str:1.255.255.255:8888 S.3.13.75.mode.1:MAP:str:http B.3.0.0.pxname.1:MGP:str:private-backend B.3.0.1.svname.1:MGP:str:BACKEND B.3.0.2.qcur.1:MGP:u32:0 B.3.0.3.qmax.1:MGP:u32:0 B.3.0.4.scur.1:MGP:u32:0 B.3.0.5.smax.1:MGP:u32:0 B.3.0.6.slim.1:MGP:u32:1000 B.3.0.55.lastsess.1:MMP:s32:-1 (...) 在类型化格式中,第一列末尾的进程 ID 使聚合来自多个进程的输出变得非常容易,如下例所示,其中每行都为每个进程显示:$ ( echo show stat typed | socat /var/run/haproxy.sock1 - ; \ echo show stat typed | socat /var/run/haproxy.sock2 - ) | \ sort -t . -k 1,1 -k 2,2n -k 3,3n -k 4,4n -k 5,5 -k 6,6n B.3.0.0.pxname.1:MGP:str:private-backend B.3.0.0.pxname.2:MGP:str:private-backend B.3.0.1.svname.1:MGP:str:BACKEND B.3.0.1.svname.2:MGP:str:BACKEND B.3.0.2.qcur.1:MGP:u32:0 B.3.0.2.qcur.2:MGP:u32:0 B.3.0.3.qmax.1:MGP:u32:0 B.3.0.3.qmax.2:MGP:u32:0 B.3.0.4.scur.1:MGP:u32:0 B.3.0.4.scur.2:MGP:u32:0 B.3.0.5.smax.1:MGP:u32:0 B.3.0.5.smax.2:MGP:u32:0 B.3.0.6.slim.1:MGP:u32:1000 B.3.0.6.slim.2:MGP:u32:1000 (...) JSON 输出的格式在模式中进行了描述,可以使用 "show schema json" 输出该模式。JSON 输出不包含额外的空白字符,以减少输出量。对于人工消费,通过漂亮的打印机处理输出可能会有所帮助。示例:$ echo "show stat json" | socat /var/run/haproxy.sock stdio | \ python -m json.tool JSON 输出不包含额外的空白字符,以减少输出量。对于人工消费,通过漂亮的打印机处理输出可能会有所帮助。示例:$ echo "show stat json" | socat /var/run/haproxy.sock stdio | \ python -m json.tool
show ssl ca-file [<cafile>[:<index>]]
显示加载到进程中的 CA 文件列表及其各自的证书计数。在状态为 "Used" 之前,任何 frontend 或 backend 都不会使用这些证书。列表中可能会出现 "@system-ca" 条目,它由 httpclient 默认加载。它包含 OpenSSL 返回的系统受信任 CA 列表。如果文件名以星号为前缀,则表示尚未提交的事务。如果指定了 <cafile> 而没有指定 <index>,它将显示 CA 文件的状态 ("Used"/"Unused"),然后是 CA 文件中包含的所有证书的详细信息。为每个证书显示的详细信息与 "show ssl cert" 命令显示的详细信息相同。如果指定了 <cafile> 并且后跟 <index>,则它将仅显示具有指定索引的证书的详细信息。索引从 1 开始。如果索引无效(例如太大),则不会显示任何内容。此命令可用于检查 CA 文件是否已正确更新。您还可以通过在文件名前加上星号来显示正在进行的事务的详细信息。
示例
$ echo "show ssl ca-file" | socat /var/run/haproxy.master - # transaction *cafile.crt - 2 certificate(s) # filename cafile.crt - 1 certificate(s) $ echo "show ssl ca-file cafile.crt" | socat /var/run/haproxy.master - Filename: /home/tricot/work/haproxy/reg-tests/ssl/set_cafile_ca2.crt Status: Used Certificate #1: Serial: 11A4D2200DC84376E7D233CAFF39DF44BF8D1211 notBefore: Apr 1 07:40:53 2021 GMT notAfter: Aug 17 07:40:53 2048 GMT Subject Alternative Name: Algorithm: RSA4096 SHA1 FingerPrint: A111EF0FEFCDE11D47FE3F33ADCA8435EBEA4864 Subject: /C=FR/ST=Some-State/O=HAProxy Technologies/CN=HAProxy Technologies CA Issuer: /C=FR/ST=Some-State/O=HAProxy Technologies/CN=HAProxy Technologies CA $ echo "show ssl ca-file *cafile.crt:2" | socat /var/run/haproxy.master - Filename: */home/tricot/work/haproxy/reg-tests/ssl/set_cafile_ca2.crt Status: Unused Certificate #2: Serial: 587A1CE5ED855040A0C82BF255FF300ADB7C8136 [...]
show ssl cert [<filename>]
显示加载到进程中的证书列表。在它们的状态变为“Used”之前,它们不会被任何前端或后端使用。如果文件名以星号为前缀,则表示它是一个尚未提交的事务。如果指定了文件名,它将显示有关该证书的详细信息。此命令可用于检查证书是否已正确更新。您还可以通过在文件名前加上星号来显示事务的详细信息。此命令还可用于显示证书的 OCSP 响应的详细信息,方法是在文件名后加上“.ocsp”扩展名。它适用于已提交的证书以及正在进行的事务。对于已提交的证书,此命令等同于使用证书对应的 OCSP 响应 ID 调用“show ssl ocsp-response”。
示例
$ echo "@1 show ssl cert" | socat /var/run/haproxy.master - # 事务 *test.local.pem # 文件名 test.local.pem $ echo "@1 show ssl cert test.local.pem" | socat /var/run/haproxy.master - Filename: test.local.pem Status: Used Serial: 03ECC19BA54B25E85ABA46EE561B9A10D26F notBefore: Sep 13 21:20:24 2019 GMT notAfter: Dec 12 21:20:24 2019 GMT Issuer: /C=US/O=Let's Encrypt/CN=Let's Encrypt Authority X3 Subject: /CN=test.local Subject Alternative Name: DNS:test.local, DNS:imap.test.local Algorithm: RSA2048 SHA1 FingerPrint: 417A11CAE25F607B24F638B4A8AEE51D1E211477 $ echo "@1 show ssl cert *test.local.pem" | socat /var/run/haproxy.master - Filename: *test.local.pem Status: Unused [...]
show ssl crl-file [<crlfile>[:<index>]]
显示加载到进程中的 CRL 文件列表。在它们的状态变为“Used”之前,它们不会被任何前端或后端使用。如果文件名以星号为前缀,则表示它是一个尚未提交的事务。如果指定了不带 <index> 的 <crlfile>,它将显示 CRL 文件的状态(“Used”/“Unused”),后跟 CRL 文件中包含的所有吊销列表的详细信息。每个列表显示的详细信息基于“openssl crl -text -noout -in <file>”的输出。如果指定了 <crlfile> 后跟一个 <index>,它将只显示具有指定索引的列表的详细信息。索引从 1 开始。如果索引无效(例如太大),则不会显示任何内容。此命令可用于检查 CRL 文件是否已正确更新。您还可以通过在文件名前加上星号来显示正在进行的事务的详细信息。
示例
$ echo "show ssl crl-file" | socat /var/run/haproxy.master - # transaction *crlfile.pem # filename crlfile.pem $ echo "show ssl crl-file crlfile.pem" | socat /var/run/haproxy.master - Filename: /home/tricot/work/haproxy/reg-tests/ssl/crlfile.pem Status: Used Certificate Revocation List #1: Version 1 Signature Algorithm: sha256WithRSAEncryption Issuer: /C=FR/O=HAProxy Technologies/CN=Intermediate CA2 Last Update: Apr 23 14:45:39 2021 GMT Next Update: Sep 8 14:45:39 2048 GMT Revoked Certificates: Serial Number: 1008 Revocation Date: Apr 23 14:45:36 2021 GMT Certificate Revocation List #2: Version 1 Signature Algorithm: sha256WithRSAEncryption Issuer: /C=FR/O=HAProxy Technologies/CN=Root CA Last Update: Apr 23 14:30:44 2021 GMT Next Update: Sep 8 14:30:44 2048 GMT No Revoked Certificates.
show ssl crt-list [-n] [<filename>]
显示 HAProxy 配置中使用的 crt-list 和目录列表。如果指定了文件名,则转储 crt-list 或目录的内容。转储后,输出可用作 crt-list 文件。'-n' 选项可用于显示行号,当条目重复时,与 'del ssl crt-list' 选项结合使用非常有用。带有 '-n' 选项的输出与 crt-list 格式不兼容,无法由 haproxy 加载。
示例
echo "show ssl crt-list -n localhost.crt-list" | socat /tmp/sock1 - # localhost.crt-list common.pem:1 !not.test1.com *.test1.com !localhost common.pem:2 ecdsa.pem:3 [verify none allow-0rtt ssl-min-ver TLSv1.0 ssl-max-ver TLSv1.3] localhost !www.test1.com ecdsa.pem:4 [verify none allow-0rtt ssl-min-ver TLSv1.0 ssl-max-ver TLSv1.3]
show ssl ocsp-response [[text|base64] <id|path>]
显示与 HAProxy 中使用的所有 OCSP 响应对应的 OCSP 树条目的 ID,以及相应的前端证书路径、颁发者名称和密钥哈希,以及构建 OCSP 响应的证书序列号。如果提供了有效的 <id> 或有效前端证书的 <path>,则显示相应 OCSP 响应的内容。当提供 <id> 时,可以定义转储数据的格式。'text' 选项是默认选项,它允许以与 "openssl ocsp -respin <ocsp-response> -text" 调用相同的方式显示有关 OCSP 响应的详细信息。'base64' 格式允许以 base64 格式转储 OCSP 响应的内容。
示例
$ echo "show ssl ocsp-response" | socat /var/run/haproxy.master - # Certificate IDs Certificate ID key : 303b300906052b0e03021a050004148a83e0060faff709ca7e9b95522a2e81635fda0a0414f652b0e435d5ea923851508f0adbe92d85de007a0202100a Certificate path : /path_to_cert/foo.pem Certificate ID: Issuer Name Hash: 8A83E0060FAFF709CA7E9B95522A2E81635FDA0A Issuer Key Hash: F652B0E435D5EA923851508F0ADBE92D85DE007A Serial Number: 100A $ echo "show ssl ocsp-response 303b300906052b0e03021a050004148a83e0060faff709ca7e9b95522a2e81635fda0a0414f652b0e435d5ea923851508f0adbe92d85de007a0202100a" | socat /var/run/haproxy.master - OCSP Response Data: OCSP Response Status: successful (0x0) Response Type: Basic OCSP Response Version: 1 (0x0) Responder Id: C = FR, O = HAProxy Technologies, CN = ocsp.haproxy.com Produced At: May 27 15:43:38 2021 GMT Responses: Certificate ID: Hash Algorithm: sha1 Issuer Name Hash: 8A83E0060FAFF709CA7E9B95522A2E81635FDA0A Issuer Key Hash: F652B0E435D5EA923851508F0ADBE92D85DE007A Serial Number: 100A Cert Status: good This Update: May 27 15:43:38 2021 GMT Next Update: Oct 12 15:43:38 2048 GMT [...] $ echo "show ssl ocsp-response base64 /path_to_cert/foo.pem" | socat /var/run/haproxy.sock - MIIB8woBAKCCAewwggHoBgkrBgEFBQcwAQEEggHZMIIB1TCBvqE[...]
显示有关 OCSP 更新机制所涉及的条目的信息。该命令将为每个 OCSP 响应输出一行,其中包含响应的预期更新时间以及上次成功更新的时间,以及成功和失败更新的计数器。它还将以数字形式和文本形式显示上次更新的状态(成功或不成功)。有关可能的错误的完整列表,请参阅下文。行将按“下次更新”时间升序排列。这些行还将包含使用 OCSP 响应的第一个 frontend 证书的路径。有关 OCSP 自动更新的更多信息,请参阅 "show ssl ocsp-response" 命令和 "ocsp-update" 选项。更新错误代码和错误字符串如下:+----+-------------------------------------+ | ID | message | +----+-------------------------------------+ | 0 | "Unknown" | | 1 | "Update successful" | | 2 | "HTTP error" | | 3 | "Missing \"ocsp-response\" header" | | 4 | "OCSP response check failure" | | 5 | "Error during insertion" | +----+-------------------------------------+
示例
$ echo "show ssl ocsp-updates" | socat /tmp/haproxy.sock - OCSP Certid | Path | Next Update | Last Update | Successes | Failures | Last Update Status | Last Update Status (str) 303b300906052b0e03021a050004148a83e0060faff709ca7e9b95522a2e81635fda0a0414f652b0e435d5ea923851508f0adbe92d85de007a02021015 | /path_to_cert/cert.pem | 30/Jan/2023:00:08:09 +0000 | - | 0 | 1 | 2 | HTTP error 304b300906052b0e03021a0500041448dac9a0fb2bd32d4ff0de68d2f567b735f9b3c40414142eb317b75856cbae500940e61faf9d8b14c2c6021203e16a7aa01542f291237b454a627fdea9c1 | /path_to_cert/other_cert.pem | 30/Jan/2023:01:07:09 +0000 | 30/Jan/2023:00:07:09 +0000 | 1 | 0 | 1 | Update successful
显示 OpenSSL 在初始化期间加载的提供程序的名称。提供程序的加载确实可以通过 OpenSSL 配置文件进行配置,此选项允许检查是否加载了正确的提供程序。此命令仅适用于 OpenSSL v3。
示例
$ echo "show ssl providers" | socat /var/run/haproxy.master - Loaded providers : - fips - base
转储当前 haproxy 进程启动期间发出的所有消息,每个 startup-logs 缓冲区对其 haproxy 工作进程都是唯一的。此关键字也存在于 master CLI 上,它显示最新的启动或重新加载尝试。
转储所有已知粘性表的一般信息。返回它们的名称(持有它们的代理的名称)、它们的类型(目前为零,总是 IP)、它们的最大可能条目数大小,以及当前使用的条目数。
示例
$ echo "show table" | socat stdio /tmp/sock1 >>> # table: front_pub, type: ip, size:204800, used:171454 >>> # table: back_rdp, type: ip, size:204800, used:0
show table <name> [ data.<type> <operator> <value> [data.<type> ...]] | [ key <key> ]
转储 stick-table <name> 的内容。在此模式下,首先报告有关该表的通用信息行,如 "show table" 所示,然后转储所有条目。由于这可能非常繁重,因此可以指定过滤器以指定要显示的条目。当使用 "data." 形式时,过滤器适用于存储的数据(请参阅 第 4.2 节 中的 "stick-table")。必须在 <type> 中指定存储的数据类型,并且此数据类型必须存储在表中,否则会报告错误。数据根据 <operator> 与 64 位整数 <value> 进行比较。运算符与 ACL 中的相同:- eq:匹配数据等于此值的条目- ne:匹配数据不等于此值的条目- le:匹配数据小于或等于此值的条目- ge:匹配数据大于或等于此值的条目- lt:匹配数据小于此值的条目- gt:匹配数据大于此值的条目在此形式中,您可以使用多个数据过滤器条目,最多达到构建时定义的最大值(默认为 4)。当使用 key 形式时,将显示条目 <key>。键必须与表的类型相同,目前仅限于 IPv4、IPv6、整数和字符串。
示例
$ echo "show table http_proxy" | socat stdio /tmp/sock1 >>> # table: http_proxy, type: ip, size:204800, used:2 >>> 0x80e6a4c: key=127.0.0.1 use=0 exp=3594729 gpc0=0 conn_rate(30000)=1 \ bytes_out_rate(60000)=187 >>> 0x80e6a80: key=127.0.0.2 use=0 exp=3594740 gpc0=1 conn_rate(30000)=10 \ bytes_out_rate(60000)=191 $ echo "show table http_proxy data.gpc0 gt 0" | socat stdio /tmp/sock1 >>> # table: http_proxy, type: ip, size:204800, used:2 >>> 0x80e6a80: key=127.0.0.2 use=0 exp=3594740 gpc0=1 conn_rate(30000)=10 \ bytes_out_rate(60000)=191 $ echo "show table http_proxy data.conn_rate gt 5" | \ socat stdio /tmp/sock1 >>> # table: http_proxy, type: ip, size:204800, used:2 >>> 0x80e6a80: key=127.0.0.2 use=0 exp=3594740 gpc0=1 conn_rate(30000)=10 \ bytes_out_rate(60000)=191 $ echo "show table http_proxy key 127.0.0.2" | \ socat stdio /tmp/sock1 >>> # table: http_proxy, type: ip, size:204800, used:2 >>> 0x80e6a80: key=127.0.0.2 use=0 exp=3594740 gpc0=1 conn_rate(30000)=10 \ bytes_out_rate(60000)=191
当数据标准应用于依赖于时间的动态值(例如字节速率)时,该值在评估条目期间动态计算,以决定是否必须转储它。这意味着这样的过滤器可能会在一段时间内匹配,然后由于时间的推移,平均事件速率下降而不再匹配。可以利用这一点来提取滥用服务的 IP 地址列表,以便监视它们甚至在防火墙中将它们列入黑名单。
示例
$ echo "show table http_proxy data.gpc0 gt 0" \ | socat stdio /tmp/sock1 \ | fgrep 'key=' | cut -d' ' -f2 | cut -d= -f2 > abusers-ip.txt ( 或 | awk '/key/{ print a[split($2,a,"=")]; }' )
当粘性表与支持分片的对等点部分同步时,将为每个键显示分片编号(否则报告“0”)。这允许知道哪些对等点将接收此键。
示例
$ echo "show table http_proxy" | socat stdio /tmp/sock1 | fgrep shard= 0x7f23b0c822a8: key=10.0.0.2 use=0 exp=296398 shard=9 gpc0=0 0x7f23a063f948: key=10.0.0.6 use=0 exp=296075 shard=12 gpc0=0 0x7f23b03920b8: key=10.0.0.8 use=0 exp=296766 shard=1 gpc0=0 0x7f23a43c09e8: key=10.0.0.12 use=0 exp=295368 shard=8 gpc0=0
转储当前运行队列中的任务数,以及每个函数的出现次数,以及已知时的平均延迟(对于启用了任务分析的纯任务)。转储是完成时的快照,根据当时队列中剩余的任务可能会有变化,尤其是在单线程模式下,因为 I/O 重新填充队列的机会较少(除非队列已满)。此命令对进程进行独占访问,在高度负载的进程上发出时可能导致微小但可测量的延迟,因此监控机器人不得滥用此命令。
转储每个线程的一些内部状态和结构,这可能有助于开发人员理解问题。输出尝试通过为每个线程显示一个块来使其可读。当 haproxy 使用 USE_THREAD_DUMP=1 构建时,会使用涉及线程信号的高级转储机制,以便每个线程可以依次转储自己的状态。如果没有此选项,处理命令的线程会显示其所有详细信息,但其他线程的详细信息较少。处理命令的线程前面会显示一个星号 ('*')。在上次调用此命令后没有取得任何进展的线程前面也可能会显示一个右尖括号 ('>'),表示代码中存在必须报告的错误。当这种情况发生在两个线程之间时,通常表示死锁。如果一个线程是单独的,那是另一种错误,例如列表损坏。在所有情况下,进程都不能再完全正常工作,需要重新启动。输出格式故意未记录,以便它可以随着新需求的确定而轻松演变,而无需维护任何形式的向后兼容性,并且与 "show activity" 一样,如果没有代码在手,这些值是毫无意义的。
转储所有已加载的 TLS ticket 密钥引用。将显示 TLS ticket 密钥引用 ID 和加载密钥的文件。这两个都可用于使用“set ssl tls-key”更新 TLS 密钥。如果指定了一个 ID 作为参数,它将转储 tickets,使用 * 将转储每个引用的所有密钥。
转储用于“show info json”和“show stat json”输出的模式。为了减少输出量,其中不包含额外的空格。为了方便人类阅读,可以通过一个美化打印器来处理输出。示例:$ echo "show schema json" | socat /var/run/haproxy.sock stdio | \ python -m json.tool 该模式遵循“JSON Schema”(json-schema.org),因此可以使用验证器来验证“show info json”和“show stat json”的输出是否符合该模式。
show trace [<source>]
显示当前跟踪状态。对于每个源,都会显示一行,带有一个单字符状态,指示跟踪是已停止、等待中还是正在运行。会指示跟踪使用的输出接收器(如果未设置,则为 "none"),以及此接收器中丢弃的事件数量,后跟对源的简要描述。如果指定了源名称,则会显示该源支持的所有事件的详细列表,以及它们对每个操作(报告、启动、暂停、停止)的状态,如果启用则用 "+" 表示,否则用 "-" 表示。所有这些事件都是独立的,一个事件可能会触发启动而未被报告,反之亦然。
显示当前 HAProxy 进程的版本。这在 master 和 worker CLI 中都可用。
示例
$ echo "show version" | socat /var/run/haproxy.sock stdio 2.4.9 $ echo "show version" | socat /var/run/haproxy-master.sock stdio 2.5.0
完全删除指定的前端。它所绑定的所有端口都将被释放。此操作后将无法再启用该前端。这旨在用于那些甚至无法想象停止代理但必须修复配置错误的代理的环境中。这样就可以释放端口并将其绑定到另一个进程以恢复操作。一旦终止,该前端将完全不会出现在统计页面上。前端可以通过其名称或以井号('#')为前缀的数字 ID 来指定。此命令受限制,只能在配置为 "admin" 级别的套接字上发出。
立即终止与指定流标识符匹配的流。此标识符是“show sess”转储中行首的第一个字段(它对应于流指针)。这可用于终止长时间运行的流,而无需等待超时,或者当正在进行无休止的传输时。此类终止的流在日志中以“K”标志报告。
shutdown sessions server <backend>/<server>
立即终止附加到指定服务器的所有流。例如,这可用于在服务器进入维护模式后终止长时间运行的流。此类终止的流在日志中以“K”标志报告。
单独的“trace”命令会列出跟踪源、它们的当前状态和简要描述。它仅作为进入下一级的菜单,请参见下面的其他“trace”命令。
立即停止所有跟踪。这旨在作为终止调试会话的快速解决方案,或在多个源上启用了复杂的跟踪并影响服务时作为紧急措施使用。
trace <source> event [ [+|-|!]<name> ]
没有参数时,这将列出指定来源支持的所有事件。如果未启用,它们会以 "-" 为前缀,如果已启用,则以 "+" 为前缀。重要的是要注意,单个跟踪可能标记有多个事件,只要任何已启用的事件匹配跟踪上标记的事件之一,该事件就会传递给跟踪子系统。例如,接收类型为 HEADERS 的 HTTP/2 帧可能会触发帧事件和流事件,因为该帧会创建一个新流。如果为此来源启用了帧事件或流事件中的任何一个,该帧将传递给跟踪框架。使用参数时,可以切换每个事件的状态并单独启用或禁用它们。支持两个特殊关键字:"none",它不匹配任何事件,用于一次禁用所有事件;"any",它匹配所有事件,用于一次启用所有事件。其他事件特定于事件源。可以通过指定事件名称来启用事件,可以选择以 '+' 为前缀以提高可读性。可以通过指定以 '-' 或 '!' 为前缀的事件名称来禁用事件。完全禁用跟踪源的一种方法是传递 "event none",此源将立即被完全忽略。
trace <source> level [<level>]
没有参数时,这将列出此源的所有跟踪级别,并且当前级别将在其前面以星号 ('*')  표시。使用参数时,这将把跟踪级别更改为指定的级别。详细级别是在报告事件之前应用的过滤器形式。这些过滤器用于根据事件的重要性级别选择性地包括或排除事件。例如,开发人员可能需要确切知道代码中将 HTTP 标头视为无效的位置,而最终用户甚至可能根本不关心此标头的有效性。跟踪目前有 5 个不同的级别:user 这将报告适合普通 haproxy 用户用于观察其流量的信息。通常会报告一些 HTTP 请求和响应,但没有太多细节。大多数来源会将此设置为默认级别以简化操作。proto 除了在 "user" 级别报告的内容外,它还显示协议级更新。例如,这可以是解码后的帧类型或 HTTP 标头。state 除了在 "proto" 级别报告的内容外,它还将显示解析器中发生的状态转换(或失败转换),因此这将显示执行操作的尝试,而 "proto" 级别仅显示最终操作。data 除了在 "state" 级别报告的内容外,它还将包括各层之间的数据传输。developer 它报告所有可用的信息,其中可能包括高级信息,例如“跳出此循环”,这些信息仅与试图理解偶尔发生的错误的开发人员相关。函数名称仅在此级别报告。强烈建议始终仅使用 "user" 级别,并且仅在开发人员指示时才切换到其他级别。另外,最好先配置事件,然后再切换到更高级别,因为如果没有应用过滤器,可能会节省转储多行。
trace <source> lock [criterion]
没有参数时,这将列出此源支持的所有用于锁定的条件,并显示当前选择,在其前面以星号 ('*')  표시。锁定意味着源将专注于第一个匹配的事件,并且只坚持触发此事件的条件,并忽略所有其他条件,直到跟踪停止。这允许例如对单个连接或单个流进行跟踪。某些跟踪支持以下条件,尽管不一定全部支持,因为其中一些条件可能不适用于该源:backend 锁定启动跟踪的后端connection 锁定启动跟踪的连接frontend 锁定启动跟踪的前端listener 锁定启动跟踪的监听器nothing 不锁定任何内容server 锁定启动跟踪的服务器session 锁定启动跟踪的会话thread 锁定启动跟踪的线程除此之外,每个源最多可以提供 4 个特定条件,例如内部状态或连接 ID。例如,在 HTTP/2 中,一旦 strace 开始,就可以锁定 H2 流并忽略其他流。当参数中传递条件时,将使用该条件而不是其他条件,并且任何现有跟踪将立即终止,以便可以使用新条件重新开始。所有源都支持特殊关键字 "nothing",用于永久禁用跟踪。
trace <source> { pause | start | stop } [ [+|-|!]event]
没有参数时,这将列出为此源自动暂停、开始或停止跟踪而启用的事件。这些事件特定于每个跟踪源。使用参数时,这将启用指定操作的事件(如果可选地以 '+' 为前缀)或禁用它(如果以 '-' 或 '!' 为前缀)。特殊关键字 "now" 不是事件,它请求立即执行操作。支持关键字 "none" 和 "any",就像在 "trace event" 中一样。支持的 3 个操作分别是 "pause"、"start" 和 "stop"。 "pause" 操作枚举将导致正在运行的跟踪停止并等待新的开始事件以重新启动它的事件。 "start" 操作枚举将跟踪切换到等待模式,直到其中一个开始事件出现。 "stop" 操作枚举将完全停止跟踪的事件,直到再次手动启用它。在实践中,使用 "start now" 手动启动跟踪而不用关心事件,并使用 "stop now" 止跟踪是有意义的。为了捕获更细微的事件序列,将 "start" 设置为正常事件(例如接收 HTTP 请求),将 "stop" 设置为非常罕见的事件(例如发出某个错误),将确保捕获的最后事件将匹配所需的条件。暂停事件对于检测序列结束、禁用锁定并等待另一个捕获机会非常有用。在这种情况下,启用锁定以仅发现一个特定条件(例如流)是有意义的,并将 "start" 设置为启动此条件的任何内容(例如创建流的所有事件),将 "stop" 设置为预期的异常,并将 "pause" 设置为结束该条件的任何内容(例如任何流结束事件)。在这种情况下,跟踪日志将包含影响单个对象的完美干净序列的完整序列,直到包含从开始到异常的所有内容的最后一个序列。
trace <source> sink [<sink>] 不带参数时,将列出此源可用的所有事件接收器,当前配置的接收器前面会有一个星号('*')。接收器“none”始终可用,意味着所有事件都被简单地丢弃,但它们的处理并未被忽略(例如,锁定确实发生)。其他接收器根据配置和构建选项可用,但通常“stdout”和“stderr”在调试模式下可用,内存中的环形缓冲区也应该可用。当指定名称时,指定源的接收器会立即更改。在接收器更改期间,事件不会改变。在最坏的情况下,如果使用无效的接收器(或“none”),可能会丢失一些事件,但操作会继续到不同的目的地。
trace <source> verbosity [<level>]
没有参数时,这将列出此源的所有详细级别,并且当前级别将在其前面以星号 ('*')  표시。使用参数时,这将把详细级别更改为指定的级别。详细级别指示跟踪解码器应在多大程度上提供详细信息。它取决于跟踪源,因为某些源甚至不提供特定的解码器。级别 "quiet" 始终可用并禁用任何解码。在尝试了解详细信息之前,在尝试弄清楚发生了什么时它可能很有用,因为它对性能和跟踪大小的影响非常低。当源未声明任何详细级别时,级别 "default" 可用,并且当在跟踪中指定时,将导致调用解码器。这是一种机会性解码。当源声明某些详细级别时,将列出这些级别及其对应内容的描述。在这种情况下,源提供的跟踪解码器将根据跟踪点可用的信息尽可能准确。默认情况下设置高于 "quiet" 的第一个级别。
为指定的 <certfile> 创建一个 OCSP 请求,并将其发送到其 URI 应在证书的“授权信息访问”部分中指定的 OCSP 响应器。只考虑第一个 URI。然后检查我们应该收到的 OCSP 响应,并将其插入到本地 OCSP 响应树中。此命令仅适用于已经有存储的 OCSP 响应的证书,无论是在初始化期间提供的,还是之前通过“set ssl cert”或“set ssl ocsp-response”命令设置的。如果接收到的 OCSP 响应有效并且已正确插入到本地树中,其内容将显示在标准输出上。格式与“show ssl ocsp-response”中描述的相同。

9.4. Master CLI

master CLI 是在 master-worker 模式下绑定到 master 进程的套接字。此 CLI 提供了对每个正在运行或正在退出的进程中的 unix 套接字命令的访问,并允许对这些进程进行基本监控。master CLI 只能通过 haproxy 程序的 -S 选项进行配置。此选项还接受以逗号分隔的绑定选项。
示例
# haproxy -W -S 127.0.0.1:1234 -f test1.cfg # haproxy -Ws -S /tmp/master-socket,uid,1000,gid,1000,mode,600 -f test1.cfg # haproxy -W -S /tmp/master-socket,level,user -f test1.cfg

9.4.1. Master CLI 命令

@<[!]pid> 主 CLI 使用特殊的前缀表示法来访问多个进程。这种表示法很容易识别,因为它以 @ 开头。@ 前缀后面可以跟一个相对进程号或一个感叹号和一个 PID。(例如 @1 或 @!1271)。单独的 @ 可用于指定主进程。正在离开的进程只能通过 PID 访问,因为相对进程号仅适用于当前进程。
示例
$ socat /var/run/haproxy-master.sock readline prompt master> @1 show info; @2 show info [...] Process_num: 1 Pid: 1271 [...] Process_num: 2 Pid: 1272 [...] master> $ echo '@!1271 show info; @!1272 show info' | socat /var/run/haproxy-master.sock - [...]
前缀可以作为一个命令使用,它将把之后的所有命令发送到指定的进程。
示例
$ socat /var/run/haproxy-master.sock readline prompt master> @1 1271> show info [...] 1271> show stat [...] 1271> @ master> $ echo '@1; show info; show stat; @2; show info; show stat' | socat /var/run/haproxy-master.sock - [...]
expert-mode [on|off]
此命令为从 master CLI 访问的每个工作进程激活 "expert-mode"。与 "mcli-debug-mode" 结合使用时,它也会在 master 上激活命令。在 master CLI 提示符中显示标志 "e"。另请参阅第 9.3 节中的 "expert-mode" 和 9.4.1 中的 "mcli-debug-mode"。
此命令为从 master CLI 访问的每个工作进程激活 "experimental-mode"。与 "mcli-debug-mode" 结合使用时,它也会在 master 上激活命令。在 master CLI 提示符中显示标志 "x"。另请参阅第 9.3 节中的 "experimental-mode" 和 9.4.1 中的 "mcli-debug-mode"。
此命令与主 CLI 上的“reload”命令作用相同,但它执行的是硬停止 (-st) 而不是软停止 (-sf) 上一个进程。这意味着上一个进程在退出前不会等待完成任何操作,因此所有连接都将被关闭。另请参见“reload”命令。
此关键字允许 master CLI 中的一种特殊模式,该模式在 master CLI 上启用原本用于 worker CLI 的所有关键字,从而允许调试 master 进程。激活后,您可以使用 "help" 列出新可用的关键字。与 "experimental-mode" 或 "expert-mode" 结合使用时,它会启用更多关键字。在 master CLI 提示符中显示标志 "d"。
当提示符启用时(通过“prompt”命令),CLI 正在工作的上下文会显示在提示符中。master 进程由字符串 "master" 标识,其他进程则由其 PID 标识。如果最后一次重载失败,master 提示符将变为 "master[ReloadFailed]>",这样就可以清楚地看到该进程仍在旧配置上运行,而新配置并未生效。Master CLI 的提示符能够显示几个标志,代表启用的模式:“d”表示 mcli-debug-mode,“e”表示 expert-mode,“x”表示 experimental-mode。
示例
$ socat /var/run/haproxy-master.sock - prompt master> expert-mode on master(e)> experimental-mode on master(xe)> mcli-debug-mode on master(xed)> @1 95191(xed)>
您也可以使用“reload”命令重载 HAProxy master 进程,这与对 master 进程执行 `kill -USR2` 的效果相同,前提是用户至少具有“operator”或“admin”权限。此命令允许您执行同步重载,命令将在重载执行完毕后返回一个重载状态。如果使用工具来解析它,请注意超时时间,因为状态只有在配置被解析且新的 worker 进程被派生(fork)后才会返回。“socat”命令默认使用 0.5 秒的超时,因此如果重载时间过长,它会在显示消息之前退出。“ncat”默认没有超时。当使用 USE_SHM_OPEN=1 编译时,reload 命令也能够转储 master 进程的启动日志。
示例
$ echo "reload" | socat -t300 /var/run/haproxy-master.sock stdin Success=1 -- [NOTICE] (482713) : haproxy version is 2.7-dev7-4827fb-69 [NOTICE] (482713) : path to executable is ./haproxy [WARNING] (482713) : config : 'http-request' rules ignored for proxy 'frt1' as they require HTTP mode. [NOTICE] (482713) : New worker (482720) forked [NOTICE] (482713) : Loading success. $ echo "reload" | socat -t300 /var/run/haproxy-master.sock stdin Success=0 -- [NOTICE] (482886) : haproxy version is 2.7-dev7-4827fb-69 [NOTICE] (482886) : path to executable is ./haproxy [ALERT] (482886) : config : parsing [test3.cfg:1]: unknown keyword 'Aglobal' out of section. [ALERT] (482886) : config : Fatal errors found in configuration. [WARNING] (482886) : Loading failure! $
reload 命令是在主 CLI 上执行的最后一个命令,其后的所有其他命令都将被忽略。一旦 reload 命令返回其状态,它将关闭与 CLI 的连接。请注意,重新加载将关闭与主 CLI 的所有连接。另请参见“hard-reload”命令。
Master CLI 引入了一个 'show proc' 命令来监控进程。
示例
$ echo 'show proc' | socat /var/run/haproxy-master.sock - #<PID> <type> <reloads> <uptime> <version> 1162 master 5 [failed: 0] 0d00h02m07s 2.5-dev13 # workers 1271 worker 1 0d00h00m00s 2.5-dev13 # old workers 1233 worker 3 0d00h00m43s 2.0-dev3-6019f6-289 # programs 1244 foo 0 0d00h00m00s - 1255 bar 0 0d00h00m00s -
在此示例中,master 进程已重载 5 次,但其中一个旧的 worker 仍在运行,并经历了 3 次重载。您可以访问此 worker 的 CLI 来了解发生了什么。
HAProxy 需要使用 USE_SHM_OPEN=1 编译才能在 Master CLI 上正确使用,否则并非所有消息都可见。与其在 stats socket 上的对应命令一样,此命令能够显示 HAProxy 的启动消息。但它不转储当前 worker 的启动消息,而是转储最近一次启动或重载的启动消息,这意味着它能够转储失败重载的解析消息。这些消息也会随“reload”命令一起转储。
两个构成集群的 HAProxy 节点共享完全相同的配置,但地址略有不同,这是非常常见的。与其为每个节点维护重复的配置,这不可避免地会导致分歧,不如在配置中包含环境变量。因此,多个配置可以共享完全相同的文件,只有少数不同的系统范围环境变量。这始于 1.5 版本,其中只允许地址包含环境变量,而 1.6 版本则更进一步,支持所有位置的环境变量。语法与 UNIX shell 中的相同,变量以美元符号 ('$') 开头,后跟左大括号 ('{'),然后是变量名,最后是右大括号 ('}')。除了地址之外,环境变量仅在用双引号括起来的参数中进行解释(这是必要的,以免破坏使用涉及美元符号的正则表达式的现有设置)。环境变量还使得编写适用于地址发生变化的各种站点的配置变得方便。它还可以允许从某些配置中删除密码。以下示例中,"site1.env" 文件在启动时由 init 脚本来源:$ cat site1.env LISTEN=192.168.1.1 CACHE_PFX=192.168.11 SERVER_PFX=192.168.22 LOGGER=192.168.33.1 STATSLP=admin:pa$$w0rd ABUSERS=/etc/haproxy/abuse.lst TIMEOUT=10s $ cat haproxy.cfg global log "${LOGGER}:514" local0 defaults mode http timeout client "${TIMEOUT}" timeout server "${TIMEOUT}" timeout connect 5s frontend public bind "${LISTEN}:80" http-request reject if { src -f "${ABUSERS}" } stats uri /stats stats auth "${STATSLP}" use_backend cache if { path_end .jpg .css .ico } default_backend server backend cache server cache1 "${CACHE_PFX}.1:18080" check server cache2 "${CACHE_PFX}.2:18080" check backend server server cache1 "${SERVER_PFX}.1:8080" check server cache2 "${SERVER_PFX}.2:8080" check
偶尔会有人报告说,系统重启后,haproxy 服务没有启动,而当他们手动启动它时,它就可以工作了。通常,这些人运行的是集群 IP 地址机制(例如 keepalived),将服务 IP 地址仅分配给主节点,当他们以前将 haproxy 绑定到地址 0.0.0.0 时,它曾经工作正常,但在将其绑定到虚拟 IP 地址后,它停止工作了。这里发生的情况是,当服务启动时,虚拟 IP 地址尚未被本地节点拥有,因此当 HAProxy 想要绑定到它时,系统会拒绝它,因为它不是本地 IP 地址。解决方案不是延迟 haproxy 服务启动(因为它无法承受重启),而是正确配置系统以允许绑定到非本地地址。在 Linux 上,通过将 net.ipv4.ip_nonlocal_bind sysctl 设置为 1 即可轻松完成此操作。为了透明地拦截通过 HAProxy 传送到特定目标地址的 IP 流量,也需要这样做。涉及源端口范围的多进程配置可能看起来可以工作,但在高负载下会导致一些随机故障,因为多个进程可能会尝试使用相同的源端口连接到同一服务器,这是不可能的。系统将报告错误并进行重试,选择另一个端口。 "retries" 参数中的高值可以在一定程度上隐藏效果,但这也会增加 CPU 使用率和处理时间。日志也会报告一定数量的重试。因此,在多进程配置中应避免使用端口范围。由于 HAProxy 使用 SO_REUSEPORT 并支持将多个独立进程绑定到同一个 IP:port,因此在故障排除期间,可能会发生旧进程未停止而新进程已启动的情况。这会产生荒谬的测试结果,倾向于表明对配置的任何更改都被忽略了。原因在于,即使新进程使用新配置重新启动,旧进程也会接收一些传入连接并对其进行处理,从而返回意外结果。如有疑问,只需停止新进程并重试。如果仍然有效,则很可能意味着旧进程仍然存在,必须停止。Linux 的 "netstat -lntp" 在这里很有帮助。当从命令行向 ACL 添加条目时(例如:当将源地址列入黑名单时),重要的是要记住这些条目不会同步到文件,并且如果有人重新加载配置,这些更新将丢失。虽然这通常是期望的效果(对于黑名单),但在更改作为问题修复时,它不一定符合预期。请参阅 CLI 接口的 "add acl" 操作。
当 HAProxy 使用 "-d" 选项启动时,它将保持在前台,并为每个事件打印一行,例如传入连接、连接结束,以及看到的每个请求或响应标头行。此调试输出在内容处理之前发出,因此它们不考虑本地修改。主要用途是显示请求和响应,而无需运行网络嗅探器。当并行处理多个连接时,输出的可读性会降低,尽管 examples/ 目录中的 "debug2ansi" 和 "debug2html" 脚本通过为输出着色确实有帮助。如果 HAProxy 发现请求或响应格式错误而被拒绝,最好的办法是连接到 CLI 并发出 "show errors",它将报告为每个 frontend 和 backend 捕获的最后一个有故障的请求和响应,并提供所有必要的信息来精确指示输入流中被拒绝的第一个字符。有时需要这样做来向客户或开发人员证明他们的代码中存在错误。在这种情况下,通常可以通过使用 "option accept-invalid-http-request" 或其等效的来自服务器的响应 "option accept-invalid-http-response" 来放宽检查(但仍保留捕获)。请参阅配置手册了解更多详细信息。
示例
> show errors Total events captured on [13/Oct/2015:13:43:47.169] : 1 [13/Oct/2015:13:43:40.918] frontend HAProxyLocalStats (#2): invalid request backend <NONE> (#-1), server <NONE> (#-1), event #0 src 127.0.0.1:51981, session #0, session flags 0x00000080 HTTP msg state 26, msg flags 0x00000000, tx flags 0x00000000 HTTP chunk len 0 bytes, HTTP body len 0 bytes buffer flags 0x00808002, out 0 bytes, total 31 bytes pending 31 bytes, wrapping at 8040, error at position 13: 00000 GET /invalid request HTTP/1.1\r\n
CLI 上的 "show info" 输出提供了许多有用的信息,包括曾经达到的最大连接速率、曾经达到的最大 SSL 密钥速率,以及通常所有可以帮助解释有关 CPU 或内存使用的临时问题的信息。示例:> show info Name: HAProxy Version: 1.6-dev7-e32d18-17 Release_date: 2015/10/12 Nbproc: 1 Process_num: 1 Pid: 7949 Uptime: 0d 0h02m39s Uptime_sec: 159 Memmax_MB: 0 Ulimit-n: 120032 Maxsock: 120032 Maxconn: 60000 Hard_maxconn: 60000 CurrConns: 0 CumConns: 3 CumReq: 3 MaxSslConns: 0 CurrSslConns: 0 CumSslConns: 0 Maxpipes: 0 PipesUsed: 0 PipesFree: 0 ConnRate: 0 ConnRateLimit: 0 MaxConnRate: 1 SessRate: 0 SessRateLimit: 0 MaxSessRate: 1 SslRate: 0 SslRateLimit: 0 MaxSslRate: 0 SslFrontendKeyRate: 0 SslFrontendMaxKeyRate: 0 SslFrontendSessionReuse_pct: 0 SslBackendKeyRate: 0 SslBackendMaxKeyRate: 0 SslCacheLookups: 0 SslCacheMisses: 0 CompressBpsIn: 0 CompressBpsOut: 0 CompressBpsRateLim: 0 ZlibMemUsage: 0 MaxZlibMemUsage: 0 Tasks: 5 Run_queue: 1 Idle_pct: 100 node: wtap description: 当 HAProxy 的新版本上似乎随机出现问题时(例如:每隔一个请求被中止,偶尔崩溃等),值得尝试启用内存中毒,以便在每次调用 malloc() 后立即用可配置字节填充内存区域。默认情况下,此字节为 0x50(ASCII 码 'P'),但可以使用任何其他字节,包括零(其效果与 calloc() 相同,并可能使问题消失)。内存中毒使用 "-dM" 选项在命令行上启用。它会轻微损害性能,不建议在生产中使用。如果问题在使用它时始终发生,或者当中毒使用零字节时从不发生,则清楚地意味着您发现了一个错误,并且您绝对需要报告它。否则,如果没有明显的变化,则问题与此无关。当调试某些延迟问题时,重要的是在本地计算机上同时使用 strace 和 tcpdump,并在远程系统上使用另一个 tcpdump。原因在于处理链中的各个位置都存在延迟,了解是哪个位置导致延迟非常重要,以便知道在哪里采取行动。在实践中,本地 tcpdump 将指示输入数据何时传入。Strace 将指示 haproxy 何时接收这些数据(使用 recv/recvfrom)。警告:openssl 使用 read()/write() 系统调用而不是 recv()/send()。Strace 还会显示 haproxy 何时发送数据,而 tcpdump 将显示系统何时将这些数据发送到接口。然后外部 tcpdump 将显示发送的数据何时真正被接收(因为本地 tcpdump 仅显示数据何时排队)。在本地系统上嗅探的好处是 strace 和 tcpdump 将使用相同的参考时钟。Strace 应使用 "-tts200" 以获取完整的 timestamps 并报告足够大的数据块以供读取。Tcpdump 应使用 "-nvvttSs0" 以报告完整的包、真实的序列号和完整的 timestamps。在实践中,接收到的数据几乎总是立即被 haproxy 接收(除非机器的 CPU 饱和或这些数据无效且未交付)。如果接收到这些数据但未发送,通常是因为输出缓冲区已饱和(即:接收方消耗数据的速度不够快)。这可以通过观察轮询在一段时间内没有通知输出文件描述符的可写性来确认(在 strace 输出中,当数据最终离开时,回溯以查看何时通知写入事件通常更容易发现)。它通常匹配从接收方接收到的 ACK,并由 tcpdump 检测到。一旦数据发送出去,它们可能会在系统中花费一些时间无所事事。在这里,TCP 拥塞窗口可能受到限制,不允许这些数据离开,等待 ACK 打开窗口。如果流量空闲并且数据需要 40 毫秒或 200 毫秒才能离开,这是另一个问题(这不是问题),这是 Nagle 算法阻止空数据包立即离开的事实,希望它们能与后续数据合并。HAProxy 在纯 TCP 模式和隧道中自动禁用 Nagle。但是,在转发 HTTP 正文时它仍然启用(这通过减少数据包数量有助于提高性能)。某些不符合 HTTP 规范的应用程序可能对交付不完整的 HTTP 响应消息时的延迟敏感。在这种情况下,您将不得不启用 "option http-no-delay" 以禁用 Nagle 以绕过它们的设计,请记住链中的任何其他代理也可能受到类似影响。如果 tcpdump 报告数据立即离开,但另一端没有很快看到它们,则可能意味着 WAN 链路拥塞、启用了流控制的 LAN 拥塞并阻止数据离开,或者更常见的是 HAProxy 实际上在虚拟机中运行,并且由于某种原因管理程序已决定不需要立即发送数据。在虚拟化环境中,延迟问题几乎总是由虚拟化层引起的,因此为了节省时间,值得首先比较 VM 和外部组件上的 tcpdump。任何差异都必须归因于管理程序及其附带的驱动程序。当在 tcpdump 跟踪中看到一些 TCP SACK 段时(使用 -vv),这总是意味着发送它们的一方已经获得了丢失数据包的证明。虽然看不到它们并不意味着没有丢失,但看到它们肯定意味着网络有丢失。丢失在网络上是正常的,但在 SACK 肉眼不可见的速率下是正常的。如果它们在跟踪中大量出现,则值得调查究竟发生了什么以及数据包在哪里丢失。HTTP 不能很好地应对 TCP 丢失,这会引入巨大的延迟。 "netstat -i" 命令将报告每个接口的统计信息。Rx-Ovr 计数器增长的接口表示系统没有足够的资源来接收所有传入数据包,并且它们在被网络驱动程序处理之前就丢失了。Rx-Drp 表示某些接收到的数据包在网络堆栈中丢失,因为应用程序处理它们的速度不够快。这也可能发生在某些攻击期间。Tx-Drp 意味着输出队列已满,数据包必须丢弃。使用 TCP 时应该非常罕见,但可能会表明传出链路已饱和。
HAProxy 设计为以非常有限的权限运行。使用它的标准方法是将其隔离到 chroot jail 中,并将其权限降低到非 root 用户,该用户在该 jail 内没有任何权限,以便如果将来发现任何漏洞,其泄露不会影响系统的其余部分。为了执行 chroot,它首先需要以 root 用户身份启动。构建手动 chroot 以在此处启动进程是毫无意义的,这些 chroot 构建起来很痛苦,从未得到适当维护,并且总是包含比主文件系统更多的错误。而且,如果发生泄露,入侵者可以使用特意构建的文件系统。不幸的是,许多管理员将“以 root 身份启动”与“以 root 身份运行”混淆,导致在启动 haproxy 之前完成 uid 更改,并减少了有效的安全限制。HAProxy 需要以 root 身份启动才能:- 调整文件描述符限制- 绑定到特权端口号- 绑定到特定网络接口- 透明地监听外部地址- 将自身隔离在 chroot jail 内- 降低到另一个非特权 UID HAProxy 可能需要以 root 身份运行才能:- 绑定到用于传出连接的接口- 绑定到用于传出连接的特权源端口- 透明地绑定到用于传出连接的外部地址大多数用户永远不需要“以 root 身份运行”的情况。但是“以 root 身份启动”涵盖了大多数用法。安全的配置将具有:- chroot 语句指向一个没有任何访问权限的空位置。这可以在 UNIX 命令行上以这种方式准备:# mkdir /var/empty && chmod 0 /var/empty || echo "Failed" 并在 HAProxy 配置的全局部分中像这样引用:chroot /var/empty - 全局部分中的 uid/user 和 gid/group 语句:user haproxy group haproxy - stats socket,其 mode、uid 和 gid 设置为匹配允许访问 CLI 的用户和/或组,以便任何人都无法访问它:stats socket /var/run/haproxy.stat uid hatop gid hatop mode 600


HAProxy 2.9.15 – 管理指南
,