一、为什么做错误码

二、错误码是什么

三、错误码应用价值

• 强大的基建能力支撑，接入和管理成本降低80%
• 线上巡检：业务异常闭环巡检
• 监控警报：无缝对接监控警报
• 客诉分类：简单准确

3.1 故障定位快  客户不焦虑  大家不抓瞎

• 线上问题时效增强
• 缩短问题链路
• 自助解决能力提升

• 节约线上问题类的人力资源成本投入

• 提升线上问题收集分类和问题分析，提高定位问题效率
• 减少人力成本
• 故障监控和错误码大盘，提前感知业务错误率

3.2 接入简单 基建完善 管理方便

• 强大的基建能力支撑，接入和管理成本降低80%
  
  

四、如何设计和实现

4.1 系统架构和流程

整体系统结构主要由错误码统一协议规范、基建配置、错误码管理中心、前后端业务、以及错误码工具包和前端解析插件组成，如下图所示。

• 新申请的服务，先从服务资源管理中心申请服务资源，生成服务标识；
• 对于服务资源管理中心的已有服务，在前置工作中，已生成服务标识；

• 已存在的服务：错误码管理中心一次性推送所有云设计服务的错误码唯一标识到分布式配置 
• 新创建的服务：创建服务时，错误码管理中心获取该服务的错误码唯一标识，自动推动到分布式配置中心，并将这唯一标识记录到该服务的对应的分布式配置页面中。

4.2 协议规范

后端采用中心化配置管理数据库中的服务树来对后端服务做区分，统一格式如下表所示：

以工具下某服务为例，根据配置管理数据库中的服务树上的标签和数据域，可如下表示：

{    "c":"0"，        //状态码，成功为0，错误的情况下返回上述统一格式的错误码    "m":"错误消息", //错误提示信息，"c":"0"则无    "d":"结果"      //具体的返回结果数据}

4.3 管理中心

4.4 基建支持和高效接入

4.4.1 监控警报

• 数据查询：即时查询监控项 
• 统计和分析：监控看板管理中心看板设置
• 错误码数量占比：按错误码分类占比
• 错误码区间次数: 以5min时间粒度统计区间新增错误码数量
• 个性化报警：支持特定错误码，过滤某些错误码的警报设置
• 错误码监控大盘

1. 在分布式调用链追踪框架进行埋点，使得调用链中拥有错误码code，标识字段已完成；
2. 错误码中间件工具包统一打印错误日志，用于监控警报和统计，例如：ANALYZE {"_uniqueId":"00000112-5629-462c-465d-d1fbb1890001","code":"0000 0001","message":"方案错误","behaviorDescription":"ecodeException"}
3. 统一配置错误码报警，无需业务方关心

监控大盘：

4.4.2 错误码工具包和前端解析插件

• 结构的封装和解析
• 错误码字段配置
• 错误码字段获取
• 监控拓展和支持

• 存在加密和不加密两种接口
• 已加密接口，存在多种加密方式

• 返回错误码时，中间件增加header，如x-code: 0000 0001
• 前端根据header来判断哪些是错误码返回，将数据解析后返回给业务前端，进行业务逻辑处理

4.4 效能提升

4.4.1 提高客诉分析人效

1. 用户遇到线上问题；
2. 提交错误码进行快速定位和尝试解决问题；
3. 若未解决，客服提交错误码的精准分类和工单；
4. 根据错误码信息提交问题，技术侧进行快速处理；

4.4.2 线上巡检

• 选择服务标签

• 巡检的错误码：如0001，0002（可多次批量加入）

• 自行配置通知方式提醒

• 巡检频率：当前默认为警报次数

• 在研发系统平台自动创建缺陷和改进

• 测试效能平台通知

• 支持通过WebHook自行配置通知的方式，如企业微信机器人等

五、规划和展望

    1. 3D云设计工具的前端性能自动化及核心问题分析解决

    2. 多语言检测工具实践 

    3. 网页巡检工具实践

公众号：酷家乐技术质量    知乎：酷家乐技术质量        

TesterHome：kujiale-qa (酷家乐质量效能)