RabbitmqHow-ToBeginner · 3 min read

How to Set Heartbeat in RabbitMQ for Connection Health

To set the heartbeat in RabbitMQ, configure it on both the client and server sides. On the server, set the heartbeat value in the RabbitMQ configuration file or via command line, and on the client, specify the heartbeat interval when creating the connection to ensure timely connection health checks.

📐

Syntax

The heartbeat setting controls the interval in seconds for sending heartbeat frames between RabbitMQ server and clients to keep the connection alive.

On the server side, you set it in the rabbitmq.conf file using:

heartbeat = <seconds>

On the client side, it is usually set when creating the connection, for example:

connectionFactory.setRequestedHeartbeat(seconds); in Java
pika.ConnectionParameters(heartbeat=seconds) in Python

bash/python

## Server side (rabbitmq.conf)
heartbeat = 60

# Client side example in Python (pika)
import pika

params = pika.ConnectionParameters('localhost', heartbeat=60)
connection = pika.BlockingConnection(params)

💻

Example

This example shows how to set a 30-second heartbeat interval in Python using the pika library. It ensures the client and server send heartbeat frames every 30 seconds to keep the connection alive and detect failures quickly.

python

import pika

# Set heartbeat to 30 seconds
params = pika.ConnectionParameters('localhost', heartbeat=30)
connection = pika.BlockingConnection(params)
channel = connection.channel()

channel.queue_declare(queue='test')
print('Connected with heartbeat=30 seconds')

connection.close()

Output

Connected with heartbeat=30 seconds

⚠️

Common Pitfalls

Common mistakes when setting heartbeat in RabbitMQ include:

Setting heartbeat only on the client or only on the server, causing mismatched intervals and unexpected connection drops.
Using too low a heartbeat value, which can cause unnecessary network traffic and false connection closures.
Not configuring the server rabbitmq.conf properly or forgetting to restart RabbitMQ after changes.

Always ensure both client and server heartbeat settings match and test the connection stability.

bash/python

## Wrong: Client sets heartbeat but server defaults to 0 (disabled)
# Client side (Python)
params = pika.ConnectionParameters('localhost', heartbeat=10)
connection = pika.BlockingConnection(params)

# Server side (rabbitmq.conf)
# heartbeat not set or set to 0 (disabled)

## Right: Both sides set heartbeat to 10 seconds
# Server side (rabbitmq.conf)
heartbeat = 10

# Client side (Python)
params = pika.ConnectionParameters('localhost', heartbeat=10)
connection = pika.BlockingConnection(params)

📊

Quick Reference

Setting	Description	Example
Server heartbeat	Interval in seconds set in rabbitmq.conf	heartbeat = 60
Client heartbeat	Interval in seconds set in client connection parameters	pika.ConnectionParameters(heartbeat=60)
Recommended value	30-60 seconds balances connection health and network load	heartbeat = 30
Restart required	RabbitMQ server must be restarted after config changes	sudo systemctl restart rabbitmq-server

✅

Key Takeaways

Set heartbeat on both RabbitMQ server and client to keep connections healthy.

Use a heartbeat interval between 30 and 60 seconds for best balance.

Restart RabbitMQ server after changing heartbeat in configuration.

Mismatched heartbeat settings can cause unexpected connection drops.

Test connection stability after setting heartbeat values.