Personalized groups in queue monitoring

Author: Gab

README.md

@@ -5,10 +5,15 @@ redis-priority-queue is a simple work queue similar to [Redis lists](https://red
  - An item can be added with a priority (between -9007199254740992 and 9007199254740992)
  - Queues are automatically de-duplicated (duplicate items are voided when pushing them)
  - Multiple items can be popped from the queue at the same time
- - A queue monitoring tool to easily see how many items are in each queue
+ - A [queue monitoring tool](#queue-monitoring) to easily see how many items are in each queue
 
 redis-priority-queue is based on [Redis sorted sets](https://redis.io/commands#sorted_set) and all sorted sets commands can be used alongside this project.
 
+## Clients
+
+ - [Python client](clients/python/)
+ - [PHP client](clients/php/)
+
 ## Basic usage
 
 ### Bash example
@@ -104,19 +109,27 @@ To use the queue monitor, you need to ensure python is installed and use the fol
 ### Usage example
 
 ```
+# Basic usage
 ./src/queue_monitor.py -H [host] -p [port] (-a [auth] -n [dbnum])
-+-------------------+-------+-----------------+----------------+
-| Queue Name        | Total | Priority <= 100 | Priority > 100 |
-+-------------------+-------+-----------------+----------------+
-| late_fees_pending |    44 |              12 |             32 |
-| new_books         |   223 |             123 |            100 |
-| book_recycle      |    13 |              13 |              0 |
-| book_orders       |   112 |              56 |             56 |
-| book_returns      | 1,144 |           1,120 |             24 |
-+-------------------+-------+-----------------+----------------+
++-------------------+-------+-----------+----------+
+| Queue name        | Total | Up to 100 | From 101 |
++-------------------+-------+-----------+----------+
+| book_orders       |    44 |        12 |       32 |
+| book_recycle      |   223 |       123 |      100 |
+| book_returns      |    13 |        13 |        0 |
+| late_fees_pending |   112 |        56 |       56 |
+| new_books         | 1,144 |     1,120 |       24 |
++-------------------+-------+-----------+----------+
+
+# Specify your own groups
+./src/queue_monitor.py -H [host] -p [port] (-a [auth] -n [dbnum]) -s "0->1000" -s "1001->2000" -s "2001->3000"
++-------------------+-------+------------+----------------+----------------+
+| Queue name        | Total | 0 to 1,000 | 1,001 to 2,000 | 2,001 to 3,000 |
++-------------------+-------+------------+----------------+----------------+
+| book_orders       |    44 |         24 |              9 |             11 |
+| book_recycle      |   223 |        127 |             40 |             56 |
+| book_returns      |    13 |         13 |              0 |              0 |
+| late_fees_pending |   112 |         58 |             13 |             41 |
+| new_books         | 1,144 |      1,142 |              2 |              0 |
++-------------------+-------+------------+----------------+----------------+
 ```
-
-## Clients
-
- - [PHP client](clients/php/)
- - [Python client](clients/python/)

src/queue_monitor.py

@@ -1,5 +1,10 @@
 #!/usr/bin/env python3
 
+# redis-priority-queue -> queue monitor
+# Author: Gabriel Bordeaux (gabfl)
+# Github: https://github.com/gabfl/redis-priority-queue
+# Compatible with python 2 & 3
+
 import sys, getopt, redis, argparse
 from prettytable import PrettyTable
 
@@ -13,35 +18,68 @@
                     help="Redis server authentification")
 parser.add_argument("-n", "--dbnum", type=int, default=0, 
                     help="Redis server database number")
+parser.add_argument("-s", "--sort_groups", action='append', 
+                    help="Sort groups")
 args = parser.parse_args()
 
+def setSortGroups(sortGroups = None):
+    """Return the sorting groups, either user defined or from the default list"""
+    if sortGroups is None: # Default groups
+        return [('-inf', '+inf'), ('-inf', 100), (101, '+inf')];
+    else:
+        groups = [('-inf', '+inf')]; # Default mandatory group (Total)
+        groups.extend([tuple(map(int, sortGroup.split('->'))) for sortGroup in sortGroups])
+        return groups;
+
+def getCount(queueName, min, max):
+    """Fetches set count from Redis"""
+    return r.zcount(queueName, min, max);
+
+def getColumnTitle(min, max):
+    """Human readable column titles"""
+    if str(min) == '-inf' and str(max) == '+inf':
+        return 'Total';
+    elif str(min) == '-inf':
+        return 'Up to ' + '{0:,}'.format(max);
+    elif str(max) == '+inf':
+        return 'From ' + '{0:,}'.format(min);
+    else:
+        return '{0:,}'.format(min) + ' to ' + '{0:,}'.format(max);
+
+def setColumnAlign(titles):
+    """Set PrettyTable column alignment"""
+    global t;
+    for i, title in enumerate(titles):
+        if i == 0: # First column (title)
+            t.align[title] = 'l'; # Left
+        else: # Any other column
+            t.align[title] = 'r'; # Right
+
 # Redis connection
 r = redis.StrictRedis(host=args.host, port=args.port, db=args.dbnum, password=args.auth)
 
-# Get queues
-queueNames = r.smembers('rpq|names')
+# Sort groups
+sortGroups = setSortGroups(args.sort_groups);
 
-# Table titles
-titles=['Queue Name', 'Total', 'Priority <= 100', 'Priority > 100']
+# Column titles (queue name, then a column per sorting group)
+titles = ['Queue name'];
+titles.extend([getColumnTitle(sortGroup[0], sortGroup[1]) for sortGroup in sortGroups]);
 
 # Create table
-t = PrettyTable(titles)
+t = PrettyTable(titles);
+setColumnAlign(titles);
 
-# Column alignment
-t.align['Queue Name'] = "l" # Left align queue names
-t.align['Total'] = "r" # Right align numbers
-t.align['Priority <= 100'] = "r" # Right align numbers
-t.align['Priority > 100'] = "r" # Right align numbers
+# Get queues
+queueNames = r.smembers('rpq|names')
 
 # Add a row par queue
 for queueName in sorted(queueNames):
-    # Get counts
-    countA = r.zcount(queueName, '-inf', '+inf')
-    countB = r.zcount(queueName, '-inf', 100)
-    countC = r.zcount(queueName, 101, '+inf')
+    # Get row
+    row = [queueName.decode("utf-8")]
+    row.extend(['{0:,}'.format(getCount(queueName, sortGroup[0], sortGroup[1])) for sortGroup in sortGroups]);
 
     # Add row
-    t.add_row([queueName.decode("utf-8"), '{0:,}'.format(countA), '{0:,}'.format(countB), '{0:,}'.format(countC)])
+    t.add_row(row);
 
 # Print table
 print (t);

src/redis-priority-queue.lua

@@ -1,7 +1,7 @@
 -- redis-priority-queue
 -- Author: Gabriel Bordeaux (gabfl)
 -- Github: https://github.com/gabfl/redis-priority-queue
--- Version: 1.0.2
+-- Version: 1.0.3
 -- (can only be used in 3.2+)
 
 -- Get mandatory vars