跳至主要内容

错误处理

本指南介绍如何在数据源插件中处理错误。

提供可用的默认值

允许用户逐步了解您的插件。提供有用的默认配置,以便

  • 用户可以立即开始使用。
  • 您可以避免不必要的错误消息。

例如,通过选择预期类型的第一个字段,面板可以在没有任何用户配置的情况下显示可视化效果。如果用户显式选择了一个字段,则使用该字段。否则,默认为类型为 string 的第一个字段

const numberField = frame.fields.find((field) =>
options.numberFieldName ? field.name === options.numberFieldName : field.type === FieldType.number
);

显示错误消息

要向用户显示错误消息,请使用您要显示的消息 throw 一个 Error

throw new Error('An error occurred');

Grafana 在面板的左上角显示错误消息

Panel error.
面板错误。

我们建议您避免向用户显示过于技术性的错误消息。如果您想让技术用户报告错误,请考虑将其记录到控制台。

try {
failingFunction();
} catch (err) {
console.error(err);
throw new Error('Something went wrong');
}
注意

Grafana 按原样在 UI 中显示异常消息,因此请使用语法正确的句子。有关更多信息,请参阅 文档风格指南

另请参阅