From 5c5f17d7554af064325cef6cfbbb4ae3687ad052 Mon Sep 17 00:00:00 2001
From: Guillaume Espanel <guillaume.espanel@ovhcloud.com>
Date: Mon, 19 Feb 2024 15:31:10 +0100
Subject: [PATCH] Add a kombu_reconnect_splay setting

oslo.messaging will now add a random interval comprised between
0 and kombu_reconnect_splay to the Kombu reconnection delay
in case of consumer close errors.

Change-Id: Ibd689270caf3f622e6b2a5a92eceec6fa09eb7be
---
 oslo_messaging/_drivers/impl_rabbit.py                 | 10 ++++++++++
 .../notes/kombo-reconnect-splay-a81eb5fca6180510.yaml  |  7 +++++++
 2 files changed, 17 insertions(+)
 create mode 100644 releasenotes/notes/kombo-reconnect-splay-a81eb5fca6180510.yaml

diff --git a/oslo_messaging/_drivers/impl_rabbit.py b/oslo_messaging/_drivers/impl_rabbit.py
index 63a0cbe70..4d158faf6 100644
--- a/oslo_messaging/_drivers/impl_rabbit.py
+++ b/oslo_messaging/_drivers/impl_rabbit.py
@@ -118,6 +118,11 @@ rabbit_opts = [
                  deprecated_group='DEFAULT',
                  help='How long to wait (in seconds) before reconnecting in '
                       'response to an AMQP consumer cancel notification.'),
+    cfg.FloatOpt('kombu_reconnect_splay',
+                 default=0.0,
+                 min=0.0,
+                 help='Random time to wait for when reconnecting in response '
+                      'to an AMQP consumer cancel notification.'),
     cfg.StrOpt('kombu_compression',
                help="EXPERIMENTAL: Possible values are: gzip, bz2. If not "
                     "set compression will not be used. This option may not "
@@ -751,6 +756,7 @@ class Connection:
             driver_conf.heartbeat_timeout_threshold
         self.heartbeat_rate = driver_conf.heartbeat_rate
         self.kombu_reconnect_delay = driver_conf.kombu_reconnect_delay
+        self.kombu_reconnect_splay = driver_conf.kombu_reconnect_splay
         self.amqp_durable_queues = driver_conf.amqp_durable_queues
         self.amqp_auto_delete = driver_conf.amqp_auto_delete
         self.ssl = driver_conf.ssl
@@ -1095,6 +1101,10 @@ class Connection:
             interval = (self.kombu_reconnect_delay + interval
                         if self.kombu_reconnect_delay > 0
                         else interval)
+            if self.kombu_reconnect_splay > 0:
+                interval += random.uniform(
+                    0,
+                    self.kombu_reconnect_splay)  # nosec
 
             info = {'err_str': exc, 'sleep_time': interval}
             info.update(self._get_connection_info(conn_error=True))
diff --git a/releasenotes/notes/kombo-reconnect-splay-a81eb5fca6180510.yaml b/releasenotes/notes/kombo-reconnect-splay-a81eb5fca6180510.yaml
new file mode 100644
index 000000000..1133b1fb2
--- /dev/null
+++ b/releasenotes/notes/kombo-reconnect-splay-a81eb5fca6180510.yaml
@@ -0,0 +1,7 @@
+---
+features:
+  - |
+    Add a new option named `kombu_reconnect_splay` under
+    `oslo_messaging_rabbit` that could be used to add an extra random delay
+    before any reconnection when a recoverable error occur.
+    This delay is set to 0 by default so the original behavior is not changed.