Merge pull request #819 from rackerlabs/PUC-176-document-notifications

feat: PUC-176: Adding link of OpenStack RabbitMQ Queue Dump Tool in Operators guide for better visibility

Author: haseebsyed12

docs/operator-guide/rabbitmq.md

@@ -61,3 +61,7 @@ kubectl -n openstack exec -it rabbitmq-server-0 -c rabbitmq -- rabbitmqadmin --v
 kubectl -n openstack exec -it rabbitmq-server-0 -c rabbitmq -- rabbitmqadmin --vhost=nova get queue=notifications.info ackmode=ack_requeue_true payload_file=/tmp/test.json
 kubectl -n openstack cp rabbitmq-server-0:/tmp/test.json -c rabbitmq /tmp/test.json
 ```
+
+### To dump, print, list-events, and requeue an openstack notifications rabbitmq queue
+
+use [OpenStack RabbitMQ Queue Dump Tool](https://github.com/rackerlabs/understack/tree/main/examples/openstack-notifications)

examples/openstack-notifications/README.md

@@ -21,13 +21,16 @@ export RABBIT_PASS=$(kubectl -n openstack get secret rabbitmq-default-user -o js
 kubectl -n openstack port-forward svc/rabbitmq 5672
 ```
 
-3. Run the `queue_dump.py` tool:
+4. Use RabbitMq management UI to know more about Virtualhosts, Exchanges, Queues etc, follow the instructions [provided here](https://rackerlabs.github.io/understack/operator-guide/rabbitmq/):
+
+
+5. Run the `queue_dump.py` tool:
 
 ``` text
  python queue_dump.py -h
 usage: queue-dump [-h] -u USERNAME -p PASSWORD [--host HOST] [--port PORT] [--virtualhost VIRTUALHOST] [--queue QUEUE] [-v] [--destroy]
 
-dump, print, and requeue an openstack notifications rabbitmq queue
+dump, print, list-events, and requeue an openstack notifications rabbitmq queue
 
 options:
   -h, --help            show this help message and exit
@@ -52,6 +55,14 @@ options:
 python queue_dump.py -u $RABBIT_USER -p $RABBIT_PASS
 ```
 
+## List OpenStack notifications event types
+
+If you want to understand what are the different event-types being emitted by OpenStack notifications system, you can use:
+
+```
+python queue_dump.py --virtualhost $VIRTUAL_HOST -u $RABBIT_USER -p $RABBIT_PASS --queue notifications.info --list-event-types
+```
+
 ## Find OpenStack notifications for a specific event type
 
 If you need to find a specific event type to troubleshoot something, you can use:

examples/openstack-notifications/queue_dump.py

@@ -30,6 +30,11 @@
     required=False,
     help="Scan for a specific OpenStack notification event type",
 )
+parser.add_argument(
+    "--list-event-types",
+    action="store_true",
+    help="List event_type values found in the queue",
+)
 parser.add_argument(
     "--provision-state",
     type=str,
@@ -73,32 +78,37 @@ def callback(ch, method, properties, body):
     if message:
         parsed["oslo.message"] = message
 
-    if args.event_type or args.provision_state:
-        if args.event_type:
-            event_type = message.get("event_type")
-            if event_type == args.event_type:
-                print(json.dumps(parsed, indent=4))
-
-        if args.provision_state:
-            payload = message.get("payload", {})
-            ironic_object = payload.get("ironic_object.data", {})
-            provision_state = ironic_object.get("provision_state")
-            if provision_state == args.provision_state:
-                print(json.dumps(parsed, indent=4))
-    else:
-        print(json.dumps(parsed, indent=4))
-
-    if args.destroy:
-        print("Destroying message.")
-        # Acknowledge that the message has been handled, removing it from the queue.
-        ch.basic_ack(delivery_tag=method.delivery_tag)
+    event_type = message.get("event_type")
 
+    if args.list_event_types and message.get("event_type", None):
+        print(event_type)
     else:
-        if args.verbose:
-            print("Re-queueing the message.")
-
-        # Requeue the message using using nack
-        ch.basic_nack(delivery_tag=method.delivery_tag, requeue=True)
+        if args.event_type or args.provision_state:
+            if args.event_type:
+                event_type = message.get("event_type")
+                if event_type == args.event_type:
+                    print(json.dumps(parsed, indent=4))
+
+            if args.provision_state:
+                payload = message.get("payload", {})
+                ironic_object = payload.get("ironic_object.data", {})
+                provision_state = ironic_object.get("provision_state")
+                if provision_state == args.provision_state:
+                    print(json.dumps(parsed, indent=4))
+        else:
+            print(json.dumps(parsed, indent=4))
+
+        if args.destroy:
+            print("Destroying message.")
+            # Acknowledge that the message has been handled, removing it from the queue.
+            ch.basic_ack(delivery_tag=method.delivery_tag)
+
+        else:
+            if args.verbose:
+                print("Re-queueing the message.")
+
+            # Requeue the message using using nack
+            ch.basic_nack(delivery_tag=method.delivery_tag, requeue=True)
 
 
 # Set up the consumer to pull messages from the queue
@@ -108,6 +118,7 @@ def callback(ch, method, properties, body):
 try:
     # Start consuming messages
     channel.start_consuming()
+
 except KeyboardInterrupt:
     # Gracefully stop the consumer on CTRL+C
     print("\nStopping consumer.")