› ›

命名约定

命名约定编辑

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

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

所有字段必须是小写。
使用蛇形命名法（下划线）组合单词。
使用点（.）符号将相关字段分组到子文档中。组通常具有共同的前缀。例如，如果您在服务中具有名为 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

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