fix(sqlserver): slave重建单据增加告警屏蔽逻辑 #16278

yksitu · iSecloud · commit 42279fe56256 · 2026-02-11T16:42:01.000+08:00
diff --git a/dbm-ui/backend/db_monitor/constants.py b/dbm-ui/backend/db_monitor/constants.py
@@ -614,3 +614,9 @@ class TimeUnit:
     MINUTE = SECOND * 60
     HOUR = MINUTE * 60
     DAY = HOUR * 24
+
+
+# 告警屏蔽类型
+class MonitorShieldType(StrStructuredEnum):
+    DIMENSION = EnumField("dimension", _("基于维度屏蔽"))
+    STRATEGY = EnumField("strategy", _("基于策略屏蔽"))
diff --git a/dbm-ui/backend/flow/engine/bamboo/scene/sqlserver/sqlserver_slave_rebuild.py b/dbm-ui/backend/flow/engine/bamboo/scene/sqlserver/sqlserver_slave_rebuild.py
@@ -19,6 +19,8 @@
 from backend.db_meta.enums import ClusterEntryType, ClusterType, InstanceRole
 from backend.db_meta.models import Cluster, StorageInstance
 from backend.db_meta.models.storage_set_dtl import SqlserverClusterSyncMode
+from backend.db_monitor.constants import MonitorShieldType
+from backend.db_monitor.models import MonitorPolicy
 from backend.flow.consts import SqlserverCleanMode, SqlserverLoginExecMode, SqlserverSyncMode, SqlserverSyncModeMaps
 from backend.flow.engine.bamboo.scene.common.builder import Builder, Conditions, SubBuilder
 from backend.flow.engine.bamboo.scene.common.get_file_list import GetFileList
@@ -32,7 +34,9 @@
     sync_dbs_for_cluster_sub_flow,
 )
 from backend.flow.engine.bamboo.scene.sqlserver.sqlserver_add_slave import SqlserverAddSlaveFlow
+from backend.flow.plugins.components.collections.common.add_alarm_shield import AddAlarmShieldComponent
 from backend.flow.plugins.components.collections.common.delete_cc_service_instance import DelCCServiceInstComponent
+from backend.flow.plugins.components.collections.common.disable_alarm_shield import DisableAlarmShieldComponent
 from backend.flow.plugins.components.collections.common.pause import PauseComponent
 from backend.flow.plugins.components.collections.mysql.dns_manage import MySQLDnsManageComponent
 from backend.flow.plugins.components.collections.sqlserver.check_slave_sync_status import CheckSlaveSyncStatusComponent
@@ -56,7 +60,6 @@
     DropRandomJobUserKwargs,
     ExecActuatorKwargs,
     ExecLoginKwargs,
-    SqlserverBackupIDContext,
     SqlserverRebuildSlaveContext,
 )
 from backend.flow.utils.sqlserver.sqlserver_act_payload import SqlserverActPayload
@@ -130,6 +133,28 @@ def slave_rebuild_in_local_flow(self):
                     ),
                 ),
             )
+            sub_pipeline.add_act(
+                act_name=_("屏蔽镜像缺失告警策略一天"),
+                act_component_code=AddAlarmShieldComponent.code,
+                kwargs=asdict(
+                    AddAlarmShieldComponent.kwargs(
+                        description=("执行集群原地重建单据，单据号:{}".format(self.data.get("uid"))),
+                        duration_seconds=86400,
+                        category=MonitorShieldType.STRATEGY,
+                        strategy_id=[
+                            i.monitor_policy_id
+                            for i in MonitorPolicy.objects.filter(
+                                name__in=[_("Sqlserver-数据库镜像缺失【mirroring】"), _("Sqlserver-数据库镜像缺失【Alwayson】")]
+                            )
+                        ],
+                        level=[1, 2, 3],
+                        dimensions=[
+                            {"name": "cluster_domain", "values": [cluster.immute_domain]},
+                        ],
+                    )
+                ),
+            )
+
             source_act = sub_pipeline.add_act(
                 act_name=_("检测带重建slave状态[{}]".format(rebuild_slave.ip_port)),
                 act_component_code=CheckSlaveSyncStatusComponent.code,
@@ -193,6 +218,10 @@ def slave_rebuild_in_local_flow(self):
                 conditions_param=SqlserverRebuildSlaveContext.conditions_var_name(),
             )
 
