命名约定
编辑命名约定
编辑创建事件时,请对字段名称和缩写使用以下约定。
字段名称
编辑请使用以下字段名称命名约定
- 所有字段必须小写。
- 使用蛇形命名法(下划线)组合单词。
- 使用点 (.) 表示法将相关字段分组到子文档中。组通常具有公共前缀。例如,如果服务中存在名为
CPULoad
和CPUSystem
的字段,则应将其转换为事件中的cpu.load
和cpu.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.bytes
或 system.diskio.read.count
后缀 | 单位 |
---|---|
count |
项目计数 |
pct |
百分比 |
day |
天 |
sec |
秒 |
ms |
毫秒 |
us |
微秒 |
ns |
纳秒 |
bytes |
bytes |
mb |
兆字节 |
标准化名称
编辑以下是所有 Beats 中使用的标准化名称和单位列表
使用… | 而不是… |
---|---|
avg |
平均值 |
connection |
conn |
max |
最大值 |
min |
最小值 |
request |
req |
msg |
message |