错误处理

本指南解释了如何在数据源插件中处理错误。

提供可用的默认值

让用户以小步骤学习您的插件。提供有用的默认配置，以便

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

例如，通过选择期望类型的第一个字段，面板可以显示可视化而无需任何用户配置。如果用户明确选择了一个字段，则使用该字段。否则，默认为类型 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 将错误消息显示在面板的左上角

面板错误。

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

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

注意

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

另请参阅

• 面板插件中的错误处理