collector组件虽然内置了很多监控指标的采集,但无法解决所有场景,所以提供了插件机制,以便扩展collector的功能。

    查看collector的配置文件,里边配置了plugin的目录,我们只需把插件脚本放到这个目录下,collector就会自动探测到,然后周期性运行。对于业务系统的监控指标采集,可以把采集脚本放到业务程序发布包中,随着业务代码上线而上线(上线的时候把脚本放到collector的plugin目录下),随着业务代码升级而升级,随着业务代码的下线而下线(下线的时候把脚本从collector的plugin目录下移除),这样会比较容易管理。

    对于插件,有如下几个要求:

    • 插件脚本必须具有可执行权限,部署完了脚本记得chmod +x一下
    • 插件脚本可以是sh、py、pl、rb,甚至可以是二进制,只要机器上有runtime环境
    • 插件脚本的命名:${step}_xx.xx,比如20_uptime.sh,${step}是在告诉collector多久跑一次
    • plugin目录下非${step}_xx.xx命名格式的文件或者目录可以存在没关系,collector不会识别为插件
    • 插件执行之后要在stdout输出一个json array,collector会截获这个输出,解析为监控指标上报
    • 如果插件执行报错了,报错消息要打印到stderr,不要打印到stdout

    下面给一个shell编写的插件例子20_uptime.sh:

    1. #!/bin/bash
    2. duration=$(cat /proc/uptime | awk '{print $1}')
    3. localip=$(/usr/sbin/ifconfig `/usr/sbin/route|grep '^default'|awk '{print $NF}'`|grep inet|awk '{print $2}'|head -n 1)
    4. step=$(basename $0|awk -F'_' '{print $1}')
    5. echo '[
    6. {
    7. "endpoint": "'${localip}'",
    8. "tags": "",
    9. "timestamp": '$(date +%s)',
    10. "metric": "sys.uptime.duration",
    11. "value": '${duration}',
    12. "step": '${step}'
    13. }
    14. ]'

    下面给一个python编写的插件例子20_plugin_status.py:

    1. #!/usr/bin/env python
    2. # -*- coding: utf-8 -*-
    3. import time
    4. import commands
    5. import json
    6. import sys
    7. import os
    8. items = []
    9. def collect_myself_status():
    10. item = {}
    11. item["metric"] = "plugin.myself.status"
    12. item["value"] = 1
    13. item["tags"] = ""
    14. items.append(item)
    15. def main():
    16. code, endpoint = commands.getstatusoutput(
    17. "timeout 1 /usr/sbin/ifconfig `/usr/sbin/route|grep '^default'|awk '{print $NF}'`|grep inet|awk '{print $2}'|head -n 1")
    18. if code != 0:
    19. sys.stderr.write('cannot get local ip')
    20. return
    21. timestamp = int("%d" % time.time())
    22. plugin_name = os.path.basename(sys.argv[0])
    23. step = int(plugin_name.split("_", 1)[0])
    24. collect_myself_status()
    25. for item in items:
    26. item["endpoint"] = endpoint
    27. item["timestamp"] = timestamp
    28. item["step"] = step
    29. print json.dumps(items)
    30. if __name__ == "__main__":
    31. main()