命名约定编辑

创建事件时,请对字段名称和缩写使用以下约定。

字段名称编辑

对字段名称使用以下命名约定

  • 所有字段必须小写。
  • 使用蛇形命名法(下划线)组合单词。
  • 通过使用点 (.) 表示法将相关字段分组到子文档中。组通常具有共同的前缀。例如,如果您在服务中有名为 CPULoadCPUSystem 的字段,则应在事件中将它们分别转换为 cpu.loadcpu.system
  • 避免在字段名称中重复命名空间。如果某个单词或缩写在命名空间中出现,则无需在字段名称中使用它。例如,应使用 cpu.load,而不是 cpu.cpu_load
  • 当指标与某个已知单位匹配时,使用单位后缀
  • 使用标准化名称,并避免使用不常用的缩写。
  • 将文档从一般到具体进行组织,以便进行命名空间划分。类型(如 .pct)应始终放在最后。例如,system.core.user.pct
  • 如果两个字段相同但单位不同,则删除粒度较小的那个字段。例如,包含 timeout.sec,但不包含 timeout.min。如果需要粒度较小的值,则可以稍后计算。
  • 如果字段名称与用于嵌套字段的命名空间匹配,则向字段名称添加 .value。例如,不要使用

    workers
    workers.busy
    workers.idle

    而应使用

    workers.value
    workers.busy
    workers.idle
  • 不要在单个字段名称中使用点 (.)。点保留用于将相关字段分组到子文档中。
  • 正确使用单数和复数名称以反映字段内容。例如,使用 requests_per_sec,而不是 request_per_sec

单位编辑

这些是表示存储值的单位的常用后缀,请尽可能将它们用作带点的后缀。例如,system.memory.used.bytessystem.diskio.read.count

后缀 单位

count

项数

pct

百分比

day

sec

ms

毫秒

us

微秒

ns

纳秒

bytes

bytes

mb

兆字节

标准化名称编辑

以下是所有 Beats 中使用的标准化名称和单位的列表

使用…​ 而不是…​

avg

average

connection

conn

max

maximum

min

minimum

request

req

msg

message