+            sub_pipeline.add_act(
+                act_name=_("15 分钟后解除旧实例告警屏蔽"), act_component_code=DisableAlarmShieldComponent.code, kwargs={}
+            )
+
             # 先做克隆周边配置
             sub_pipeline.add_sub_pipeline(
                 sub_flow=clone_configs_sub_flow(
@@ -406,6 +435,28 @@ def slave_rebuild_in_new_slave_flow(self):
                     - set(get_sync_filter_dbs(cluster.id))
                 )
                 if len(sync_dbs) > 0:
+                    cluster_sub_pipeline.add_act(
+                        act_name=_("屏蔽镜像缺失告警策略一天"),
+                        act_component_code=AddAlarmShieldComponent.code,
+                        kwargs=asdict(
+                            AddAlarmShieldComponent.kwargs(
+                                description=_("执行集群新机重建单据，单据号:{}".format(self.data.get("uid"))),
+                                duration_seconds=86400,
+                                category=MonitorShieldType.STRATEGY,
+                                strategy_id=[
+                                    i.monitor_policy_id
+                                    for i in MonitorPolicy.objects.filter(
+                                        name__in=[_("Sqlserver-数据库镜像缺失【mirroring】"), _("Sqlserver-数据库镜像缺失【Alwayson】")]
+                                    )
+                                ],
+                                level=[1, 2, 3],
+                                dimensions=[
+                                    {"name": "cluster_domain", "values": [cluster.immute_domain]},
+                                ],
+                            )
+                        ),
+                    )
+
                     cluster_sub_pipeline.add_sub_pipeline(
                         sub_flow=sync_dbs_for_cluster_sub_flow(
                             uid=self.data["uid"],
@@ -418,6 +469,10 @@ def slave_rebuild_in_new_slave_flow(self):
                         )
                     )
 
+                    cluster_sub_pipeline.add_act(
+                        act_name=_("15 分钟后解除旧实例告警屏蔽"), act_component_code=DisableAlarmShieldComponent.code, kwargs={}
+                    )
+
                 # 先做克隆周边配置
                 cluster_sub_pipeline.add_sub_pipeline(
                     sub_flow=clone_configs_sub_flow(
@@ -602,7 +657,7 @@ def slave_rebuild_in_new_slave_flow(self):
         # main_pipeline.run_pipeline(init_trans_data_class=SqlserverBackupIDContext())
         main_pipeline.run_pipeline_with_sidecar(
             check_ai_monitor_cluster_list=sum([info["cluster_ids"] for info in self.data["infos"]], []),
-            init_trans_data_class=SqlserverBackupIDContext(),
+            init_trans_data_class=SqlserverRebuildSlaveContext(),
         )
 
     @classmethod
diff --git a/dbm-ui/backend/flow/plugins/components/collections/common/add_alarm_shield.py b/dbm-ui/backend/flow/plugins/components/collections/common/add_alarm_shield.py
@@ -10,56 +10,145 @@
 """
 import datetime
 import json
+from dataclasses import dataclass, field
+from typing import List, Optional
 
 from pipeline.component_framework.component import Component
 
 from backend import env
 from backend.components.bkmonitorv3.client import BKMonitorV3Api
+from backend.db_monitor.constants import MonitorShieldType
+from backend.db_monitor.utils import format_shield_description
 from backend.flow.plugins.components.collections.common.base_service import BaseService
+from backend.flow.utils.base.validate_handler import ValidateHandler, validate_list, validate_string
 
 # logger = logging.getLogger("flow")
 
 
+@dataclass()
+class AddAlarmShieldKwargs(ValidateHandler):
+    """
+    定义添加告警屏蔽（AddAlarmShieldService）活动节点的私有变量结构体。
+
+    时间参数说明（二选一，均不传则抛出异常）:
+        - 方式一: 传入 duration_seconds，自动以当前时间为起点计算 begin_time / end_time
+        - 方式二: 显式传入 begin_time 和 end_time
+
+    屏蔽类型说明（category）:
+        - "dimension"（默认）: 基于维度屏蔽，仅根据 appid + 自定义维度条件进行屏蔽
+        - "strategy": 基于策略屏蔽，需额外指定 strategy_id 和 level
+
+    使用示例:
+        # 基于维度屏蔽
+        kwargs = AddAlarmShieldKwargs(
+            description="屏蔽1",
+            dimensions=[{"name": "instance_host", "values": ["xxx"]}],
+            duration_seconds=7200,
+        )
+
+        # 基于策略屏蔽
+        kwargs = AddAlarmShieldKwargs(
+            description="屏蔽2",
+            dimensions=[{"name": "instance", "values": ["xxx"]}],
+            duration_seconds=3600,
+            category="strategy",
+            strategy_id=12345,
+            level=[1, 2],
+        )
+    """
+
+    description: str = field(metadata={"validate": validate_string})
+    dimensions: List[dict] = field(default_factory=list, metadata={"validate": validate_list})
+    duration_seconds: Optional[int] = None
+    begin_time: Optional[str] = None
+    end_time: Optional[str] = None
+    category: str = "dimension"
+    strategy_id: Optional[List[int]] = None
+    level: Optional[List[int]] = None
+
+
 class AddAlarmShieldService(BaseService):
     """
-    输出上下文 alarm_shield_id : int
+    添加告警屏蔽服务节点。
+    在流程编排中作为一个原子节点，用于在执行数据库变更操作前对监控告警进行屏蔽，
+    避免变更过程中产生的预期告警干扰运维人员。
+
+    输出上下文:
+        alarm_shield_id (int): 蓝鲸监控返回的屏蔽规则 ID，后续可用于解除屏蔽（见 DisableAlarmShieldService）
+
+    屏蔽类型（category）:
+        - "dimension"（默认）: 基于维度屏蔽，仅根据 appid + 自定义维度条件进行屏蔽
+        - "strategy": 基于策略屏蔽，需额外指定 strategy_id（策略ID）和 level（告警等级）
+
+    kwargs 入参说明:
+        - duration_seconds (int, 可选): 屏蔽持续时间（秒），传入后自动计算 begin_time / end_time
+        - begin_time (str, 可选): 屏蔽开始时间，格式 "YYYY-MM-DD HH:MM:SS"
+        - end_time (str, 可选): 屏蔽结束时间，格式 "YYYY-MM-DD HH:MM:SS"
+        - description (str): 屏蔽描述信息
+        - category (str, 可选): 屏蔽类型，默认为 "dimension"
+        - dimensions (list[dict]): 屏蔽维度列表，每个元素包含 name 和 values
+        - strategy_id (int, 仅 category="strategy" 时必传): 策略 ID
+        - level (list, 仅 category="strategy" 时必传): 告警等级
+
+    注意: duration_seconds 与 (begin_time + end_time) 二选一，均不传则抛出异常。
     """
 
     def _execute(self, data, parent_data):
         kwargs = data.get_one_of_inputs("kwargs")
         trans_data = data.get_one_of_inputs("trans_data")
         global_data = data.get_one_of_inputs("global_data")
 
+        # ============ 第一步：确定屏蔽的起止时间 ============
+        # 优先使用 duration_seconds（持续时长），自动计算起止时间
         if "duration_seconds" in kwargs:
             begin_time = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
             end_time = (
                 datetime.datetime.now() + datetime.timedelta(seconds=int(kwargs["duration_seconds"]))
             ).strftime("%Y-%m-%d %H:%M:%S")
         else:
+            # 其次使用显式指定的 begin_time 和 end_time
             if "begin_time" in kwargs and "end_time" in kwargs:
                 begin_time = kwargs["begin_time"]
                 end_time = kwargs["end_time"]
             else:
+                # 两种方式都未提供，抛出异常
                 raise Exception("add alarm shield missing args")
 
         bk_biz_id = global_data["bk_biz_id"]
+        # 屏蔽类型，默认为基于维度屏蔽
+        category = kwargs.get("category", "dimension")
 
+        # ============ 第二步：构造蓝鲸监控屏蔽 API 的请求参数 ============
         shield_param = {
-            "category": "dimension",
+            "category": category,
             "begin_time": begin_time,
             "end_time": end_time,
+            # 注意：这里使用的是 DBA 平台的业务 ID（env.DBA_APP_BK_BIZ_ID），而非用户业务 ID
+            # 因为告警策略是在 DBA 平台业务下统一管理的
             "bk_biz_id": env.DBA_APP_BK_BIZ_ID,
+            # cycle_config.type=1 表示"一次性"屏蔽（不循环）
             "cycle_config": {"begin_time": "", "end_time": "", "day_list": [], "week_list": [], "type": 1},
+            # 屏蔽期间不发送通知
             "shield_notice": False,
             "notice_config": {},
             "description": kwargs["description"],
+            # 维度配置：默认以 appid（用户业务ID）作为基础维度条件
             "dimension_config": {
                 "dimension_conditions": [
                     {"condition": "and", "key": "appid", "method": "eq", "value": [f"{bk_biz_id}"], "name": "appid"},
                 ]
             },
         }
 
+        # ============ 第三步：根据屏蔽类型补充策略相关参数 ============
+        # 判断这次屏蔽操作基于什么类型操作
+        if category == MonitorShieldType.STRATEGY.value:
+            # 如果基于策略屏蔽，则需要传入策略id, 且必须传入屏蔽等级
+            shield_param["dimension_config"]["id"] = kwargs["strategy_id"]
+            shield_param["dimension_config"]["level"] = kwargs["level"]
+
+        # ============ 第四步：追加用户自定义的维度条件 ============
+        # dimensions 示例: [{"name": "instance", "values": ["127.0.0.1:3306"]}]
         dimensions = kwargs["dimensions"]
         for dim in dimensions:
             shield_param["dimension_config"]["dimension_conditions"].append(
@@ -72,25 +161,31 @@ def _execute(self, data, parent_data):
                 }
             )
 
+        # ============ 第五步：格式化描述信息并调用蓝鲸监控 API 创建屏蔽 ============
+        # 在描述前添加 [dbm:appid=xxx] 前缀，便于在监控平台中追踪和识别
         shield_param.update(
-            {"description": self.format_shield_description(bk_biz_id, description=shield_param["description"])}
+            {"description": format_shield_description(bk_biz_id, description=shield_param["description"])}
         )
         self.log_info("alarm shield param: {}".format(json.dumps(shield_param)))
+        # 调用蓝鲸监控 V3 API 创建告警屏蔽规则
         res = BKMonitorV3Api.add_shield(shield_param)
         self.log_info("alarm shield {} created".format(res))
+
+        # ============ 第六步：将屏蔽 ID 写入上下文，供下游节点使用 ============
+        # 典型用途：DisableAlarmShieldService 会读取此 ID 来解除屏蔽
         trans_data.alarm_shield_id = res["id"]
         data.outputs["trans_data"] = trans_data
         return True
 
-    @staticmethod
-    def format_shield_description(bk_biz_id, description=""):
-        prefix = f"[dbm:appid={bk_biz_id}]"
-        # 先删后补，避免出现多个前缀
-        description = description.replace(prefix, "").strip()
-        return f"{prefix}{description}"
-
 
 class AddAlarmShieldComponent(Component):
+    """
+    Pipeline 组件注册类。
+    将 AddAlarmShieldService 注册为流程引擎可调度的原子节点，
+    在流程编排 YAML/JSON 中通过 code="add_alarm_shield" 引用此组件。
+    """
+
     name = __name__
     code = "add_alarm_shield"
     bound_service = AddAlarmShieldService
+    kwargs = AddAlarmShieldKwargs
diff --git a/dbm-ui/backend/flow/plugins/components/collections/common/disable_alarm_shield.py b/dbm-ui/backend/flow/plugins/components/collections/common/disable_alarm_shield.py
@@ -15,6 +15,7 @@
 
 from backend import env
 from backend.components import BKMonitorV3Api
+from backend.db_monitor.constants import MonitorShieldType
 from backend.flow.plugins.components.collections.common.base_service import BaseService
 
 
@@ -36,6 +37,10 @@ def _execute(self, data, parent_data):
             "notice_config": detail["notice_config"],
             "id": shield_id,
         }
+        # 支持策略维度的调整
+        if detail["category"] == MonitorShieldType.STRATEGY.value:
+            edit_param["level"] = detail["dimension_config"]["level"]
+
         BKMonitorV3Api.edit_shield(edit_param)
 
         return True
diff --git a/dbm-ui/backend/flow/utils/sqlserver/sqlserver_act_dataclass.py b/dbm-ui/backend/flow/utils/sqlserver/sqlserver_act_dataclass.py
@@ -297,6 +297,7 @@ class SqlserverRebuildSlaveContext:
     clean_dbs: list = field(default_factory=list)
     full_backup_id: dict = field(default_factory=dict)
     log_backup_id: dict = field(default_factory=dict)
+    alarm_shield_id: int = None
 
     @staticmethod
     def sync_dbs_var_name() -> str:
