python - Flower 中的高级任务格式化(Celery 监控)

Question

我使用 Flower 来监控我的 Celery 任务。

我正在尝试更改任务的显示方式(在任务 选项卡下)以使列表看起来更“有条理”。例如显示<list (6 items)>而不是 [1, 2, 3, ... .

不幸的是，overriding the format_task method有局限性:

• task.args和 task.kwargs是字符串表示，通常被截断，而不是列表/字典
• 除了 task.name 之外的每个字段都转义了 HTML
• 如果函数没有返回值，则在显示任务时会抛出 AJAX 错误

获取原文args和 kwargs对象返回我正在使用 eval(task.args)这样我以后就可以遍历他们的项目了。评估随机字符串对我来说看起来有点不安全，你能推荐比这样做更好的方法吗？

Answer 1

我在 format_task 中找到了获取任务参数的解决方案作为对象(列表/字典等)而不是截断的字符串表示形式。

argsrepr和 kwargsrepr apply_async() 的参数方法允许为任务的参数指定自定义表示。

我创建了一个自定义的 Task 类，覆盖了 delay像这样的方法:

import json
from celery import Task

class FlowerTask(Task):
    def delay(self, *args, **kwargs):
        argsrepr, kwargsrepr = [], {}

        for arg in args:
            if isinstance(arg, bytes):
                argsrepr.append("<binary content>")
            elif isinstance(arg, list):
                argsrepr.append("<list ({} items)>".format(len(arg)))
            elif isinstance(arg, dict):
                argsrepr.append("<dict ({} keys)>".format(len(arg)))
            else:
                # Format your args the way you prefer
            
        for key, value in kwargs.items():
            # Format your kwargs the same way as above
            # if ... :
            # kwargsrepr.append(...)
        
        # Create the task
        new_task = super().s(*args, **kwargs)

        # Use our representations as JSON
        return new_task.apply_async(
            argsrepr=json.dumps(argsrepr),
            kwargsrepr=json.dumps(kwargsrepr)
        )

然后我使用这个类作为我使用 base 的任务的基础参数:

@shared_task(base=FlowerTask)
def test_task(*args, **kwargs):
    return "OK !"

这样，任务的参数表示将存储为 JSON，之后可以将其加载到 Flower 的 format_task() 中。并将它们用作对象而不是字符串:

def format_task(task):
    argsrepr = json.loads(task.args)
    kwargsrepr = json.loads(task.kwargs)

    if not argsrepr:
        task.args = "( )"
    else:
        task.args = ', '.join(argsrepr)

    if not kwargsrepr:
        task.kwargs = "( )"
    else:
        task.kwargs = ', '.join(f'{key} = {value}' for key, value in kwargsrepr.items())
    # [...]

这样，参数显示如下:

Args: <list (3 items)>, <binary content>

Kwargs: callback = <function>, items = <dict (5 items)>