本页概述了创建 Grafana 面板时应遵循的一些最佳实践。
以下是创建仪表盘前需要考虑的一些原则。
您想用仪表盘讲述什么故事?尝试创建数据的逻辑顺序,例如从大到小或从一般到具体。这个仪表盘的目标是什么?(提示:如果仪表盘没有目标,那么问问自己是否真的需要仪表盘。)
图表要简单明了,重点放在回答您提出的问题上。例如,如果你的问题是 “哪些服务器有问题?”,那么你可能不需要显示所有服务器的数据。只需显示有问题的服务器的数据即可。
认知负荷基本上是指为了弄清一件事,你需要付出多大的努力去思考。让仪表盘易于理解。其他用户和未来的你(当你凌晨两点还在试图弄清什么东西坏了)都会对此表示赞赏。
问问自己:
我能说出每个图表具体代表什么吗?是一目了然,还是需要思考?
如果我给别人看,他们需要多长时间才能弄明白?他们会迷路吗?
制作新的仪表盘很容易。但要优化仪表盘的创建并遵守计划却很难,但这是值得的。该策略既要管理仪表盘的整体方案,又要确保单个仪表盘设计的一致性。
有关详细信息,请参阅常见可观察性策略和仪表盘管理成熟度级别。
一旦有了策略或设计指南,就把它们写下来,以帮助长期保持一致性。查看维基媒体运行手册范例。
创建新仪表盘时,确保它有一个有意义的名称。
如果创建仪表盘是为了进行游戏或实验,那么请在名称中加上 TEST 或 TMP 字样。
考虑在仪表盘名称中加入自己的姓名或姓名首字母缩写,或将其作为标签,这样人们就能知道仪表盘的主人是谁。
完成临时实验仪表盘后,将其删除。
如果创建了许多相关的仪表盘,请考虑如何交叉引用它们以方便导航。有关详细信息,请参阅管理仪表盘的最佳实践。
Grafana 从数据源检索数据。对一般数据源和特定数据源的基本了解非常重要。
避免不必要的仪表盘刷新,以减少网络或后台的负载。例如,如果您的数据每小时更改一次,那么您就不需要将仪表板刷新率设置为 30 秒。
在显示具有不同单位或范围的时间序列时,使用左右 Y 轴。
为仪表盘和面板添加文档。
要为仪表盘添加文档,请为仪表盘添加文本面板可视化。记录仪表盘的目的、有用的资源链接以及用户与仪表盘交互时可能需要的任何说明。请查看维基媒体示例。
要为面板添加文档,请编辑面板设置并添加说明。如果将光标悬停在面板左上角的小 i 上,添加的任何文本都会显示。
重复使用仪表盘,并通过使用模板和变量实现一致性。
小心堆叠图表数据。可视化可能会产生误导,并隐藏重要数据。我们建议在大多数情况下将其关闭。