如何在Apache Airflow中为DAG标签设置描述？

目前Airflow原生并没有直接支持为标签附加描述的功能，但可以通过以下几种变通方式实现需求，让用户既能用标签搜索，又能查看标签的说明：

1. 利用Airflow变量存储标签描述，在DAG文档中引用 #

你可以在Airflow UI的「Variables」模块中，为每个标签创建对应的键值对（键为标签名，值为描述文本），然后在DAG的doc_md字段中引用这些变量，用户查看DAG详情时就能看到标签说明。

示例代码：

from airflow import DAG
from airflow.models import Variable
from datetime import datetime

# 提前在Variables中创建：键=etl_pipeline，值=负责每日业务数据的抽取、转换与加载，覆盖核心业务表的同步
dag = DAG(
    dag_id="daily_core_etl",
    tags=["etl_pipeline", "core_business"],
    schedule_interval="@daily",
    start_date=datetime(2024, 1, 1),
    doc_md=f"""
    ### DAG标签说明
    - etl_pipeline: {Variable.get("etl_pipeline", default_var="暂无描述")}
    - core_business: {Variable.get("core_business", default_var="暂无描述")}
    """
)

2. 在DAG的params字段中嵌入标签描述 #

如果不想依赖全局变量，可以直接把标签描述存在DAG的params字典里，用户在DAG详情页的「Params」标签下就能看到对应的说明。

示例代码：

from airflow import DAG
from datetime import datetime

dag = DAG(
    dag_id="user_behavior_analysis",
    tags=["user_analytics", "real_time"],
    schedule_interval="@hourly",
    start_date=datetime(2024, 1, 1),
    params={
        "tag_descriptions": {
            "user_analytics": "处理用户行为日志，生成活跃用户、访问路径等分析指标",
            "real_time": "近1小时内的实时数据处理任务，延迟不超过5分钟"
        }
    }
)

3. 开发自定义Airflow插件，统一展示标签描述 #

如果团队有大量标签需要管理，适合开发一个自定义插件，在Airflow UI中新增一个页面，专门展示所有标签及其描述。用户搜索标签后，可以直接跳转到该页面查看说明。

简化版插件示例：

from airflow.plugins_manager import AirflowPlugin
from flask import Blueprint
from flask_appbuilder import BaseView as AppBuilderBaseView
from airflow.models import Variable

class TagDescriptionView(AppBuilderBaseView):
    route_base = "/tag-descriptions"
    
    def list(self):
        # 从Variables中批量获取所有标签描述
        tag_keys = [key for key in Variable.get_all() if key.startswith("tag_")]
        tag_descriptions = {key.replace("tag_", ""): Variable.get(key) for key in tag_keys}
        return self.render_template("tag_descriptions.html", tags=tag_descriptions)

# 创建蓝图和视图
tag_bp = Blueprint("tag_bp", __name__, template_folder="templates")
v_appbuilder_view = TagDescriptionView()
v_appbuilder_package = {
    "name": "标签说明",
    "category": "工具",
    "view": v_appbuilder_view
}

class TagDescriptionPlugin(AirflowPlugin):
    name = "tag_description_plugin"
    flask_blueprints = [tag_bp]
    appbuilder_views = [v_appbuilder_package]

同时需要在插件目录下创建templates/tag_descriptions.html模板，用来渲染标签列表和描述。

内容的提问来源于stack exchange，提问作者Cherry