命名约定
创建事件时,请使用以下字段名称和缩写的约定。
对字段名称使用以下命名约定
所有字段必须是小写。
使用蛇形命名法(下划线)组合单词。
通过使用点(.)符号将相关字段分组到子文档中。组通常具有共同的前缀。例如,如果在服务中有名为
CPULoad
和CPUSystem
的字段,则应将它们转换为事件中的cpu.load
和cpu.system
。避免在字段名称中重复命名空间。如果一个单词或缩写出现在命名空间中,则字段名称中不需要它。例如,不要使用
cpu.cpu_load
,而使用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 | average (平均) |
connection | conn (连接) |
max | maximum (最大值) |
min | minimum (最小值) |
request | req (请求) |
msg | message (消息) |