与错误处理

本指南解释了如何处理错误的插件和为常见场景提供了建议。

提供可用的默认值

允许用户在小步骤学习你的插件。提供一个有用的默认配置,以便:

• 用户可以马上开始。
• 你可以避免不必要的错误消息。

例如,通过选择预期类型的第一个字段,面板可以显示没有任何用户的可视化配置。如果一个用户显式地选择一个字段,然后使用。否则,默认为第一个字段的类型字符串:

const numberField = frame.fields.find((字段)= >选项。numberFieldName吗?field.name = = =选项。numberFieldName:字段。= = = FieldType类型。数);

显示错误消息

向用户显示一条错误消息,扔一个错误您想要显示的消息:

把新的错误(“出错”);

Grafana显示错误信息,在面板的左上角。

我们建议您避免过于技术性错误消息显示给用户。如果你想让技术用户报告错误,考虑登录到控制台。

尝试{failingFunction ();}捕捉(err) {console.error(错);把新的错误(“事情错了”);}

注意:Grafana在UI中显示异常消息写,所以使用语法正确的句子。有关更多信息,请参考文档风格指南。

常见的错误场景

这里有一些情况的例子,你可能想向用户显示一条错误。

无效的查询响应

用户完全自由时为面板创建数据源的查询。如果你的面板插件需要查询响应特定的格式,然后使用面板画布来指导用户。

如果(! numberField){抛出新的错误(查询结果失踪是一个数字字段);}如果(框架。长度= = = 0){抛出新的错误(查询返回一个空的结果);}