错误码介绍
|
收藏
1. 错误码概述
神策错误码(ErrorCode)是一种特别设计的错误标识系统,旨在清晰地传达程序执行过程中遇到的各种错误或异常情况。我们的初衷是通过这种系统化的方式,为用户和开发者提供更直观、友好的错误信息展示,从而简化问题的排查和解决过程。
神策错误码的设计考虑了以下两大类错误情况:
- 预期内错误:这些错误是在系统设计阶段就考虑到可能会发生的,比如用户缺乏特定权限(例如“没有XXX的权限”)、用户账号不存在等。这类错误码帮助用户快速理解问题所在,并引导其采取相应的解决措施。
- 意外错误:包括系统内部的缺陷、数据不准确、网络连接问题等不可预见的错误。这类错误码的存在确保了即使在面对意外情况时,用户也能获得清晰的错误提示,减少困惑和不便。
通过神策错误码,我们希望简化用户和开发人员面对问题时的处理流程。规范化的错误信息不仅帮助用户了解当前发生了什么,更为开发团队提供了快速定位和解决问题的线索,从而提升整体的产品应用体验。
神策错误码的引入,也体现了我们在产品设计时对细节的关注和问题边界的全面考量。它不只是错误处理的一环,更是提升产品质量和用户体验的重要保障。
2. 错误码展示信息介绍
神策错误码(ErrorCode) 是由一组结构化语义的字符串组成(如:SA-D-1-1),用于唯一标识特定类型的错误。它通常与错误信息一起出现,以提供更详细的错误描述信息。
在神策系统中,错误码会有两种展示形态:
缩略展示:这是错误码出现时的默认展示形态,为用户提供了一个快速识别问题的视觉提示。
详情展示:用户可以通过展开错误码来访问更详尽的错误描述。这种形态为用户提供了深入分析问题所需的额外信息。
2.1. 缩略展示
错误码弹出后默认缩略展示,以下为图中示例的详细介绍:
- COMMON-R-116-2:错误码编号,用于唯一标识特定类型的错误
- 页面展现异常:错误简要说明(错误概述)
- 下载错误文件:下载该错误的相关信息,可将其发送给神策值班同学以便针对此问题进行排查
- 展开详情:点击会进入详情展示状态,用户可查看该错误的详细信息
2.2. 详情展示
点击 “展开详情” 后,将会展示该错误的相关详细信息,主要包括了:
1. 错误详情:
- 错误码:错误编号,用于唯一标识特定类型的错误
- 错误概述:系统运行时的报出的详细错误信息
- 系统相应:出错后,系统后续执行的动作
2.可能的致错原因:
- 致错原因:可能造成此错误产生的原因
- 操作建议:需要恢复系统时,神策建议进行的操作
3.环境信息:
一般为错误产生的文件、报错堆栈、错误模块的版本信息等,用户无需关注此部分
3. 常见报错问题及处理方式
错误码可针对性的划分为 “具体异常型” 和 “通用类型”:
- 具体异常型 - 针对的某一种特定错误的描述,通常会提供详细的致错原因以及操作建议
- 通用类型 - 针对某一类型的问题,通常存在多种可能性,用户可以根据致错原因以及操作建议尝试恢复系统,无法恢复请咨询神策客服
3.1. 具体异常类型错误码
以下是一个常见的具体异常类型错误码的示例:
3.1.1. 出现错误时,用户应当优先查看错误详情,点击 “展开详情” 按钮
3.1.2. 根据展开后提示的致错原因和操作建议,了解错误原因以及应该如何恢复系统
本次报错是因为 URL 中包含了不合法的参数,这是引起本次报错的直接原因。产生的间接原因可能有:
- 链接过长,在聊天记录中没有完整的复制链接导致解析失败,可尝试复制完整的链接重新进入系统即可
- 链接中包含了不合法的参数,可以检查后重新输入
3.2. 常见通用类型错误码
3.2.1. 兜底通用错误码-可以尝试自行解决
以下是一些用户可以根据致错原因和操作建议自行解决的错误码:
错误码 | 错误原因 | 解决方案 |
---|---|---|
COMMON-D-116-3 | 资源加载异常 | 该错误可能跟资源失效或网络出错有关,此类问题可以尝试刷新页面以及检查网络连通性、检查防火墙限制,无法恢复请联系技术排查 |
COMMON-D-116-4 | 网络请求失败 | 该错误可能与用户网络有关,建议刷新页面重试或检查网络连通性、检查防火墙限制,无法恢复请联系技术排查 |
COMMON-D-116-10 | HTTP 请求头超过限制 | 该错误可能由于浏览器在当前域名下的 Cookie 过多,导致请求头超过限制,可以尝试清空缓存后重试 |
3.2.2. 兜底通用错误码-需要神策排查
以下是一些未知详情的错误码,用户遇见时请联系神策客服
错误码 | 错误原因 | 解决方案 |
---|---|---|
COMMON-R-116-1 | 页面发生异常 | 兜底错误警告,遇到该错误码请联系神策技术排查 |
COMMON-R-116-2 | 页面展现异常 | 兜底错误警告,遇到该错误码请联系神策技术排查 |
COMMON-D-116-5 | 服务无响应 | 该错误与神策服务相关,遇到该错误码请联系神策技术排查 |
COMMON-D-116-6 | 服务未找到 | 该错误与神策服务相关,遇到该错误码请联系神策技术排查 |
COMMON-D-116-7 | 请求错误 | 该错误与神策服务相关,遇到该错误码请联系神策技术排查 |
COMMON-D-116-8 | 服务发生异常 | 该错误与神策服务相关,遇到该错误码请联系神策技术排查 |
3.3. 利用诊断工具记录复现路径
一般来说出现神策错误码时可以通过下载文件,然后把下载文件提供给神策客服同学进行后续排查;但是如果该错误与一些特定操作路径有关,可以使用诊断工具来记录整个出现问题的操作步骤来辅助排查。
3.3.1. 点击右上角客户姓名,在展开的下拉菜单中选择“诊断工具” → “开启前端诊断”
3.3.2. 页面中间会出现诊断工具浮层,最多可记录 5 分钟
3.3.3. 完成整个错误的复现操作后,点击 “完成并下载诊断文件”,将下载下来的文件发送给神策客户即可
注:本文档内容为神策产品使用和技术细节说明文档,不包含适销类条款;具体企业采购产品和技术服务内容,以商业采购合同为准。