From 5f0f73dc5edc6262cd2609dcfaab1414f7a74345 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krzysztof=20Zaj=C4=85c?= Date: Thu, 11 Jan 2024 08:50:18 +0100 Subject: [PATCH 01/13] Dashboard can be served on a non-root path --- karton/dashboard/app.py | 46 +++++++++++++----------- karton/dashboard/templates/analysis.html | 4 +-- karton/dashboard/templates/crashed.html | 2 +- karton/dashboard/templates/index.html | 2 +- karton/dashboard/templates/layout.html | 10 +++--- karton/dashboard/templates/queue.html | 2 +- karton/dashboard/templates/task.html | 4 +-- requirements.txt | 2 +- 8 files changed, 39 insertions(+), 33 deletions(-) diff --git a/karton/dashboard/app.py b/karton/dashboard/app.py index 0c642fb..2f2af84 100644 --- a/karton/dashboard/app.py +++ b/karton/dashboard/app.py @@ -14,7 +14,7 @@ Flask, jsonify, redirect, - render_template, + render_template as flask_render_template, request, send_from_directory, ) @@ -43,6 +43,8 @@ class KartonDashboard(KartonBase): karton = KartonDashboard() +base_path = karton.config.get("dashboard", "base_path") if karton.config.has_option("dashboard", "base_path") else "" + markdown = mistune.create_markdown( escape=True, renderer="html", @@ -50,6 +52,10 @@ class KartonDashboard(KartonBase): ) + +def render_template(template_name: str, **kwargs: Dict[str, Any]) -> str: + return flask_render_template(template_name, base_path=base_path, **kwargs) + def cancel_tasks(tasks: List[Task]) -> None: for task in tasks: karton.backend.set_task_status(task=task, status=TaskState.FINISHED) @@ -191,7 +197,7 @@ def add_metrics(state: KartonState, metric: KartonMetrics, key: str) -> None: karton_metrics.labels(key, name).set(value) -@app.route("/varz", methods=["GET"]) +@app.route(base_path + "/varz", methods=["GET"]) def varz(): """Update and get prometheus metrics""" @@ -226,18 +232,18 @@ def varz(): return generate_latest() -@app.route("/static/", methods=["GET"]) +@app.route(base_path + "/static/", methods=["GET"]) def static(path: str): return send_from_directory(static_folder, path) -@app.route("/", methods=["GET"]) +@app.route(base_path + "/", methods=["GET"]) def get_queues(): state = KartonState(karton.backend) return render_template("index.html", queues=state.queues) -@app.route("/services", methods=["GET"]) +@app.route(base_path + "/services", methods=["GET"]) def get_services(): aggregated_services = defaultdict(list) online_services = karton.backend.get_online_services() @@ -246,7 +252,7 @@ def get_services(): return render_template("services.html", services=aggregated_services) -@app.route("/api/queues", methods=["GET"]) +@app.route(base_path + "/api/queues", methods=["GET"]) def get_queues_api(): state = KartonState(karton.backend) return jsonify( @@ -257,7 +263,7 @@ def get_queues_api(): ) -@app.route("//restart_crashed", methods=["POST"]) +@app.route(base_path + "//restart_crashed", methods=["POST"]) def restart_crashed_queue_tasks(queue_name): state = KartonState(karton.backend) queue = state.queues.get(queue_name) @@ -269,7 +275,7 @@ def restart_crashed_queue_tasks(queue_name): return redirect(request.referrer) -@app.route("//cancel_crashed", methods=["POST"]) +@app.route(base_path + "//cancel_crashed", methods=["POST"]) def cancel_crashed_queue_tasks(queue_name): state = KartonState(karton.backend) queue = state.queues.get(queue_name) @@ -280,7 +286,7 @@ def cancel_crashed_queue_tasks(queue_name): return redirect(request.referrer) -@app.route("//cancel_pending", methods=["POST"]) +@app.route(base_path + "//cancel_pending", methods=["POST"]) def cancel_pending_queue_tasks(queue_name): state = KartonState(karton.backend) queue = state.queues.get(queue_name) @@ -291,7 +297,7 @@ def cancel_pending_queue_tasks(queue_name): return redirect(request.referrer) -@app.route("/restart_task//restart", methods=["POST"]) +@app.route(base_path + "/restart_task//restart", methods=["POST"]) def restart_task(task_id): task = karton.backend.get_task(task_id) if not task: @@ -301,7 +307,7 @@ def restart_task(task_id): return redirect(request.referrer) -@app.route("/cancel_task//cancel", methods=["POST"]) +@app.route(base_path + "/cancel_task//cancel", methods=["POST"]) def cancel_task(task_id): task = karton.backend.get_task(task_id) if not task: @@ -311,7 +317,7 @@ def cancel_task(task_id): return redirect(request.referrer) -@app.route("/queue/", methods=["GET"]) +@app.route(base_path + "/queue/", methods=["GET"]) def get_queue(queue_name): state = KartonState(karton.backend) queue = state.queues.get(queue_name) @@ -321,7 +327,7 @@ def get_queue(queue_name): return render_template("queue.html", name=queue_name, queue=queue) -@app.route("/queue//crashed", methods=["GET"]) +@app.route(base_path + "/queue//crashed", methods=["GET"]) def get_crashed_queue(queue_name): state = KartonState(karton.backend) queue = state.queues.get(queue_name) @@ -331,7 +337,7 @@ def get_crashed_queue(queue_name): return render_template("crashed.html", name=queue_name, queue=queue) -@app.route("/api/queue/", methods=["GET"]) +@app.route(base_path + "/api/queue/", methods=["GET"]) def get_queue_api(queue_name): state = KartonState(karton.backend) queue = state.queues.get(queue_name) @@ -340,7 +346,7 @@ def get_queue_api(queue_name): return jsonify(QueueView(queue).to_dict()) -@app.route("/task/", methods=["GET"]) +@app.route(base_path + "/task/", methods=["GET"]) def get_task(task_id): task = karton.backend.get_task(task_id) if not task: @@ -351,7 +357,7 @@ def get_task(task_id): ) -@app.route("/api/task/", methods=["GET"]) +@app.route(base_path + "/api/task/", methods=["GET"]) def get_task_api(task_id): task = karton.backend.get_task(task_id) if not task: @@ -359,7 +365,7 @@ def get_task_api(task_id): return jsonify(TaskView(task).to_dict()) -@app.route("/analysis/", methods=["GET"]) +@app.route(base_path + "/analysis/", methods=["GET"]) def get_analysis(root_id): state = KartonState(karton.backend) analysis = state.analyses.get(root_id) @@ -371,7 +377,7 @@ def get_analysis(root_id): ) -@app.route("/api/analysis/", methods=["GET"]) +@app.route(base_path + "/api/analysis/", methods=["GET"]) def get_analysis_api(root_id): state = KartonState(karton.backend) analysis = state.analyses.get(root_id) @@ -381,12 +387,12 @@ def get_analysis_api(root_id): return jsonify(AnalysisView(analysis).to_dict()) -@app.route("/graph", methods=["GET"]) +@app.route(base_path + "/graph", methods=["GET"]) def get_graph(): return render_template("graph.html") -@app.route("/graph/generate", methods=["GET"]) +@app.route(base_path + "/graph/generate", methods=["GET"]) def generate_graph(): state = KartonState(karton.backend) graph = KartonGraph(state) diff --git a/karton/dashboard/templates/analysis.html b/karton/dashboard/templates/analysis.html index 104adff..1a4e28c 100644 --- a/karton/dashboard/templates/analysis.html +++ b/karton/dashboard/templates/analysis.html @@ -32,10 +32,10 @@

Tasks

{% for task in queue.pending_tasks %} - {{identity}} + {{identity}} - {{ task.uid }} + {{ task.uid }} {% if task.priority.value != 'normal' %} diff --git a/karton/dashboard/templates/crashed.html b/karton/dashboard/templates/crashed.html index d1fd9e6..39aae0e 100644 --- a/karton/dashboard/templates/crashed.html +++ b/karton/dashboard/templates/crashed.html @@ -28,7 +28,7 @@

{% for task in queue.crashed_tasks|sort(attribute='last_update', reverse=True) %} - {{ task.uid }} + {{ task.uid }} 
{{ task.last_update|render_timestamp }}
diff --git a/karton/dashboard/templates/index.html b/karton/dashboard/templates/index.html index dab7727..5dd2269 100644 --- a/karton/dashboard/templates/index.html +++ b/karton/dashboard/templates/index.html @@ -17,7 +17,7 @@

binds

{% for (queue_name, queue) in queues|dictsort %} - {{ queue_name }} + {{ queue_name }}
diff --git a/karton/dashboard/templates/layout.html b/karton/dashboard/templates/layout.html index 1b10c76..d3c7fab 100644 --- a/karton/dashboard/templates/layout.html +++ b/karton/dashboard/templates/layout.html @@ -4,24 +4,24 @@ {% block title %}karton-dashboard{% endblock %} - +
- karton + karton diff --git a/karton/dashboard/templates/queue.html b/karton/dashboard/templates/queue.html index 8dc8480..3a997cb 100644 --- a/karton/dashboard/templates/queue.html +++ b/karton/dashboard/templates/queue.html @@ -23,7 +23,7 @@

{% for task in queue.pending_tasks|sort(attribute='last_update', reverse=True) %} - {{ task.uid }} + {{ task.uid }} 
{{ task.last_update|render_timestamp }}
diff --git a/karton/dashboard/templates/task.html b/karton/dashboard/templates/task.html index 853c31b..70d00d2 100644 --- a/karton/dashboard/templates/task.html +++ b/karton/dashboard/templates/task.html @@ -23,11 +23,11 @@

task {{ task.uid }}

