跳转到主要内容

应用插件中的错误处理

本指南解释了如何在应用插件中处理错误。

提供可用的默认值​

允许用户通过小步骤了解您的插件。提供有用的默认配置，以便

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

例如，通过选择期望类型的第一个字段，面板可以显示无需用户配置的可视化。如果用户明确选择了一个字段，则使用该字段。否则，默认为类型 string 的第一个字段

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

显示错误信息​

要向用户显示错误信息，请 抛出 包含您要显示的消息的 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 中显示异常消息，因此请使用语法正确的句子。有关更多信息，请参阅 文档风格指南。

另请参阅​

如果您的应用插件包含其他插件类型，请参考以下错误处理指南：

有关向用户显示警报的一般指导，请参阅Saga设计系统。