-
Notifications
You must be signed in to change notification settings - Fork 5
/
app.py
412 lines (307 loc) · 12 KB
/
app.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
import json
import logging
import re
import textwrap
from collections import defaultdict
from datetime import datetime
from itertools import product
from operator import itemgetter
from pathlib import Path
from typing import Any, Dict, List, Optional, Tuple
import mistune # type: ignore
from flask import (
Blueprint,
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
from karton.core.task import Task, TaskPriority, TaskState
from prometheus_client import Gauge, generate_latest # type: ignore
from .__version__ import __version__
from .graph import KartonGraph
logging.basicConfig(level=logging.INFO)
class KartonDashboard(KartonBase):
identity = "karton.dashboard"
version = __version__
with_service_info = True
karton = KartonDashboard()
base_path = karton.config.get("dashboard", "base_path", fallback="")
app_path = Path(__file__).parent
static_folder = app_path / "static"
graph_folder = app_path / "graph"
app = Flask(__name__, static_folder=None)
blueprint = Blueprint(
"dashboard", __name__, template_folder=str(app_path / "templates")
)
markdown = mistune.create_markdown(
escape=True,
renderer="html",
plugins=["url", "strikethrough", "footnotes", "table"],
)
def cancel_tasks(tasks: List[Task]) -> None:
for task in tasks:
karton.backend.set_task_status(task=task, status=TaskState.FINISHED)
class TaskView:
"""
All problems in computer science can be solved by another
layer of indirection.
"""
def __init__(self, task: Task) -> None:
self._task = task
@property
def headers(self) -> Dict[str, Any]:
return self._task.headers
@property
def task_uid(self):
return self._task.task_uid
@property
def uid(self) -> str:
return self._task.uid
@property
def parent_uid(self) -> Optional[str]:
return self._task.parent_uid
@property
def root_uid(self) -> str:
return self._task.root_uid
@property
def priority(self) -> TaskPriority:
return self._task.priority
@property
def status(self) -> TaskState:
return self._task.status
@property
def last_update(self) -> datetime:
return datetime.fromtimestamp(self._task.last_update)
@property
def last_update_delta(self) -> str:
return pretty_delta(self.last_update)
def to_dict(self) -> Dict[str, Any]:
return self._task.to_dict()
def to_json(self, indent=None) -> str:
return self._task.serialize(indent=indent)
class QueueView:
def __init__(self, queue: KartonQueue) -> None:
self._queue = queue
def to_dict(self) -> Dict[str, Any]:
tasks = sorted(
self._queue.pending_tasks, key=lambda t: t.last_update, reverse=True
)
crashed = sorted(
self._queue.crashed_tasks, key=lambda t: t.last_update, reverse=True
)
return {
"identity": self._queue.bind.identity,
"filters": self._queue.bind.filters,
"description": self._queue.bind.info,
"persistent": self._queue.bind.persistent,
"version": self._queue.bind.version,
"replicas": self._queue.online_consumers_count,
"service_version": self._queue.bind.service_version,
"tasks": [task.uid for task in tasks],
"crashed": [task.uid for task in crashed],
}
class AnalysisView:
def __init__(self, analysis: KartonAnalysis) -> None:
self._analysis = analysis
def to_dict(self) -> Dict[str, Any]:
return {
"uid": self._analysis.root_uid,
"queues": {
queue_name: [TaskView(task).to_dict() for task in queue.pending_tasks]
for queue_name, queue in self._analysis.pending_queues.items()
},
}
def pretty_delta(dt: datetime) -> str:
diff = datetime.now() - dt
seconds_diff = int(diff.total_seconds())
if seconds_diff < 180:
return f"{seconds_diff} seconds ago"
minutes_diff = seconds_diff // 60
if minutes_diff < 180:
return f"{minutes_diff} minutes ago"
hours_diff = minutes_diff // 60
return f"{hours_diff} hours ago"
@app.template_filter("render_description")
def render_description(description) -> Optional[str]:
if not description:
return None
return markdown(textwrap.dedent(description))
@app.template_filter("render_timestamp")
def render_timestamp(timestamp) -> str:
return datetime.fromtimestamp(timestamp).strftime("%Y-%m-%d %H:%M:%S")
def get_xrefs(root_uid) -> List[Tuple[str, str]]:
if not karton.config.has_option("dashboard", "xrefs"):
return []
xrefs = json.loads(karton.config.get("dashboard", "xrefs"))
return sorted(
(
(label, url_template.format(root_uid=root_uid))
for label, url_template in xrefs.items()
),
key=itemgetter(0),
)
karton_logs = Gauge("karton_logs", "Pending logs")
karton_tasks = Gauge("karton_tasks", "Pending tasks", ("name", "priority", "status"))
karton_replicas = Gauge("karton_replicas", "Replicas", ("name", "version"))
karton_metrics = Gauge("karton_metrics", "Metrics", ("metric", "name"))
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
}
for name, value in metrics.items():
karton_metrics.labels(key, name).set(value)
@blueprint.route("/varz", methods=["GET"])
def varz():
"""Update and get prometheus metrics"""
state = KartonState(karton.backend)
# Clear the metrics completely to account for disappearing queues
karton_tasks.clear()
karton_replicas.clear()
for queue in state.queues.values():
safe_name = re.sub("[^a-z0-9]", "_", queue.bind.identity.lower())
task_infos = defaultdict(int)
for task in queue.tasks:
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):
karton_tasks.labels(safe_name, priority.value, status.value).set(0)
for (name, priority, status), count in task_infos.items():
karton_tasks.labels(name, priority.value, status.value).set(count)
replicas = len(state.replicas[queue.bind.identity])
karton_replicas.labels(safe_name, queue.bind.version).set(replicas)
add_metrics(state, KartonMetrics.TASK_ASSIGNED, "assigned")
add_metrics(state, KartonMetrics.TASK_CONSUMED, "consumed")
add_metrics(state, KartonMetrics.TASK_CRASHED, "crashed")
add_metrics(state, KartonMetrics.TASK_GARBAGE_COLLECTED, "garbage-collected")
add_metrics(state, KartonMetrics.TASK_PRODUCED, "produced")
return generate_latest()
@blueprint.route("/static/<path:path>", methods=["GET"])
def static(path: str):
return send_from_directory(static_folder, path)
@blueprint.route("/", methods=["GET"])
def get_queues():
state = KartonState(karton.backend)
return render_template("index.html", queues=state.queues)
@blueprint.route("/services", methods=["GET"])
def get_services():
aggregated_services = defaultdict(list)
online_services = karton.backend.get_online_services()
for service in online_services:
aggregated_services[service].append(service)
return render_template("services.html", services=aggregated_services)
@blueprint.route("/api/queues", methods=["GET"])
def get_queues_api():
state = KartonState(karton.backend)
return jsonify(
{
identity: QueueView(queue).to_dict()
for identity, queue in state.queues.items()
}
)
@blueprint.route("/<queue_name>/restart_crashed", methods=["POST"])
def restart_crashed_queue_tasks(queue_name):
state = KartonState(karton.backend)
queue = state.queues.get(queue_name)
if not queue:
return jsonify({"error": "Queue doesn't exist"}), 404
for task in queue.crashed_tasks:
karton.backend.restart_task(task)
return redirect(request.referrer)
@blueprint.route("/<queue_name>/cancel_crashed", methods=["POST"])
def cancel_crashed_queue_tasks(queue_name):
state = KartonState(karton.backend)
queue = state.queues.get(queue_name)
if not queue:
return jsonify({"error": "Queue doesn't exist"}), 404
cancel_tasks(queue.crashed_tasks)
return redirect(request.referrer)
@blueprint.route("/<queue_name>/cancel_pending", methods=["POST"])
def cancel_pending_queue_tasks(queue_name):
state = KartonState(karton.backend)
queue = state.queues.get(queue_name)
if not queue:
return jsonify({"error": "Queue doesn't exist"}), 404
cancel_tasks(queue.pending_tasks)
return redirect(request.referrer)
@blueprint.route("/restart_task/<task_id>/restart", methods=["POST"])
def restart_task(task_id):
task = karton.backend.get_task(task_id)
if not task:
return jsonify({"error": "Task doesn't exist"}), 404
karton.backend.restart_task(task)
return redirect(request.referrer)
@blueprint.route("/cancel_task/<task_id>/cancel", methods=["POST"])
def cancel_task(task_id):
task = karton.backend.get_task(task_id)
if not task:
return jsonify({"error": "Task doesn't exist"}), 404
cancel_tasks([task])
return redirect(request.referrer)
@blueprint.route("/queue/<queue_name>", methods=["GET"])
def get_queue(queue_name):
state = KartonState(karton.backend)
queue = state.queues.get(queue_name)
if not queue:
return jsonify({"error": "Queue doesn't exist"}), 404
return render_template("queue.html", name=queue_name, queue=queue)
@blueprint.route("/queue/<queue_name>/crashed", methods=["GET"])
def get_crashed_queue(queue_name):
state = KartonState(karton.backend)
queue = state.queues.get(queue_name)
if not queue:
return jsonify({"error": "Queue doesn't exist"}), 404
return render_template("crashed.html", name=queue_name, queue=queue)
@blueprint.route("/api/queue/<queue_name>", methods=["GET"])
def get_queue_api(queue_name):
state = KartonState(karton.backend)
queue = state.queues.get(queue_name)
if not queue:
return jsonify({"error": "Queue doesn't exist"}), 404
return jsonify(QueueView(queue).to_dict())
@blueprint.route("/task/<task_id>", methods=["GET"])
def get_task(task_id):
task = karton.backend.get_task(task_id)
if not task:
return jsonify({"error": "Task doesn't exist"}), 404
return render_template(
"task.html", task=TaskView(task), xrefs=get_xrefs(task.root_uid)
)
@blueprint.route("/api/task/<task_id>", methods=["GET"])
def get_task_api(task_id):
task = karton.backend.get_task(task_id)
if not task:
return jsonify({"error": "Task doesn't exist"}), 404
return jsonify(TaskView(task).to_dict())
@blueprint.route("/analysis/<root_id>", methods=["GET"])
def get_analysis(root_id):
state = KartonState(karton.backend)
analysis = state.get_analysis(root_id)
if not analysis.tasks:
return jsonify({"error": "Analysis doesn't exist"}), 404
return render_template(
"analysis.html", analysis=analysis, xrefs=get_xrefs(analysis.root_uid)
)
@blueprint.route("/api/analysis/<root_id>", methods=["GET"])
def get_analysis_api(root_id):
state = KartonState(karton.backend)
analysis = state.get_analysis(root_id)
if not analysis.tasks:
return jsonify({"error": "Analysis doesn't exist"}), 404
return jsonify(AnalysisView(analysis).to_dict())
@blueprint.route("/graph", methods=["GET"])
def get_graph():
return render_template("graph.html")
@blueprint.route("/graph/generate", methods=["GET"])
def generate_graph():
state = KartonState(karton.backend)
graph = KartonGraph(state)
raw_graph = graph.generate_graph()
return raw_graph
app.register_blueprint(blueprint, url_prefix=base_path)