目录文档-技术白皮书05-EFT.WP.Core.Errors v1.0

附录A 错误码注册表模式


I. 目的与范围


II. 命名与编码规范

  1. 代码结构:code = "E.<DOMAIN>.<GROUP>.<KEY>[.NNN]"
    • <DOMAIN>:顶级域(如 METROLOGY、MEASUREMENT、NUMERICS、DATA_QUALITY、MODEL、PIPELINE、CALIBRATION、REFCOND、REPORT、IO、SECURITY)。
    • <GROUP>:二级分组(如 UNIT、TRACE、INTEGRATION、OUTLIER、FIT、TIME、LINEAR 等)。
    • <KEY>:具体故障键(全大写下划线,语义稳定)。
    • 可选序号 .NNN:同键下的细分情景(从 001 起)。
  2. 正则约束:^E\.[A-Z][A-Z0-9_]*\.[A-Z][A-Z0-9_]*\.[A-Z][A-Z0-9_]*(\.[0-9]{3})?$。
  3. 全局唯一:code 在全库唯一;同一 code 的 version 单调递增。
  4. 语义稳定:message 模板可演进但不得改变根因/域/严重性语义。

III. 字段字典与必填项

  1. 必填字段
    • code:str(全局唯一,见命名规范)
    • name:str(人类可读短标题,英文)
    • severity:str ∈ {INFO, WARN, ERROR, FATAL}
    • domain:str(与 <DOMAIN> 一致)
    • message:str(占位模板,变量形如 {{var}})
    • remediation:str(首选动作,如 retry(policy={{pid}})、fallback(model={{mid}})、graceful_degradation(mode={{m}})、recalibrate(proc={{rid}}))
  2. 推荐字段
    • see:list[str](跨卷引用,形如 I50-4、I40-9、S88-1)
    • tags:list[str](关键词,如 ["T_arr","gamma(ell)","n_eff","c_ref"])
    • cause:str(直接原因)
    • effect:str(用户影响,含 SLI/SLO 触点)
    • detection:str(检测准则,如 |z| > 3.5、chi2/dof > t0)
    • context_schema:list[str](最小上下文键名,见下节)
    • metrics:list[str](记录的量化指标,如 ["chi2","r_bar_max","latency_ms","pass_rate"])
    • policy_hint:str(策略提示,如 prefer_robust_loss=Huber)
  3. 生命周期字段
    • version:str(语义化版本,如 1.0.0)
    • status:str ∈ {DRAFT, ACTIVE, DEPRECATED, RETIRED}
    • created_at:str、updated_at:str(ISO8601)
    • deprecates:list[str]、replaces:list[str](兼容关系)

IV. 上下文最小键(追溯与再现)


V. 严重性与推荐动作映射


VI. 规范化与校验规则


VII. 参考 JSON-Schema(概要)

  1. type: object
  2. required: [ "code","name","severity","domain","message","remediation" ]
  3. properties:
    • code: string, pattern ^E\.[A-Z][A-Z0-9_]*\.[A-Z][A-Z0-9_]*\.[A-Z][A-Z0-9_]*(\.[0-9]{3})?$
    • severity: string, enum [ "INFO","WARN","ERROR","FATAL" ]
    • domain: string
    • name: string
    • message: string
    • remediation: string
    • see: array(string)
    • tags: array(string)
    • cause: string
    • effect: string
    • detection: string
    • context_schema: array(string)
    • metrics: array(string)
    • policy_hint: string
    • version: string
    • status: string, enum [ "DRAFT","ACTIVE","DEPRECATED","RETIRED" ]
    • created_at: string (date-time)
    • updated_at: string (date-time)
    • deprecates: array(string)
    • replaces: array(string)

VIII. 与实现绑定(I50- 对应)*


IX. 示例条目(跨域最小集)


X. 维护与治理流程

  1. 版本与状态
    • 新增以 DRAFT 进入,完成联调与回归后切换 ACTIVE。
    • 若存在覆盖条目,以 DEPRECATED 指向新 code;冻结旧条目,仅允许加强 remediation 与 see。
    • 迁移完成后标记为 RETIRED,保留只读以保证历史报告可解析。
  2. 变更准入
    • 任何 severity 变化需通过跨卷评审,并更新 set_error_policy。
    • 涉及 message 模板变量新增,必须同步扩展 context_schema 并更新生成端。
    • 回归保障:以 compare_reports(a,b, metrics=["mean","U","pass_rate"]) 验证影响不超基线阈值。

XI. 快速校验清单(注册前自检)


XII. 与计量卷的关键锚点对齐


XIII. 输出物与落地

  1. 输出物
    • 标准模式文件(建议导出为 yaml 与 json 双格式),可由 export_units("yaml")、export_refcond("yaml") 的同一流水线发布。
    • 示例库(≥ 20 条建议在实现阶段扩充),与 set_error_policy 的默认策略包一同交付。
  2. 落地步骤
    • 以本模式批量注册核心条目(优先 METROLOGY、MEASUREMENT、NUMERICS、DATA_QUALITY)。
    • 在集成环境启用 normalize_error,统一日志与报告侧格式。
    • 将错误码与 SLI/SLO 门控联动,触发 retry/fallback/graceful_degradation 的自动化策略链。

版权与许可(CC BY 4.0)

版权声明:除另有说明外,《能量丝理论》(含文本、图表、插图、符号与公式)的著作权由作者(“屠广林”先生)享有。
许可方式:本作品采用 Creative Commons 署名 4.0 国际许可协议(CC BY 4.0)进行许可;在注明作者与来源的前提下,允许为商业或非商业目的进行复制、转载、节选、改编与再分发。
署名格式(建议):作者:“屠广林”;作品:《能量丝理论》;来源:energyfilament.org;许可证:CC BY 4.0。

首次发布: 2025-11-11|当前版本:v5.1
协议链接:https://creativecommons.org/licenses/by/4.0/