Origin
- {{task.headers['origin']}} + {{task.headers['origin']}}
Receiver
- {{task.headers['receiver']}} + {{task.headers['receiver']}}
Xrefs
diff --git a/requirements.txt b/requirements.txt index 78a4790..b62d18e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -Flask==2.0.3 +Flask==3.0.0 karton-core>=5.1.0,<6.0.0 mistune<3.0.0 prometheus_client==0.11.0 From 6d55566ea500d3d23029530dbfc319122f921f0d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krzysztof=20Zaj=C4=85c?= Date: Thu, 11 Jan 2024 11:12:12 +0100 Subject: [PATCH 02/13] newline fix --- karton/dashboard/app.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/karton/dashboard/app.py b/karton/dashboard/app.py index 2f2af84..5dca390 100644 --- a/karton/dashboard/app.py +++ b/karton/dashboard/app.py @@ -52,10 +52,10 @@ class KartonDashboard(KartonBase): ) - def render_template(template_name: str, **kwargs: Dict[str, Any]) -> str: return flask_render_template(template_name, base_path=base_path, **kwargs) + def cancel_tasks(tasks: List[Task]) -> None: for task in tasks: karton.backend.set_task_status(task=task, status=TaskState.FINISHED) From 32c448d31413b4f77f46fe618986181c6afd8674 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krzysztof=20Zaj=C4=85c?= Date: Thu, 11 Jan 2024 11:13:50 +0100 Subject: [PATCH 03/13] isort --- karton/dashboard/app.py | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/karton/dashboard/app.py b/karton/dashboard/app.py index 5dca390..d3bdde6 100644 --- a/karton/dashboard/app.py +++ b/karton/dashboard/app.py @@ -10,14 +10,9 @@ from typing import Any, Dict, List, Optional, Tuple import mistune # type: ignore -from flask import ( # type: ignore - Flask, - jsonify, - redirect, - render_template as flask_render_template, - request, - send_from_directory, -) +from flask import Flask, jsonify, redirect +from flask import render_template as flask_render_template # type: ignore +from flask import request, send_from_directory from karton.core.backend import KartonMetrics from karton.core.base import KartonBase from karton.core.inspect import KartonAnalysis, KartonQueue, KartonState From 5d77c220bb477a9debccffcd7278f461cf3ebd77 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krzysztof=20Zaj=C4=85c?= Date: Thu, 11 Jan 2024 11:14:28 +0100 Subject: [PATCH 04/13] path fix --- karton/dashboard/templates/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/karton/dashboard/templates/index.html b/karton/dashboard/templates/index.html index 5dd2269..baaa5c1 100644 --- a/karton/dashboard/templates/index.html +++ b/karton/dashboard/templates/index.html @@ -17,7 +17,7 @@

binds

