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:
#!/bin/bash
duration=$(cat /proc/uptime | awk '{print $1}')
localip=$(/usr/sbin/ifconfig `/usr/sbin/route|grep '^default'|awk '{print $NF}'`|grep inet|awk '{print $2}'|head -n 1)
step=$(basename $0|awk -F'_' '{print $1}')
echo '[
{
"endpoint": "'${localip}'",
"tags": "",
"timestamp": '$(date +%s)',
"metric": "sys.uptime.duration",
"value": '${duration}',
"step": '${step}'
}
]'
下面给一个python编写的插件例子20_plugin_status.py:
#!/usr/bin/env python
# -*- coding: utf-8 -*-
import time
import commands
import json
import sys
import os
items = []
def collect_myself_status():
item = {}
item["metric"] = "plugin.myself.status"
item["value"] = 1
item["tags"] = ""
items.append(item)
def main():
code, endpoint = commands.getstatusoutput(
"timeout 1 /usr/sbin/ifconfig `/usr/sbin/route|grep '^default'|awk '{print $NF}'`|grep inet|awk '{print $2}'|head -n 1")
if code != 0:
sys.stderr.write('cannot get local ip')
return
timestamp = int("%d" % time.time())
plugin_name = os.path.basename(sys.argv[0])
step = int(plugin_name.split("_", 1)[0])
collect_myself_status()
for item in items:
item["endpoint"] = endpoint
item["timestamp"] = timestamp
item["step"] = step
print json.dumps(items)
if __name__ == "__main__":
main()