本页概述了创建Grafana仪表板时要遵循的一些最佳实践。Best practices for creating dashboards | Grafana Labs
在你开始创建仪表盘之前
以下是在创建仪表板之前需要考虑的一些原则。
仪表板应该讲述一个故事或回答一个问题
你想用你的仪表盘讲什么故事?
尝试创建数据的逻辑顺序,例如从大到小或从一般到特定。
此仪表板的目标是什么?
(提示:如果仪表板没有目标,那么问问自己是否真的需要仪表板。)
保持你的图表简单,集中精力回答你提出的问题。
例如,如果您的问题是“哪些服务器有问题?”,那么您可能不需要显示所有服务器数据。只需显示有问题的人的数据。
仪表盘应该减少认知负荷,而不是增加认知负荷
认知负荷基本上是指为了弄清楚某件事,你需要花多大的力气去思考它。
使您的仪表板易于理解。其他用户和未来的您(当您试图找出凌晨2点发生的故障时)会对此表示感谢。
问问自己:
- 我能告诉你每一张图到底代表什么吗?这是显而易见的,还是我必须考虑一下?
- 如果我把这个给别人看,他们要花多长时间才能弄明白?他们会迷路吗?
制定监控策略
制作新的仪表盘很容易。优化仪表板创建和遵守计划比较困难,但这是值得的。
此策略应控制整个仪表板方案,并在各个仪表板设计中强制实现一致性。
Refer to Common observability strategies and Dashboard management maturity levels for more information. (todo reading)
写下来
一旦你有了一个策略或设计指南,就把它们写下来,以帮助你在一段时间内保持一致性。(整个团队遵守自己产出的“设计指南”)
Check out this Wikimedia runbook example.(todo reading)
要遵循的最佳实践
- 创建新仪表板时,请确保它具有有意义的名称。
- 如果您要创建一个用于体验或实验的仪表板,请在名称中添加单词TEST或TMP。
- 考虑在仪表板名称中包含你的名字或首字母,或者作为一个标签,这样人们就知道谁拥有仪表板。
- 使用完临时实验仪表板后,请将其移除。
- 如果您创建了许多相关的仪表板,请考虑如何交叉引用它们以便于导航。有关更多信息, Refer to Best practices for managing dashboards for more information.(todo reading)
- Grafana从数据源检索数据。对一般数据源和特定数据源的基本了解非常重要。
- 避免不必要的仪表板刷新,以减少网络或后端的负载。例如,如果数据每小时更改一次,则无需将仪表板刷新率设置为30秒。
- 显示具有不同单位或范围的时间序列时,请使用左右Y轴。(时间序列值在左右的Y轴上,不太理解)
- 向仪表板和面板添加文档
- 要将文档添加到仪表板,请将文本面板可视化(Text panel visualization )(todo reading)添加到仪表板。记录仪表板的用途、有用的资源链接以及用户可能需要与仪表板交互的任何说明。看看这个Wikimedia example.的例子。
- 要向面板添加文档,请编辑面板设置(edit the panel settings)(todo reading)并添加说明。如果将光标悬停在面板左上角的小i上,将显示添加的任何文本。
- 重用仪表板,并通过使用模板和变量加强一致性。(templates and variables.)(todo reading)
- 小心 stacking graph (todo reading)数据。可视化可能会产生误导,并隐藏重要数据。我们建议在大多数情况下关闭它。