摘要：目前此系統(tǒng)僅支持類系統(tǒng)下使用，不支持系統(tǒng)什么是這是一個(gè)獲取各種系統(tǒng)的監(jiān)控?cái)?shù)據(jù)的。監(jiān)控?cái)?shù)據(jù)上報(bào)公有的跟官方社區(qū)的思想一致采集的系統(tǒng)監(jiān)控信息如內(nèi)存等等一百多種沒有任何信息其他的業(yè)務(wù)系統(tǒng)的監(jiān)控都會(huì)打上。

項(xiàng)目地址：github

本系統(tǒng)版本劃分如下

alpha：內(nèi)部測(cè)試版（不建議使用于生產(chǎn)環(huán)境）

beta：公開測(cè)試版（不建議使用于生產(chǎn)環(huán)境）

final：最終正式版（可用于生產(chǎn)環(huán)境）

當(dāng)前版本請(qǐng)查看pom.xml信息。

此系統(tǒng)是和OpenFalcon監(jiān)控系統(tǒng)一起使用,是為了更方便的進(jìn)行運(yùn)維監(jiān)控。若不了解,可以先點(diǎn)擊鏈接去OpenFalcon的官方社區(qū)進(jìn)行了解。

目前此系統(tǒng)僅支持類Unix系統(tǒng)下使用，不支持Windows系統(tǒng)

這是一個(gè)獲取各種系統(tǒng)的監(jiān)控?cái)?shù)據(jù)的Agent。
其中內(nèi)置了OpenFalcon的社區(qū)組件:FalconAgent,因所有的監(jiān)控?cái)?shù)據(jù)都必須要上報(bào)到FalconAgent，所以為了部署方便和管理，SuitAgent集成了FalconAgent，若agent.falcon.push.url配置為本地地址,則啟動(dòng)時(shí)會(huì)同時(shí)啟動(dòng)自帶的FalconAgent，關(guān)閉時(shí)也會(huì)同時(shí)關(guān)閉FalconAgent。

OpenFalcon監(jiān)控系統(tǒng)，是由一系列的組件構(gòu)成。對(duì)于操作系統(tǒng)的監(jiān)控，官方有FalconAgent，但是對(duì)于其他系統(tǒng)的監(jiān)控，
都是使用腳本或者其他方式進(jìn)行多帶帶采集，然后將數(shù)據(jù)上報(bào)給FalconAgent系統(tǒng)。
公司為了運(yùn)維監(jiān)控的方便和自動(dòng)化，便有了這個(gè)項(xiàng)目，將系統(tǒng)的采集，集中在一個(gè)系統(tǒng)中，并且盡可能的采集便捷。

自動(dòng)探測(cè)部署機(jī)上的服務(wù),自動(dòng)監(jiān)控

監(jiān)控配置動(dòng)態(tài)生效,無需重啟

能夠動(dòng)態(tài)發(fā)現(xiàn)部署機(jī)上新啟動(dòng)的服務(wù)

支持Mock接口功能,有自動(dòng)化運(yùn)維的公司,可利用此特性進(jìn)行監(jiān)控自動(dòng)化開發(fā)

監(jiān)控服務(wù)全部插件化實(shí)現(xiàn)，可自定義開發(fā)自己需求的監(jiān)控服務(wù)的插件，只需要開發(fā)采集邏輯和插件運(yùn)行配置。SuitAgent可自動(dòng)發(fā)現(xiàn)插件，并根據(jù)配置自動(dòng)運(yùn)行，無需關(guān)心插件的啟動(dòng)。

Docker（包括Docker內(nèi)的應(yīng)用存活情況監(jiān)控）

ElasticSearch

Http

Logstash

Mysql

交換機(jī)

Ntp

Oracle

Ping

Standalone Jar（Java通過java -jar xxx.jar運(yùn)行的服務(wù)）

Tcp

Tomcat

Zookeeper

構(gòu)建工具:maven
Java版本：jdk 1.8

選擇對(duì)應(yīng)的版本進(jìn)行編譯:

- linux-64 : mvn clean package -Plinux-64 -Dmaven.test.skip=true
- linux64-noJar : mvn clean package -Plinux64-noJar -Dmaven.test.skip=true
- osx-noJar : mvn clean package -Posx-noJar -Dmaven.test.skip=true

編譯后，在target目錄下可看到編譯后的壓縮包，解壓縮，改改配置，即可使用

或者直接下載編譯后的文件，地址：

https://yunpan.cn/cMTHpgsQ3e5DV （提取碼：9f74）

版本說明:

linux-64 : linux-64位自帶Jre運(yùn)行環(huán)境。不需要目標(biāo)系統(tǒng)安裝java

osx-noJar : 蘋果系統(tǒng)。需要安裝java環(huán)境

linux64-noJar : linux-64位系統(tǒng)。需要目標(biāo)系統(tǒng)安裝個(gè)java環(huán)境

修改相關(guān)配置后,直接啟動(dòng)SuitAgent即可

建議：推薦編譯使用，因目前SuitAgent尚在完善中，代碼和配置難免會(huì)有所變動(dòng)。網(wǎng)盤中的文件不能保證隨時(shí)都是最新的。

SuitAgent配置

FalconAgent配置文件(配置官方社區(qū)的FalconAgent)

{SuitAgentHome}/conf/falcon/agent.cfg.json

SuitAgent配置文件

{SuitAgentHome}/conf/agent.properties

監(jiān)控服務(wù)授權(quán)配置

{SuitAgentHome}/conf/authorization.properties

監(jiān)控服務(wù)插件配置

{SuitAgentHome}/conf/plugin目錄下

SuitAgent相關(guān)命令

啟動(dòng)：./bin/agent.sh start (使用root用戶)

啟動(dòng)日志查看

可通過tail -f conf/console.log
觀察SuitAgent的運(yùn)行情況

關(guān)閉：./bin/agent.sh stop

狀態(tài)：/bin/agent.sh status

SuitAgent運(yùn)行中的日志分為四種：
1、console（debug）

2、info
3、warn
4、error
每種日志均自動(dòng)控制日志大小，每到5MB就自動(dòng)進(jìn)行日志分割，最多有10個(gè)同類文件。既所有的日志文件，最多只會(huì)達(dá)到200MB，無需擔(dān)心日志文件過于龐大。

公有的Tag

跟OpenFalcon官方社區(qū)的思想一致,FalconAgent采集的系統(tǒng)監(jiān)控信息(如內(nèi)存,CPU等等一百多種)沒有任何tag信息
其他的業(yè)務(wù)系統(tǒng)的監(jiān)控,都會(huì)打上tag。`SuitAgent`采集的系統(tǒng)，基本都是業(yè)務(wù)系統(tǒng)（非Linux操作系統(tǒng)監(jiān)控信息），所以都會(huì)有對(duì)應(yīng)的Tag

tag來區(qū)分服務(wù)

例如：

`service`={value} ：（內(nèi)建）服務(wù)產(chǎn)品名，如tomcat

`service.type`={value} ：（內(nèi)建）監(jiān)控服務(wù)類型，如jmx,database

`agentSignName`={value} ：（內(nèi)建）agent提供的標(biāo)識(shí)字符串，如 allUnVariability（代表該服務(wù)SuitAgent啟動(dòng)時(shí)就不存在），標(biāo)識(shí)服務(wù)的占用端口號(hào)，服務(wù)名等。

`metrics.type`={value} ：（內(nèi)建）監(jiān)控值類型，如availability，jmxObjectConf，jmxObjectInBuild，httpUrlConf，sqlConf，sqlInBuild，snmpConnomInBuild，snmpPluginInBuild

可用性(availability)會(huì)自動(dòng)打上標(biāo)簽：

metrics.type=availability,service={value}

若某個(gè)服務(wù)有自定義的endPoint（如SNMP V3），則會(huì)加上customerEndPoint=true的tag

Tomcat監(jiān)控值會(huì)打上dir={dirName}的tag，方便同一個(gè)物理機(jī)啟動(dòng)多個(gè)tomcat時(shí)，更好的識(shí)別具體的tomcat

SuitAgent所有的監(jiān)控服務(wù)都是插件式開發(fā)集成

如何自定義插件開發(fā)

SuitAgent支持的插件一共以下幾種：

JDBC的監(jiān)控服務(wù)，實(shí)現(xiàn)com.yiji.falcon.agent.plugins.JDBCPlugin接口

JMX的監(jiān)控服務(wù)，實(shí)現(xiàn)com.yiji.falcon.agent.plugins.JMXPlugin接口

SNMP V3的監(jiān)控服務(wù)，實(shí)現(xiàn)com.yiji.falcon.agent.plugins.SNMPV3Plugin接口

探測(cè)監(jiān)控服務(wù)，實(shí)現(xiàn)com.yiji.falcon.agent.plugins.DetectPlugin接口

若要開發(fā)自己的監(jiān)控服務(wù)，想好自己的監(jiān)控服務(wù)是哪種類型，參照SuitAgent目前已實(shí)現(xiàn)的插件結(jié)構(gòu)，
在包com.yiji.falcon.agent.plugins.plugin下建立自己的插件目錄，將插件類放在該目錄中，
然后根據(jù)規(guī)則，在src/main/resources_ext/conf/plugin/目錄下建立自己的插件配置文件即可。

JMX監(jiān)控服務(wù)

特殊的metrics說明

- 若SuitAgent在啟動(dòng)時(shí)，需要進(jìn)行監(jiān)控的服務(wù)（對(duì)應(yīng)的work配置為true的）未啟動(dòng)，則將會(huì)上報(bào)一個(gè)名為`allUnVariability`的metrics監(jiān)控指標(biāo)，值為`0`。tag中有metrics的詳情（參考tag命名），代表為該服務(wù)全部不可用

JMX監(jiān)控屬性組成

JMX監(jiān)控的屬性，由以下三部分組成

SuitAgent內(nèi)置的JMX監(jiān)控屬性

- `HeapMemoryUsedRatio` - 堆內(nèi)存使用比例
- `HeapMemoryCommitted` - 堆內(nèi)存已提交的大小
- `NonHeapMemoryCommitted` - 非堆內(nèi)存已提交的大小
- `HeapMemoryFree` - 堆內(nèi)存空閑空間大小
- `HeapMemoryMax` - 堆內(nèi)存最大的空間大小
- `HeapMemoryUsed` - 堆內(nèi)存已使用的空間大小
- `NonHeapMemoryUsed` - 非堆內(nèi)存已使用的空間大小

JMX 公共的監(jiān)控屬性自定義配置

定義于conf/jmx/common.properties文件

自定義的監(jiān)控屬性

每個(gè)插件自定義的屬于自身的監(jiān)控屬性

Java應(yīng)用的停機(jī)處理說明

正常情況下，若Java應(yīng)用停機(jī)，則它的JMX連接將會(huì)不可用，此時(shí)，SuitAgent將會(huì)上報(bào)該應(yīng)用不可用的監(jiān)控報(bào)告，并且，在每一次重新獲取監(jiān)控值時(shí)，都會(huì)嘗試重新連接此應(yīng)用。

若該應(yīng)用是被下線了，就是廢棄了，那么豈不是會(huì)永遠(yuǎn)上報(bào)不可用狀態(tài)？所以，SuitAgent有一個(gè)處理機(jī)制，在SuitAgent啟動(dòng)時(shí)，它會(huì)記錄每一個(gè)Java應(yīng)用的應(yīng)用路徑，如果該應(yīng)用被發(fā)現(xiàn)停機(jī)了，它會(huì)檢查該路徑還是否存在有效，如果路徑無效，SuitAgent將會(huì)清除此下線應(yīng)用的監(jiān)控信息，就不會(huì)上報(bào)不可用了。

目前支持的監(jiān)控組件

zookeeper

tomcat

elasticSearch

logstash

standaloneJar（多帶帶Jar包運(yùn)行的應(yīng)用，如SpringBoot)

JDBC監(jiān)控的服務(wù)

目前支持的監(jiān)控組件

    - Oracle
    - Mysql

SNMP監(jiān)控服務(wù)

公共的metrics列表

每個(gè)接口的Metrics：

- {ifName}.if.HCInBroadcastPkts
- {ifName}.if.HCInMulticastPkts
- {ifName}.if.HCInOctets
- {ifName}.if.HCInUcastPkts
- {ifName}.if.HCOutBroadcastPkts
- {ifName}.if.HCOutMulticastPkts
- {ifName}.if.getIfHCOutUcastPkts
- {ifName}.if.HCOutOctets
- {ifName}.if.OperStatus : (接口狀態(tài)，1 up, 2 down, 3 testing, 4 unknown, 5 dormant, 6 notPresent, 7 lowerLayerDown)

ping Metrics：

- pingAvgTime : Ping延時(shí)（正常返回延時(shí)，超時(shí)返回 -1）
    

交換機(jī)（SNMP V3）

說明

監(jiān)控的設(shè)備采集信息和采集邏輯主要參考了Falcon社區(qū)的swcollector項(xiàng)目，因swcollector不支持SNMP V3協(xié)議。

    [https://github.com/gaochao1/swcollector](https://github.com/gaochao1/swcollector)
    

采集的私有metric列表

    - 公共的metrics數(shù)據(jù)
    - CPU利用率
    - 內(nèi)存利用率
    

內(nèi)存和CPU的目前測(cè)試的支持設(shè)備

    - Cisco IOS(Version 12)
    - Cisco NX-OS(Version 6)
    - Cisco IOS XR(Version 5)
    - Cisco IOS XE(Version 15)
    - Cisco ASA (Version 9)
    - Ruijie 10G Routing Switch
    - Huawei VRP(Version 8)
    - Huawei VRP(Version 5.20)
    - Huawei VRP(Version 5.120)
    - Huawei VRP(Version 5.130)
    - Huawei VRP(Version 5.70)
    - Juniper JUNOS(Version 10)
    - H3C(Version 5)
    - H3C(Version 5.20)
    - H3C(Version 7)

探測(cè)監(jiān)控服務(wù)

HTTP監(jiān)控

監(jiān)控Metrics: 

availability

response.code : 響應(yīng)狀態(tài)碼

response.time : 響應(yīng)時(shí)間 毫秒

Ping監(jiān)控

監(jiān)控Metrics

availability

pingAvgTime : ping的平均延時(shí)（當(dāng)前為每次ping5次，取絕對(duì)值）

pingSuccessRatio : ping的成功次數(shù)占比，如ping了5次，只成功返回4次，則為0.8

TCP（Socket）監(jiān)控

監(jiān)控Metrics : 

availability

response.time : 響應(yīng)時(shí)間 毫秒

Yiji NTP 監(jiān)控

監(jiān)控Metrics

availability

0：NTP監(jiān)控失敗（如ntpdate命令執(zhí)行失敗）

1：NTP監(jiān)控成功

ntpOffset : ntpdate命令解析的offset值

Docker 監(jiān)控

監(jiān)控Metrics

availability

0：Docker daemon 探測(cè)失敗

1：Docker daemon 探測(cè)成功

availability-container

說明：在SuitAgent第一次運(yùn)行Docker插件時(shí)，會(huì)將第一次檢測(cè)到的容器名稱保存到內(nèi)存緩存中，在以后的每一次監(jiān)控時(shí)，會(huì)上報(bào)內(nèi)存緩存中的容器的可用性狀態(tài)

0：容器已停止運(yùn)行

1：容器正在運(yùn)行

availability.container.app

說明：在SuitAgent第一次運(yùn)行Docker插件時(shí)，會(huì)將第一次檢測(cè)到的容器內(nèi)的進(jìn)程情況進(jìn)行緩存到內(nèi)存中，在以后的每一次監(jiān)控時(shí)，會(huì)重新獲取容器內(nèi)的進(jìn)程情況，若與第一次一致，則為可用

0：容器內(nèi)應(yīng)用運(yùn)行不正常

1：容器內(nèi)應(yīng)用正常運(yùn)行

-1：容器內(nèi)的應(yīng)用狀態(tài)數(shù)據(jù)獲取失敗

has_cpu : 是否有CPU使用權(quán)限

total.cpu.usage.rate : CPU總使用率百分比

user.cpu.usage.rate : CPU用戶級(jí)別使用率百分比

system.cpu.usage.rate : CPU系統(tǒng)級(jí)別使用率百分比

has_memory : 是否有內(nèi)存使用權(quán)限

mem.size.usage : 當(dāng)前已使用的內(nèi)存大小（單位兆）

mem.size.cache : 當(dāng)前已緩存的內(nèi)存大小（單位兆）

mem.usage.rate : 內(nèi)存已使用與容器總內(nèi)存百分比

mem.cache.rate : 內(nèi)存緩存與容器總內(nèi)存的百分比

has_network : 是否有網(wǎng)絡(luò)使用權(quán)限

net.if.in.bytes : 網(wǎng)絡(luò)IO流入字節(jié)數(shù)

net.if.in.packets : 網(wǎng)絡(luò)IO流入包數(shù)

net.if.in.dropped : 網(wǎng)絡(luò)IO流入丟棄數(shù)

net.if.in.errors : 網(wǎng)絡(luò)IO流入出錯(cuò)數(shù)

net.if.out.bytes : 網(wǎng)絡(luò)IO流出字節(jié)數(shù)

net.if.out.packets : 網(wǎng)絡(luò)IO流出包數(shù)

net.if.out.dropped : 網(wǎng)絡(luò)IO流出丟棄數(shù)

net.if.out.errors : 網(wǎng)絡(luò)IO流出出錯(cuò)數(shù)

zookeeper

無需配置，可自動(dòng)發(fā)現(xiàn)

tomcat

無需配置，可自動(dòng)發(fā)現(xiàn)

elasticSearch

無需配置，可自動(dòng)發(fā)現(xiàn)

logstash

無需配置，可自動(dòng)發(fā)現(xiàn)

standalone應(yīng)用(java -jar 方式的Jar包運(yùn)行)

需要配置`conf/plugin/standaloneJarPlugin.properties`配置文件的`jmxServerName`或`jmxServerDir`，
然后SuitAgent會(huì)自動(dòng)發(fā)現(xiàn)已配置的standalone應(yīng)用

Oracle

需要配置`conf/authorization.properties`配置中的Oracle連接信息，然后會(huì)根據(jù)配置的連接信息，進(jìn)行自動(dòng)發(fā)現(xiàn)Oracle應(yīng)用，并監(jiān)控

Mysql

需要配置`conf/authorization.properties`配置中的Mysql連接信息，然后會(huì)根據(jù)配置的連接信息，進(jìn)行自動(dòng)發(fā)現(xiàn)Mysql應(yīng)用，并監(jiān)控

SNMP V3 交換機(jī)

需要配置`conf/authorization.properties`配置中的交換機(jī)的SNMP V3的連接信息，然后會(huì)根據(jù)配置的連接信息，進(jìn)行自動(dòng)發(fā)現(xiàn)交換機(jī)并監(jiān)控。

HTTP監(jiān)控

只要配置了被探測(cè)的地址，就會(huì)觸發(fā)監(jiān)控服務(wù)

Ping監(jiān)控

只要配置了被探測(cè)的地址，就會(huì)觸發(fā)監(jiān)控服務(wù)

TCP監(jiān)控

只要配置了被探測(cè)的地址，就會(huì)觸發(fā)監(jiān)控服務(wù)

NTP監(jiān)控

只要配置了NTP服務(wù)器地址，就會(huì)觸發(fā)監(jiān)控服務(wù)

Docker監(jiān)控

無需配置地址，自動(dòng)探測(cè)本機(jī)的`Docker`服務(wù)：若發(fā)現(xiàn)有命令`/usr/bin/docker`存在，就會(huì)啟動(dòng)`Docker`監(jiān)控插件。并自動(dòng)連接本機(jī)的`cAdvisor`服務(wù)或啟動(dòng)內(nèi)置的`vAdvisor`服務(wù)

SuitAgent支持部分配置的動(dòng)態(tài)生效，支持的范圍見如下說明

authorization.properties文件的改動(dòng)

若對(duì)應(yīng)插件未啟動(dòng)，則文件修改后，將在SuitAgent下一次的自動(dòng)服務(wù)發(fā)現(xiàn)時(shí)生效。

若對(duì)應(yīng)的插件已啟動(dòng)，因系統(tǒng)不會(huì)重復(fù)啟動(dòng)相同的監(jiān)控服務(wù)，故雖然插件配置會(huì)生效，但是不會(huì)重新啟動(dòng)服務(wù)

plugin目錄下的插件配置文件的改動(dòng)

若改動(dòng)的是未啟動(dòng)的監(jiān)控服務(wù)配置（如StandaloneJarPlugin插件的standaloneJarPlugin.properties文件，添加了一個(gè)服務(wù)名。或更改了插件啟動(dòng)類型等），將在SuitAgent下一次的自動(dòng)服務(wù)發(fā)現(xiàn)時(shí)生效

若改動(dòng)的是插件的監(jiān)控配置（如Tomcat插件的tomcatPlugin.properties文件的服務(wù)器監(jiān)控參數(shù)配置），下一次監(jiān)控掃描就能夠生效。

若改動(dòng)的是插件的自定義配置文件，它的改動(dòng)將不會(huì)觸發(fā)插件的配置更新事件，不過可以利用改動(dòng)它的插件配置文件，觸發(fā)配置更新。

注意

已啟動(dòng)的插件服務(wù)，不會(huì)因?yàn)榕渲梦募母膭?dòng)而停止服務(wù)

