Zabbix监控之Linux命令行/Shell脚本解析json

本文主要写了在Linux下如何用Shell脚本解析json数据，以便于在Zabbix中添加适合于业务应用的监控项。

为什么要使用json？

json作为一种文本化的数据格式（文本化协议），符合UNIX编程的哲学，既符合透明性（透明性：设计可见，便于审查和调试）又符合文本性（文本性：数据应该保存为文本文件）。关键在于json对Web程序或者java程序非常友好，对于开发人员来说，他们也喜欢使用json数据。业务逻辑、内部的依赖关系以及状态信息由程序员去做，运维人员只需要调用程序员开放出来的API接口就行了。

利于Zabbix监控报警的json数据格式

json数据格式的定制原则（仅供参考）

1. human readable format 适合人阅读的格式

2. 区分依赖模块和总体状态

3. 每一个模块带有一个code（返回值）和一个msg（代表含义），这是便于Zabbix报警的核心设计，code用来作为触发器（Trigger）报警条件，msg作为触发器名称，也是短信报警的实际内容之一

#1没有问题的json格式

{    
    "errcode": "0",     
    "errmsg": {     
        "requirement1": {     
            "code": "0",     
            "msg": "requirement1 Ok"     
        },     
        "requirement2": {     
            "code": "0",     
            "msg": "requirement2 Ok"     
        },     
        "totalstatus": {     
            "code": "0",     
            "msg": "totalstatus Ok"     
        }     
    }     
}

#2有问题的json格式

{    
    "errcode": "1",     
    "errmsg": {     
        "requirement1": {     
            "code": "0",     
            "msg": "requirement1 Ok"     
        },     
        "requirement2": {     
            "code": "1",     
            "msg": "requirement2 Failed"     
        },     
        "totalstatus": {     
            "code": "1",     
            "msg": "totalstatus Failed"     
        }     
    }     
}

Linux Shell/命令行获取json数据

可以使用Linux通常自带的curl命令获取json数据

1. 通过POST方式提交数据（而不是使用GET），如果有多个参数，则用“&”连接起来，post提交的数据相当于一种口令，而避免搜索引擎或爬虫搜索到或被恶意利用

2. 合理设置curl的超时时间，并启用silent模式，防止curl输出一些没用的信息，甚至可以与2>/dev/null连用，参见下面的例子

例子：

curl -m 10 --connect-timeout 10 -s -d "getcode=secret" http://servername/url/api 2>/dev/null

Linux Shell/命令行解析json数据

可以使用jq命令，结合python的demjson模块，先验证json的合法性，再用jq解析json。

为什么要使用jq？jq作为Linux命令行解析json的神器，具有丰富json解析功能，而且其设计非常符合UNIX编程哲学中的“所有的程序都是数据的过滤器”，相比于按行与列处理文本的awk、grep和sed“文本三剑客”而言，jq就是处理json的利器。而且jq支持CentOS和Ubuntu等Linux主流发行版本。

例如以上面例子中的json，要想获取requirement1的状态，只需要将这个json作为jq的标准输入，命令行如下(二者选一，或者自己改写，awk的用途主要是去掉双引号)：

cat name.json | jq '.errmsg.requirement1.code' | awk '{print int($2)}'
cat test.json | jq '.errmsg.requirement1.code' | awk -F '"' '{print $2}'

补充一个需要注意的点

Zabbix里面的自定义参数作为key时，自定义参数后面跟的命令行与Linux命令行/脚本略有不同，如果命令行中显式引用awk中使用了$，则需要使用两个$，可以参考《解决Zabbix自定义用户参数无法获取到数据的问题》。

--end--