{% for (queue_name, queue) in queues|dictsort %} - {{ queue_name }} + {{ queue_name }}
From 467b465b634a6c000918247106e91799c71bbc1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krzysztof=20Zaj=C4=85c?= Date: Thu, 11 Jan 2024 11:20:03 +0100 Subject: [PATCH 05/13] lint --- karton/dashboard/app.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/karton/dashboard/app.py b/karton/dashboard/app.py index d3bdde6..b95c39d 100644 --- a/karton/dashboard/app.py +++ b/karton/dashboard/app.py @@ -38,7 +38,11 @@ class KartonDashboard(KartonBase): karton = KartonDashboard() -base_path = karton.config.get("dashboard", "base_path") if karton.config.has_option("dashboard", "base_path") else "" +base_path = ( + karton.config.get("dashboard", "base_path") + if karton.config.has_option("dashboard", "base_path") + else "" +) markdown = mistune.create_markdown( escape=True, @@ -209,7 +213,7 @@ def varz(): task_infos[(safe_name, task.priority, task.status)] += 1 # set the default of active queues to 0 to avoid gaps in graphs - for (priority, status) in product(TaskPriority, TaskState): + for priority, status in product(TaskPriority, TaskState): karton_tasks.labels(safe_name, priority.value, status.value).set(0) for (name, priority, status), count in task_infos.items(): From 2119d200e5ab901d80fc6238c41b29513c0b1433 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krzysztof=20Zaj=C4=85c?= Date: Fri, 12 Jan 2024 18:35:42 +0100 Subject: [PATCH 06/13] . --- karton/dashboard/app.py | 68 +++++++++++++----------- karton/dashboard/templates/analysis.html | 4 +- karton/dashboard/templates/crashed.html | 2 +- karton/dashboard/templates/index.html | 2 +- karton/dashboard/templates/layout.html | 10 ++-- karton/dashboard/templates/queue.html | 2 +- karton/dashboard/templates/task.html | 4 +- 7 files changed, 49 insertions(+), 43 deletions(-) diff --git a/karton/dashboard/app.py b/karton/dashboard/app.py index b95c39d..5384104 100644 --- a/karton/dashboard/app.py +++ b/karton/dashboard/app.py @@ -10,9 +10,14 @@ from typing import Any, Dict, List, Optional, Tuple import mistune # type: ignore -from flask import Flask, jsonify, redirect -from flask import render_template as flask_render_template # type: ignore -from flask import request, send_from_directory +from flask import ( + Flask, + jsonify, + redirect, + render_template, + request, + send_from_directory, +) from karton.core.backend import KartonMetrics from karton.core.base import KartonBase from karton.core.inspect import KartonAnalysis, KartonQueue, KartonState @@ -24,11 +29,6 @@ logging.basicConfig(level=logging.INFO) -app_path = Path(__file__).parent -static_folder = app_path / "static" -graph_folder = app_path / "graph" -app = Flask(__name__, static_folder=None, template_folder=str(app_path / "templates")) - class KartonDashboard(KartonBase): identity = "karton.dashboard" @@ -44,6 +44,16 @@ class KartonDashboard(KartonBase): else "" ) +app_path = Path(__file__).parent +static_folder = app_path / "static" +graph_folder = app_path / "graph" +app = Flask(__name__, static_folder=None) +blueprint = Blueprint( + "karton-dashboard", __name__, template_folder=str(app_path / "templates") +) +app.register_blueprint(blueprint, url_prefix=base_path) + + markdown = mistune.create_markdown( escape=True, renderer="html", @@ -51,10 +61,6 @@ class KartonDashboard(KartonBase): ) -def render_template(template_name: str, **kwargs: Dict[str, Any]) -> str: - return flask_render_template(template_name, base_path=base_path, **kwargs) - - def cancel_tasks(tasks: List[Task]) -> None: for task in tasks: karton.backend.set_task_status(task=task, status=TaskState.FINISHED) @@ -196,7 +202,7 @@ def add_metrics(state: KartonState, metric: KartonMetrics, key: str) -> None: karton_metrics.labels(key, name).set(value) -@app.route(base_path + "/varz", methods=["GET"]) +@app.route("/varz", methods=["GET"]) def varz(): """Update and get prometheus metrics""" @@ -231,18 +237,18 @@ def varz(): return generate_latest() -@app.route(base_path + "/static/", methods=["GET"]) +@app.route("/static/", methods=["GET"]) def static(path: str): return send_from_directory(static_folder, path) -@app.route(base_path + "/", methods=["GET"]) +@app.route("/", methods=["GET"]) def get_queues(): state = KartonState(karton.backend) return render_template("index.html", queues=state.queues) -@app.route(base_path + "/services", methods=["GET"]) +@app.route("/services", methods=["GET"]) def get_services(): aggregated_services = defaultdict(list) online_services = karton.backend.get_online_services() @@ -251,7 +257,7 @@ def get_services(): return render_template("services.html", services=aggregated_services) -@app.route(base_path + "/api/queues", methods=["GET"]) +@app.route("/api/queues", methods=["GET"]) def get_queues_api(): state = KartonState(karton.backend) return jsonify( @@ -262,7 +268,7 @@ def get_queues_api(): ) -@app.route(base_path + "//restart_crashed", methods=["POST"]) +@app.route("//restart_crashed", methods=["POST"]) def restart_crashed_queue_tasks(queue_name): state = KartonState(karton.backend) queue = state.queues.get(queue_name) @@ -274,7 +280,7 @@ def restart_crashed_queue_tasks(queue_name): return redirect(request.referrer) -@app.route(base_path + "//cancel_crashed", methods=["POST"]) +@app.route("//cancel_crashed", methods=["POST"]) def cancel_crashed_queue_tasks(queue_name): state = KartonState(karton.backend) queue = state.queues.get(queue_name) @@ -285,7 +291,7 @@ def cancel_crashed_queue_tasks(queue_name): return redirect(request.referrer) -@app.route(base_path + "//cancel_pending", methods=["POST"]) +@app.route("//cancel_pending", methods=["POST"]) def cancel_pending_queue_tasks(queue_name): state = KartonState(karton.backend) queue = state.queues.get(queue_name) @@ -296,7 +302,7 @@ def cancel_pending_queue_tasks(queue_name): return redirect(request.referrer) -@app.route(base_path + "/restart_task//restart", methods=["POST"]) +@app.route("/restart_task//restart", methods=["POST"]) def restart_task(task_id): task = karton.backend.get_task(task_id) if not task: @@ -306,7 +312,7 @@ def restart_task(task_id): return redirect(request.referrer) -@app.route(base_path + "/cancel_task//cancel", methods=["POST"]) +@app.route("/cancel_task//cancel", methods=["POST"]) def cancel_task(task_id): task = karton.backend.get_task(task_id) if not task: @@ -316,7 +322,7 @@ def cancel_task(task_id): return redirect(request.referrer) -@app.route(base_path + "/queue/", methods=["GET"]) +@app.route("/queue/", methods=["GET"]) def get_queue(queue_name): state = KartonState(karton.backend) queue = state.queues.get(queue_name) @@ -326,7 +332,7 @@ def get_queue(queue_name): return render_template("queue.html", name=queue_name, queue=queue) -@app.route(base_path + "/queue//crashed", methods=["GET"]) +@app.route("/queue//crashed", methods=["GET"]) def get_crashed_queue(queue_name): state = KartonState(karton.backend) queue = state.queues.get(queue_name) @@ -336,7 +342,7 @@ def get_crashed_queue(queue_name): return render_template("crashed.html", name=queue_name, queue=queue) -@app.route(base_path + "/api/queue/", methods=["GET"]) +@app.route("/api/queue/", methods=["GET"]) def get_queue_api(queue_name): state = KartonState(karton.backend) queue = state.queues.get(queue_name) @@ -345,7 +351,7 @@ def get_queue_api(queue_name): return jsonify(QueueView(queue).to_dict()) -@app.route(base_path + "/task/", methods=["GET"]) +@app.route("/task/", methods=["GET"]) def get_task(task_id): task = karton.backend.get_task(task_id) if not task: @@ -356,7 +362,7 @@ def get_task(task_id): ) -@app.route(base_path + "/api/task/", methods=["GET"]) +@app.route("/api/task/", methods=["GET"]) def get_task_api(task_id): task = karton.backend.get_task(task_id) if not task: @@ -364,7 +370,7 @@ def get_task_api(task_id): return jsonify(TaskView(task).to_dict()) -@app.route(base_path + "/analysis/", methods=["GET"]) +@app.route("/analysis/", methods=["GET"]) def get_analysis(root_id): state = KartonState(karton.backend) analysis = state.analyses.get(root_id) @@ -376,7 +382,7 @@ def get_analysis(root_id): ) -@app.route(base_path + "/api/analysis/", methods=["GET"]) +@app.route("/api/analysis/", methods=["GET"]) def get_analysis_api(root_id): state = KartonState(karton.backend) analysis = state.analyses.get(root_id) @@ -386,12 +392,12 @@ def get_analysis_api(root_id): return jsonify(AnalysisView(analysis).to_dict()) -@app.route(base_path + "/graph", methods=["GET"]) +@app.route("/graph", methods=["GET"]) def get_graph(): return render_template("graph.html") -@app.route(base_path + "/graph/generate", methods=["GET"]) +@app.route("/graph/generate", methods=["GET"]) def generate_graph(): state = KartonState(karton.backend) graph = KartonGraph(state) diff --git a/karton/dashboard/templates/analysis.html b/karton/dashboard/templates/analysis.html index 1a4e28c..59de687 100644 --- a/karton/dashboard/templates/analysis.html +++ b/karton/dashboard/templates/analysis.html @@ -32,10 +32,10 @@

Tasks

{% for task in queue.pending_tasks %} - {{identity}} + {{identity}} - {{ task.uid }} + {{ task.uid }} {% if task.priority.value != 'normal' %} diff --git a/karton/dashboard/templates/crashed.html b/karton/dashboard/templates/crashed.html index 39aae0e..ed0894d 100644 --- a/karton/dashboard/templates/crashed.html +++ b/karton/dashboard/templates/crashed.html @@ -28,7 +28,7 @@

{% for task in queue.crashed_tasks|sort(attribute='last_update', reverse=True) %} - {{ task.uid }} + {{ task.uid }} 
{{ task.last_update|render_timestamp }}
diff --git a/karton/dashboard/templates/index.html b/karton/dashboard/templates/index.html index baaa5c1..2ad1a98 100644 --- a/karton/dashboard/templates/index.html +++ b/karton/dashboard/templates/index.html @@ -17,7 +17,7 @@

binds

{% for (queue_name, queue) in queues|dictsort %} - {{ queue_name }} + {{ queue_name }}
diff --git a/karton/dashboard/templates/layout.html b/karton/dashboard/templates/layout.html index d3c7fab..f92c7e1 100644 --- a/karton/dashboard/templates/layout.html +++ b/karton/dashboard/templates/layout.html @@ -4,24 +4,24 @@ {% block title %}karton-dashboard{% endblock %} - +
- karton + karton diff --git a/karton/dashboard/templates/queue.html b/karton/dashboard/templates/queue.html index 3a997cb..8a342ea 100644 --- a/karton/dashboard/templates/queue.html +++ b/karton/dashboard/templates/queue.html @@ -23,7 +23,7 @@

{% for task in queue.pending_tasks|sort(attribute='last_update', reverse=True) %} - {{ task.uid }} + {{ task.uid }} 
{{ task.last_update|render_timestamp }}
diff --git a/karton/dashboard/templates/task.html b/karton/dashboard/templates/task.html index 70d00d2..c65fef4 100644 --- a/karton/dashboard/templates/task.html +++ b/karton/dashboard/templates/task.html @@ -23,11 +23,11 @@

task {{ task.uid }}

Origin
- {{task.headers['origin']}} + {{task.headers['origin']}}
Receiver
- {{task.headers['receiver']}} + {{task.headers['receiver']}}
Xrefs
From 037ec95f3dd0a19c72785512cdb8b1e0f81cd26a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krzysztof=20Zaj=C4=85c?= Date: Fri, 12 Jan 2024 18:37:22 +0100 Subject: [PATCH 07/13] . --- karton/dashboard/app.py | 1 + 1 file changed, 1 insertion(+) diff --git a/karton/dashboard/app.py b/karton/dashboard/app.py index 5384104..7699c05 100644 --- a/karton/dashboard/app.py +++ b/karton/dashboard/app.py @@ -11,6 +11,7 @@ import mistune # type: ignore from flask import ( + Blueprint, Flask, jsonify, redirect, From 42e74bd8d06f6bd7929fb913c3eb5aa9a220ca7e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krzysztof=20Zaj=C4=85c?= Date: Fri, 12 Jan 2024 18:39:40 +0100 Subject: [PATCH 08/13] . --- karton/dashboard/app.py | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/karton/dashboard/app.py b/karton/dashboard/app.py index 7699c05..c1ee6a4 100644 --- a/karton/dashboard/app.py +++ b/karton/dashboard/app.py @@ -203,7 +203,7 @@ def add_metrics(state: KartonState, metric: KartonMetrics, key: str) -> None: karton_metrics.labels(key, name).set(value) -@app.route("/varz", methods=["GET"]) +@blueprint.route("/varz", methods=["GET"]) def varz(): """Update and get prometheus metrics""" @@ -238,18 +238,18 @@ def varz(): return generate_latest() -@app.route("/static/", methods=["GET"]) +@blueprint.route("/static/", methods=["GET"]) def static(path: str): return send_from_directory(static_folder, path) -@app.route("/", methods=["GET"]) +@blueprint.route("/", methods=["GET"]) def get_queues(): state = KartonState(karton.backend) return render_template("index.html", queues=state.queues) -@app.route("/services", methods=["GET"]) +@blueprint.route("/services", methods=["GET"]) def get_services(): aggregated_services = defaultdict(list) online_services = karton.backend.get_online_services() @@ -258,7 +258,7 @@ def get_services(): return render_template("services.html", services=aggregated_services) -@app.route("/api/queues", methods=["GET"]) +@blueprint.route("/api/queues", methods=["GET"]) def get_queues_api(): state = KartonState(karton.backend) return jsonify( @@ -269,7 +269,7 @@ def get_queues_api(): ) -@app.route("//restart_crashed", methods=["POST"]) +@blueprint.route("//restart_crashed", methods=["POST"]) def restart_crashed_queue_tasks(queue_name): state = KartonState(karton.backend) queue = state.queues.get(queue_name) @@ -281,7 +281,7 @@ def restart_crashed_queue_tasks(queue_name): return redirect(request.referrer) -@app.route("//cancel_crashed", methods=["POST"]) +@blueprint.route("//cancel_crashed", methods=["POST"]) def cancel_crashed_queue_tasks(queue_name): state = KartonState(karton.backend) queue = state.queues.get(queue_name) @@ -292,7 +292,7 @@ def cancel_crashed_queue_tasks(queue_name): return redirect(request.referrer) -@app.route("//cancel_pending", methods=["POST"]) +@blueprint.route("//cancel_pending", methods=["POST"]) def cancel_pending_queue_tasks(queue_name): state = KartonState(karton.backend) queue = state.queues.get(queue_name) @@ -303,7 +303,7 @@ def cancel_pending_queue_tasks(queue_name): return redirect(request.referrer) -@app.route("/restart_task//restart", methods=["POST"]) +@blueprint.route("/restart_task//restart", methods=["POST"]) def restart_task(task_id): task = karton.backend.get_task(task_id) if not task: @@ -313,7 +313,7 @@ def restart_task(task_id): return redirect(request.referrer) -@app.route("/cancel_task//cancel", methods=["POST"]) +@blueprint.route("/cancel_task//cancel", methods=["POST"]) def cancel_task(task_id): task = karton.backend.get_task(task_id) if not task: @@ -323,7 +323,7 @@ def cancel_task(task_id): return redirect(request.referrer) -@app.route("/queue/", methods=["GET"]) +@blueprint.route("/queue/", methods=["GET"]) def get_queue(queue_name): state = KartonState(karton.backend) queue = state.queues.get(queue_name) @@ -333,7 +333,7 @@ def get_queue(queue_name): return render_template("queue.html", name=queue_name, queue=queue) -@app.route("/queue//crashed", methods=["GET"]) +@blueprint.route("/queue//crashed", methods=["GET"]) def get_crashed_queue(queue_name): state = KartonState(karton.backend) queue = state.queues.get(queue_name) @@ -343,7 +343,7 @@ def get_crashed_queue(queue_name): return render_template("crashed.html", name=queue_name, queue=queue) -@app.route("/api/queue/", methods=["GET"]) +@blueprint.route("/api/queue/", methods=["GET"]) def get_queue_api(queue_name): state = KartonState(karton.backend) queue = state.queues.get(queue_name) @@ -352,7 +352,7 @@ def get_queue_api(queue_name): return jsonify(QueueView(queue).to_dict()) -@app.route("/task/", methods=["GET"]) +@blueprint.route("/task/", methods=["GET"]) def get_task(task_id): task = karton.backend.get_task(task_id) if not task: @@ -363,7 +363,7 @@ def get_task(task_id): ) -@app.route("/api/task/", methods=["GET"]) +@blueprint.route("/api/task/", methods=["GET"]) def get_task_api(task_id): task = karton.backend.get_task(task_id) if not task: @@ -371,7 +371,7 @@ def get_task_api(task_id): return jsonify(TaskView(task).to_dict()) -@app.route("/analysis/", methods=["GET"]) +@blueprint.route("/analysis/", methods=["GET"]) def get_analysis(root_id): state = KartonState(karton.backend) analysis = state.analyses.get(root_id) @@ -383,7 +383,7 @@ def get_analysis(root_id): ) -@app.route("/api/analysis/", methods=["GET"]) +@blueprint.route("/api/analysis/", methods=["GET"]) def get_analysis_api(root_id): state = KartonState(karton.backend) analysis = state.analyses.get(root_id) @@ -393,12 +393,12 @@ def get_analysis_api(root_id): return jsonify(AnalysisView(analysis).to_dict()) -@app.route("/graph", methods=["GET"]) +@blueprint.route("/graph", methods=["GET"]) def get_graph(): return render_template("graph.html") -@app.route("/graph/generate", methods=["GET"]) +@blueprint.route("/graph/generate", methods=["GET"]) def generate_graph(): state = KartonState(karton.backend) graph = KartonGraph(state) From 7ed1f391e7792a966c17592d7498a85c35b3f6f4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krzysztof=20Zaj=C4=85c?= Date: Fri, 12 Jan 2024 18:49:52 +0100 Subject: [PATCH 09/13] . --- karton/dashboard/app.py | 6 ++++-- karton/dashboard/templates/analysis.html | 4 ++-- karton/dashboard/templates/crashed.html | 10 +++++----- karton/dashboard/templates/index.html | 4 ++-- karton/dashboard/templates/layout.html | 12 ++++++------ karton/dashboard/templates/queue.html | 6 +++--- karton/dashboard/templates/queue_layout.html | 4 ++-- karton/dashboard/templates/task.html | 6 +++--- 8 files changed, 27 insertions(+), 25 deletions(-) diff --git a/karton/dashboard/app.py b/karton/dashboard/app.py index c1ee6a4..6338d97 100644 --- a/karton/dashboard/app.py +++ b/karton/dashboard/app.py @@ -50,9 +50,8 @@ class KartonDashboard(KartonBase): graph_folder = app_path / "graph" app = Flask(__name__, static_folder=None) blueprint = Blueprint( - "karton-dashboard", __name__, template_folder=str(app_path / "templates") + "dashboard", __name__, template_folder=str(app_path / "templates") ) -app.register_blueprint(blueprint, url_prefix=base_path) markdown = mistune.create_markdown( @@ -405,3 +404,6 @@ def generate_graph(): raw_graph = graph.generate_graph() return raw_graph + + +app.register_blueprint(blueprint, url_prefix=base_path) diff --git a/karton/dashboard/templates/analysis.html b/karton/dashboard/templates/analysis.html index 59de687..358d269 100644 --- a/karton/dashboard/templates/analysis.html +++ b/karton/dashboard/templates/analysis.html @@ -32,10 +32,10 @@

Tasks

{% for task in queue.pending_tasks %} - {{identity}} + {{identity}} - {{ task.uid }} + {{ task.uid }} {% if task.priority.value != 'normal' %} diff --git a/karton/dashboard/templates/crashed.html b/karton/dashboard/templates/crashed.html index ed0894d..c2a3518 100644 --- a/karton/dashboard/templates/crashed.html +++ b/karton/dashboard/templates/crashed.html @@ -4,11 +4,11 @@

Crashed tasks {% if queue.crashed_tasks %}
-
+
-
+
@@ -28,7 +28,7 @@

{% for task in queue.crashed_tasks|sort(attribute='last_update', reverse=True) %} - {{ task.uid }} + {{ task.uid }} 
{{ task.last_update|render_timestamp }}
@@ -54,7 +54,7 @@

-
+
-
+
@@ -23,7 +23,7 @@

{% for task in queue.pending_tasks|sort(attribute='last_update', reverse=True) %} - {{ task.uid }} + {{ task.uid }} 
{{ task.last_update|render_timestamp }}
@@ -46,7 +46,7 @@

-
+
diff --git a/karton/dashboard/templates/queue_layout.html b/karton/dashboard/templates/queue_layout.html index 2b79759..e25d8eb 100644 --- a/karton/dashboard/templates/queue_layout.html +++ b/karton/dashboard/templates/queue_layout.html @@ -46,7 +46,7 @@

queue {{ name }}

no {% endif %}
-
Spawned tasks
+
Spawned tasks
{% set length = queue.pending_tasks | length %} {% if length == 0 %} @@ -57,7 +57,7 @@

queue {{ name }}

{{length}} {% endif %}
-
Crashed tasks
+
Crashed tasks
{% if queue.crashed_tasks | length > 0 %} {{queue.crashed_tasks | length}} diff --git a/karton/dashboard/templates/task.html b/karton/dashboard/templates/task.html index c65fef4..5a648f8 100644 --- a/karton/dashboard/templates/task.html +++ b/karton/dashboard/templates/task.html @@ -17,17 +17,17 @@

task {{ task.uid }}

{{task.parent_uid}}
Root UID
- + {{task.root_uid}}
Origin
- {{task.headers['origin']}} + {{task.headers['origin']}}
Receiver
- {{task.headers['receiver']}} + {{task.headers['receiver']}}
Xrefs
From 698d419af4dfa1f1d80d65fbe9ef93c072f88fd4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krzysztof=20Zaj=C4=85c?= Date: Fri, 12 Jan 2024 18:51:26 +0100 Subject: [PATCH 10/13] . --- karton/dashboard/app.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/karton/dashboard/app.py b/karton/dashboard/app.py index 6338d97..f76cbcc 100644 --- a/karton/dashboard/app.py +++ b/karton/dashboard/app.py @@ -197,7 +197,7 @@ def get_xrefs(root_uid) -> List[Tuple[str, str]]: def add_metrics(state: KartonState, metric: KartonMetrics, key: str) -> None: - metrics = {k: int(v) for k, v in state.backend.redis.hgetall(metric.value).items()} + metrics = {k: int(v) for k, v in state.backend.redis.hgetall(metric.value).items()} # type: ignore for name, value in metrics.items(): karton_metrics.labels(key, name).set(value) From 4ccfbf3d578cf558b28d1d486e43d38fcf4b2526 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krzysztof=20Zaj=C4=85c?= Date: Fri, 12 Jan 2024 18:53:12 +0100 Subject: [PATCH 11/13] . --- karton/dashboard/app.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/karton/dashboard/app.py b/karton/dashboard/app.py index f76cbcc..e1107d0 100644 --- a/karton/dashboard/app.py +++ b/karton/dashboard/app.py @@ -197,7 +197,10 @@ def get_xrefs(root_uid) -> List[Tuple[str, str]]: def add_metrics(state: KartonState, metric: KartonMetrics, key: str) -> None: - metrics = {k: int(v) for k, v in state.backend.redis.hgetall(metric.value).items()} # type: ignore + metrics = { + k: int(v) + for k, v in state.backend.redis.hgetall(metric.value).items() # type: ignore + } for name, value in metrics.items(): karton_metrics.labels(key, name).set(value) From ab360127a504772dc9ea013012264c0b28e56cf0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krzysztof=20Zaj=C4=85c?= Date: Fri, 12 Jan 2024 19:58:54 +0100 Subject: [PATCH 12/13] . --- karton/dashboard/static/graph/graph.js | 2 +- karton/dashboard/templates/graph.html | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/karton/dashboard/static/graph/graph.js b/karton/dashboard/static/graph/graph.js index 729e940..906ece5 100644 --- a/karton/dashboard/static/graph/graph.js +++ b/karton/dashboard/static/graph/graph.js @@ -26,7 +26,7 @@ window.onresize = function() { option = null; myChart.showLoading('default', loadingOpts); -$.get("/graph/generate", function(raw_graph) { +$.get(dom.getAttribute('data-generate-url'), function(raw_graph) { myChart.hideLoading(); myChart.resize(); diff --git a/karton/dashboard/templates/graph.html b/karton/dashboard/templates/graph.html index 834f521..8abfa6f 100644 --- a/karton/dashboard/templates/graph.html +++ b/karton/dashboard/templates/graph.html @@ -1,7 +1,7 @@ {% extends 'layout.html' %} {% block content %}
- + +
+
{% endblock %} From c213c37cb479670e9c130242a6a882a66307900b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Srokosz?= Date: Wed, 17 Jan 2024 19:13:44 +0100 Subject: [PATCH 13/13] Use fallback arg instead of if..else expression --- karton/dashboard/app.py | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/karton/dashboard/app.py b/karton/dashboard/app.py index e1107d0..23591c0 100644 --- a/karton/dashboard/app.py +++ b/karton/dashboard/app.py @@ -39,11 +39,7 @@ class KartonDashboard(KartonBase): karton = KartonDashboard() -base_path = ( - karton.config.get("dashboard", "base_path") - if karton.config.has_option("dashboard", "base_path") - else "" -) +base_path = karton.config.get("dashboard", "base_path", fallback="") app_path = Path(__file__).parent static_folder = app_path / "static"