插件啟動(dòng)時(shí)的配置項(xiàng)（如插件的step，pluginActivateType等）被改動(dòng)時(shí)，若插件已啟動(dòng)，雖然改動(dòng)的配置插件會(huì)實(shí)時(shí)更新，但由于服務(wù)已啟動(dòng)，這些屬性已經(jīng)在啟動(dòng)時(shí)固定，所以將不會(huì)因?yàn)楦膭?dòng)而生效

接口說明

SuitAgent提供可用性(availability)的mock服務(wù)。

mock服務(wù)具有有效性,有效性時(shí)長(zhǎng),通過配置 agent.properties 文件的 agent.mock.valid.time 配置項(xiàng)

有效的mock,將會(huì)讓mock的目標(biāo)服務(wù)即使已經(jīng)停止運(yùn)行,也會(huì)上報(bào)一個(gè)可用的監(jiān)控?cái)?shù)據(jù),并且?guī)?mock=true 的 tag

若mock的時(shí)間超時(shí),既無效,則會(huì)上報(bào)目標(biāo)服務(wù)不可用的監(jiān)控?cái)?shù)據(jù),并且?guī)?mock=timeout-{time} 的 tag 。其中{time}是停機(jī)時(shí)間

接口使用

http://ip:port/mock/list

查看SuitAgent當(dāng)前所有的mock配置，返回json格式的數(shù)據(jù),示例:

{
    "jmx": {
      "service": "tomcat",
      "isTimeout": false,
      "shutdownTime": 0
    }
}

http://ip:port/mock/add/|f1f204026cc40a72030bbf5a799e1bb675|/service

添加一個(gè)mock配置

http://ip:port/mock/remove/|f1f204026cc40a72030bbf5a799e1bb677|/service

刪除一個(gè)mock配置

參數(shù)說明

serviceType : 對(duì)應(yīng)于監(jiān)控值tag中的service.type屬性

service : 對(duì)應(yīng)于監(jiān)控值tag中的service或agentSignName屬性