可观察性(observability)实践规范

232 阅读3分钟

在做任何事之前需要有一个方法论或者规范文档作为指导,这个规范需要具有通用性和指导意义。根据规范进行具体的工作可以达到最终的目的,以终为始。以终为始是一种思维模式,最早出自《黄帝内经》,先人是在告诫后人要在人生的春天就认真思考人生终点的意义和价值。其引申义有三:一是凡事要有目标;二是凡事要有计划;三是凡事要有原则。正所谓“凡事预则立,不预则废”。

目标

要明确目标首先要确定产品的受众是谁。对于可视化来说,当前产品受众是开发、测试和运维人员。

  • 让数据更加直观
  • 帮助发现问题
  • 辅助解决问题

原则

从一个人到一个宇宙,都是不断熵增的个体。如何在迷雾中保持平稳运行,这时候就需要寻找事物的规律,也就是找到一些需要遵守的原则让自己不至于迷失。对于日志、监控等可视化系统来说,每天不断新增的数据也是一个熵增的过程,找到规律才能从混沌中得到秩序。尽管数据可视化背后的分析过程可能非常复杂,但可视化本身并不需要如此复杂。

  • 内容
    • 用户至上: 满足用户需求摆在第一位,先了解用户需求,之后根据需求规划页面布局等。
    • 讲故事: 明确每个仪表盘需要说明什么问题或达成什么需求。
    • 用户分类: 关心结果和关心过程的用户,所期望看到的图表是完全不同的。
    • 简单且清晰的说明: 每一个仪表盘(包括导航),都需要包含简单且条理清晰的说明文档。因为如果写了一篇很长的使用文档给用户,大多数用户只会需要用某个功能的时候查看文档,而且只看当前需要用的部分,所以与其让用户去翻文档,不如将文档拆分为小篇幅,放在每个仪表盘中。
    • 链接和系统联动: 首先要充分了解业务之间的联动需求,然后在相关的仪表盘添加链接跳转,相关的可视化系统之间添加跳转,且配置好对应的环境变量,减少跳转成本,提高效率。
  • 结构
    • 清晰的导航: 提升用户体验,提升效率。
    • 结构标准化: 仪表盘结构标准化,导航结构标准化,都可以促进可视化的一致性,降低新用户的学习门槛。
    • 内容简化分级: 精简第一层内容,只留必要的信息,其他具体信息可在下钻或在其他分级进行折叠,由用户自行点击开启。
    • 排序: 根据内容的重要程度排序,越重要的越靠前。
    • 分类: 根据内容的类别,将同类划分到一个层级。每个仪表盘或分层所要表达的一个侧重点或主题。
  • 其他
    • 协作优先: 不要做重复的事,充分沟通避免别人做过的事或解决过的问题你再做一遍。
    • 工具培训: 提供工具使用文档,且进行工具使用培训

参考