add dashboard controller

Author: jianwu-github

.env

@@ -1,4 +1,5 @@
 REDIS_HOST=localhost
 REDIS_PORT=6379
 REDIS_DB=0
-RQ_POLL_INTERVAL=2500
+RQ_POLL_INTERVAL=2500
+RQ_QUEUES=low,medium,high

app/__init__.py

@@ -7,4 +7,5 @@
 app = Flask(__name__, static_folder='static', template_folder='templates')
 app.config.from_object(Config)
 
+from app import dashboard_controller
 from app import routes

app/dashboard_controller.py

@@ -0,0 +1,31 @@
+from flask import current_app, url_for
+
+from rq import (Queue, Worker, cancel_job, get_failed_queue, pop_connection, push_connection, requeue_job)
+from rq.job import Job
+from rq_scheduler import Scheduler
+
+
+from app import app
+
+
+@app.before_first_request
+def setup_rq_connection():
+    redis_host = current_app.config.get("REDIS_HOST")
+    redis_port = current_app.config.get("REDIS_PORT")
+    redis_db = current_app.config.get("REDIS_DB")
+    queue_list = current_app.config.get("RQ_QUEUES")
+
+    print(f'connecting to Redis {redis_host}:{redis_port}/{redis_db}')
+    print(f'monitoring a list of queue: {queue_list}')
+
+
+@app.before_request
+def prepare_rq_connection():
+    pass
+
+
+@app.teardown_request
+def release_rq_connection(exception=None):
+    pass
+
+

app/routes.py

@@ -1,22 +1,35 @@
-from flask import render_template, redirect, url_for
+from flask import current_app, render_template, redirect, url_for
 
 from app import app
 
 
+def _get_queue_list():
+    rq_queues = current_app.config.get("RQ_QUEUES")
+
+    if rq_queues.find(",") >= 0:
+        return rq_queues.split(",")
+    else:
+        return [rq_queues]
+
+
 @app.route('/')
 @app.route('/index')
 def index():
-    return render_template('index.html')
+    rq_queues = _get_queue_list()
+    rq_workers = _get_queue_list()
+    return render_template('index.html', rq_queues=rq_queues, rq_workers=rq_workers)
 
 
 @app.route('/queues')
 def queues():
-    return render_template('queues.html')
+    rq_queues = _get_queue_list()
+    return render_template('queues.html', rq_queues=rq_queues)
 
 
 @app.route('/workers')
 def workers():
-    return render_template('workers.html')
+    rq_workers = _get_queue_list()
+    return render_template('workers.html', rq_workers=rq_workers)
 
 
 @app.route('/jobs')

app/templates/index.html

@@ -35,6 +35,14 @@ <h3 class="card-title">Queues</h3>
                                 <th>Jobs</th>
                             </tr>
                         </thead>
+                        <tbody>
+                            {% for rq_queue in rq_queues %}
+                                <tr>
+                                <td>{{ rq_queue }}</td>
+                                <td>0</td>
+                                </tr>
+                            {% endfor %}
+                        </tbody>
                     </table>
                 </div>
             </div>
@@ -53,6 +61,15 @@ <h3 class="card-title">Workers</h3>
                                 <th>State</th>
                             </tr>
                         </thead>
+                        <tbody>
+                            {% for rq_worker in rq_workers %}
+                                <tr>
+                                <td>{{ rq_worker }}</td>
+                                <td>{{ rq_worker }}</td>
+                                <td>&nbsp;</td>
+                                </tr>
+                            {% endfor %}
+                        </tbody>
                     </table>
                 </div>
             </div>

app/templates/queues.html

@@ -35,6 +35,14 @@ <h3 class="card-title">Queues</h3>
                                 <th>Jobs</th>
                             </tr>
                         </thead>
+                        <tbody>
+                            {% for rq_queue in rq_queues %}
+                                <tr>
+                                <td>{{ rq_queue }}</td>
+                                <td>0</td>
+                                </tr>
+                            {% endfor %}
+                        </tbody>
                     </table>
                 </div>
             </div>

app/templates/workers.html

@@ -0,0 +1,53 @@
+{% extends "base.html" %}
+
+{% block nav_items %}
+    <ul class="navbar-nav">
+      <li class="nav-item">
+        <a class="nav-link" href="/">Home</a>
+      </li>
+      <li class="nav-item active">
+        <a class="nav-link" href="/workers">Workers <span class="sr-only">(current)</span></a>
+      </li>
+      <li class="nav-item">
+        <a class="nav-link" href="/queues">Queues</a>
+      </li>
+      <li class="nav-item">
+        <a class="nav-link" href="/jobs">Instant Jobs</a>
+      </li>
+      <li class="nav-item">
+        <a class="nav-link" href="/schedulers">Scheduled Jobs</a>
+      </li>
+    </ul>
+{% endblock %}
+
+{% block main_section %}
+    <div class="row mb-3">
+        <div class="col-10 offset-1">
+            <div class="card">
+                <div class="card-header">
+                    <h3 class="card-title">Workers</h3>
+                </div>
+                <div class="card-body">
+                    <table class="table table-hover table-bordered">
+                        <thead class="thead-light">
+                            <tr>
+                                <th>Worker</th>
+                                <th>Queue</th>
+                                <th>State</th>
+                            </tr>
+                        </thead>
+                        <tbody>
+                            {% for rq_worker in rq_workers %}
+                                <tr>
+                                <td>{{ rq_worker }}</td>
+                                <td>{{ rq_worker }}</td>
+                                <td>&nbsp;</td>
+                                </tr>
+                            {% endfor %}
+                        </tbody>
+                    </table>
+                </div>
+            </div>
+        </div>
+    </div>
+{% endblock %}

config.py

@@ -16,4 +16,5 @@ class Config(object):
     REDIS_HOST = os.environ.get('REDIS_HOST') or "localhost"
     REDIS_PORT = os.environ.get('REDIS_PORT') or "6379"
     REDIS_DB = os.environ.get('REDIS_DB') or "0"
+    RQ_QUEUES = os.environ.get('RQ_QUEUES') or "default"
     RQ_POLL_INTERVAL = os.environ.get('RQ_POLL_INTERVAL') or "2500"

requirements.txt

@@ -9,6 +9,7 @@ python-dateutil    # via arrow
 python-dotenv
 redis
 rq
+rq-scheduler
 six
 werkzeug           # via flask
 gunicorn