日志可视化规范

1. 命名和属性

1.1. Visualize

• 标题命名: [模块名称]-[描述]，比如 [xxx]-[日志等级百分比]
• 描述: 版本号
• 标签: 模块名称(以下Visualize中未声明特殊标签，则使用模块名称作为标签)

1.1.1. 说明

• 通用说明: 必须, 所有模块通用的说明文档，所有dashboard导入一个visualize即可，命名: [通用说明]，标签common-description
• 模块说明: 必须, 特定模块的说明文档，没有说明则留空，同个模块的不同dashboard可共用一个模块说明。命名: [模块名称]-[模块说明]，添加监控系统和追踪系统的初级跳转

1.1.2. 控件

• 自定义控件: 必须，命名: [模块名称]-[控件说明]，如: [xxx]-[日志等级控件]

  • region选择: 必须，可快速筛选不同可用区
  • 其他自定义: 可选，根据业务日志自定义

1.2. Dashboard

• 标题命名: [模块名称]-[指标说明]，比如 [xxx]-[日志等级]

• 描述: 版本号

• 标签: 模块名称

• 模块尺寸: 基础单元尺寸，x轴12个单位，y轴9个单位，表示为(12,9)

  • 第一行: 通用说明x1(12,9)， 模块说明x1(12,9)，控件x1(12,18)
  • 第二行: 业务指标尽量保持3x4的布局，同时可根据具体业务展示需要以基础单元尺寸(12,9)为单位调整大小，比如: x轴延长，则调整为(12+12,9)；x和y轴同时延长，则调整为(12+12, 9+9)

• 首页排布: 3行4列，第一行默认通用模块固定尺寸，其他的Visualize根据业务按照(12,9)比例调整尺寸

• 将时间随仪表板保存，时间默认24小时

1.3. 导航

一个模块根据不同类型的指标分成多个dashboard进行展示后，需要一个汇总的dashboard提供导航作用。

• 标题命名: [序列号]-[模块名称]-[导航]，比如[0001]-[xxx]-[导航]
• 标签: 模块名称+[模块名称]-导航

2. 指标类型选择

• 数量展示

  • 图形类别: lens -> 指标(stat)

• 数量排名

  • 图形类别: lens -> 条形图

• 百分比

  • 图形类别: lens -> 默认饼图

• 时间分布

  • 图形类别: lens -> 堆叠条形图

• 具体消息

  • 图形类别: lens -> 数据表 -> top 100

• 时延

  • 图形类别: TSVB

• 源地址热力图

  • 图形类别: map

• 其他待补充

3. 导入和导出

• 完成dashboard之后需要将dashboard代码导出，并复制到对应的cd项目中进行部署
• cd项目中dashboard文件命名规范: <object序号>-<模块所属space>-<模块名称>.ndjson