插件错误码规范

总体要求

  • 插件开发者需对导致插件执行失败的各种场景进行细分,使用错误码(errorCode)进行标识,并在插件日志、使用指引中给出详细的描述和解决方法,方便用户快速定位和解决问题

  • 插件开发者需对导致插件执行失败的错误进行归类,指定错误类型 errorType,用于度量统计

错误类型和错误码规范

1 插件错误类型(errorType)

通过插件结果中的 errorType 字段上报:

注:插件SDK只提供1-3的传值枚举,插件结果内未指定或指定1-3以外的值,则错误类型取值为3(插件执行错误)

2 插件错误码(errorCode)

通过插件结果中的 errorCode 字段上报:

注:插件错误码有助于开发者定义完整的、成体系的错误信息,方便问题定位和报表生成

最后更新于