不要往 AMQP 的 Header 乱塞东西

date

Nov 17, 2021

slug

amqp-header-has-frame-max-limit.html

status

Published

前情提要

一直以来，我们在 Python 项目中的后台任务都是使用 celery 搭配 Redis(作为 broker)来完成，同时针对短任务轮询场景我们也做了一些封装。在项目运行的三~四年间，这套方案完美地承载了我们核心功能。

然而，就在不久前的一周，出现一些比较诡异的问题，总是有些后台任务发生阻塞，我们使用的多种异常观测手段（Sentry、日志等）都无法准确定位到具体问题（这或许是另一个故事），于是死马当活马医，我们决定将 Redis 更换为 RabbitMQ，这样能够更为准确地观测到任务具体执行的消息情况（例如是否及时Ack）。

案发现场

更换完 broker 之后，却发现了另一个奇怪的问题（没错，这才是本文的主角）。我们在某一些特殊资源的场景下，celery 任务会直接报错：

ConnectionResetError: [Errno 104] Connection reset by peer
  File "kombu/connection.py", line 414, in _reraise_as_library_errors
    yield
  File "kombu/connection.py", line 494, in _ensured
    return fun(*args, **kwargs)
  File "kombu/messaging.py", line 203, in _publish
    mandatory=mandatory, immediate=immediate,
  File "amqp/channel.py", line 1766, in _basic_publish
    (0, exchange, routing_key, mandatory, immediate), msg
  File "amqp/abstract_channel.py", line 59, in send_method
    conn.frame_writer(1, self.channel_id, sig, args, content)
  File "amqp/method_framing.py", line 154, in write_frame
    2, channel, framelen, frame, 0xce))
  File "amqp/transport.py", line 305, in write
    self._write(s)

由于我们使用了一层 CLB 作为高可用代理，而之前的使用经验中，CLB 可能会有一些长时间无数据断连的情况，所以我们暂时认为可能是某些长时间的阻塞任务会导致 CLB 主动断开，为了排除干扰，我们甩开了 CLB，直接采用 MQ 的多个节点作为地址直连。

然而，问题依旧，一时间又没了头绪，我开始漫无目的重新浏览 Sentry 中的错误堆栈以及相关变量。

蛛丝马迹

无意间，发现在代码中，我们尝试向队列中存储一大段 pickle 过的对象数据，而这些变量在 Sentry 中已经长到无法完整显示而被省略了。

...
any_task.apply_async(headers=something_big)
...

这个问题立马引起了我们的注意🤔，很有可能是这个数据过大而引起写入异常。

破案

照此思路，经过一番网络冲浪，发现了类似的问题：

stackoverflow.com

https://stackoverflow.com/questions/30716002/is-there-a-size-limit-on-a-rabbitmq-message-header

这时候，再去反查 RabbitMQ 的日志，果然有对应内容：

2021-11-16 19:49:32.098 [error] <0.3894.1636> Error on AMQP connection <0.3894.1636> (x.x.x.x:59823 -> x.x.x.x:5672, vhost: 'foo', user: 'foo', state: running), channel 1:
 operation none caused a connection exception frame_error: "type 2, all octets = <<>>: {frame_too_large,245629,131064}"

2021-11-16 19:49:35.099 [error] <0.3894.1636> closing AMQP connection <0.3894.1636> (x.x.x.x:59823 -> x.x.x.x:5672):
fatal_frame_error

这里非常明确地指出了，由于我们传递的 frame 大小(245629 bytes) 大于默认的 131064 + 8(frame header) bytes (128KB)，所以 RabbitMQ 关闭了连接。

于是我们立即着手，精简了向 headers 传送的数据，重新发布后，终于一切归于正常。

梳理

虽然问题已经得到了解决，但是仍旧需要补齐一下相关知识的短板。

首先，让我们再来简单看看 AMQP 0.9.1 版本 协议有关这部分的内容。

AMQP 协议

这是协议中所有 TCP/IP 帧组成

0      1         3         7                 size+7 size+8
+------+---------+---------+ +-------------+ +-----------+
| type | channel |   size  | |   payload   | | frame-end |
+------+---------+---------+ +-------------+ +-----------+
 octet    short      long      'size' octets     octet

General Frame Format

其中有这么几个关键信息：

0-7 bytes 确定了帧的类型和具体的 channel，确定了类型后将会处理 payload

payload 的大小在协议中并没有规定，而是说的是可以通过客户端和服务端的”协商“确定(page 22)

不同类型帧有着不同的 payload 构成

当前问题主要是传递应用数据的场景下，所以我们来看具体承载的 Content 帧

简单点来说，Content 帧就是一系列的 properties 加上二进制的数据部分。这些 properties 将会组成 "content header frame"，它大概是这样的组成：

0          2        4           12               14
+----------+--------+-----------+----------------+------------- - -
| class-id | weight | body size | property flags | property list...
+----------+--------+-----------+----------------+------------- - -
    short    short    long long        short        remainder...