/open-falcon-data

open-falcon plugin golang data struct, help to fast construct output data.

Primary LanguageGoMIT LicenseMIT

open-falcon-data

open-falcon plugin golang data struct, help to fast construct output data.

Usage：

  • Data maintain all the output, contains an array of Entity. Providing AddEntity() to add a entity to the data and String() to get the output string.

  • Entity is the base data in open-falcon. Because the open-falcon need all the fields in the Entity so the NewEntity() and SetValueAndType() is necessary. other field like step or timestamp set by default.

open-falcon plugin data

  • metric: 最核心的字段，代表这个采集项具体度量的是什么, 比如是cpu_idle呢，还是memory_free, 还是qps
  • endpoint: 标明Metric的主体(属主)，比如metric是cpu_idle，那么Endpoint就表示这是哪台机器的cpu_idle
  • timestamp: 表示汇报该数据时的unix时间戳，注意是整数，代表的是秒
  • value: 代表该metric在当前时间点的值，float64
  • step: 表示该数据采集项的汇报周期，这对于后续的配置监控策略很重要，必须明确指定。
  • counterType: 只能是COUNTER或者GAUGE二选一，前者表示该数据采集项为计时器类型，后者表示其为原值 (注意大小写) GAUGE：即用户上传什么样的值，就原封不动的存储 COUNTER：指标在存储和展现的时候，会被计算为speed，即（当前值 - 上次值）/ 时间间隔
  • tags: 一组逗号分割的键值对, 对metric进一步描述和细化, 可以是空字符串. 比如idc=lg，比如service=xbox等，多个tag之间用逗号分割

Reference: