Server config comment says "heartbeat interval", docs say "heartbeat timeout"

[adamhooper]

The heartbeat documentation does not agree with server-config comments..

According to the docs (emphasis mine):

It is important to not confuse the timeout value with the interval one. RabbitMQ configuration exposes the timeout value, so do the officially supported client libraries. However some clients might expose the interval, potentially causing confusion.

Reading this, I paraphrase: "okay, the server and these docs are aligned on 'heartbeat timeout', and I should ignore clients' docs because they might be wrong."

And indeed, as the docs warn, clients are confusing. For instance, Pika docs (emphasis mine):

Starting with RabbitMQ 3.5.5, the broker’s default heartbeat timeout decreased from 580 seconds to 60 seconds.

But.... from deps/rabbit/docs/rabbitmq.conf.example:

## Set the default AMQP 0-9-1 heartbeat interval (in seconds).
## Related doc guides:
##
## * https://rabbitmq.com/heartbeats.html
## * https://rabbitmq.com/networking.html
##
# heartbeat = 60

Reading this, I paraphrase: "This is the very opposite of what the docs say. Indeed, the docs warn me to watch out for code like this because it's confusing."

Indeed, it isn't a heartbeat interval: with heartbeat = 60, RabbitMQ sends a heartbeat frame every 30s. (I tested.)

[michaelklishin]

I will convert this issue to a GitHub discussion. Currently GitHub will automatically close and lock the issue even though your question will be transferred and responded to elsewhere. This is to let you know that we do not intend to ignore this but this is how the current GitHub conversion mechanism makes it seem for the users :(