前面的博文 Nginx安裝，開箱即用？講了NG的安裝，裝完NG，為了拿到各種狀態(tài)指標(biāo)，就要對NG做監(jiān)控。
Github 2.3k的開源項目nginx-module-vts沒準(zhǔn)真是你需求的。
鏈接數(shù)，qps，1xx、2xx,、3xx、4xx、5xx的響應(yīng)數(shù)，響應(yīng)耗時，響應(yīng)時間分布，訪問用戶國家分布；甚至是基于各種狀態(tài)的流量控制統(tǒng)統(tǒng)能滿足你的需求。
nginx-module-vts具體怎么用？我們還是從官方文檔開始擼吧，還是英文的，那就翻譯一下吧。
內(nèi)容有點長，你看到的文檔會四篇文檔的方式分別出現(xiàn)。這里是第一篇，余下的三篇會在后面分別發(fā)出。
Nginx虛擬主機流量狀態(tài)模塊
目錄
1、版本
本文件描述了2018年6月22日發(fā)布的nginx-module-vtsv0.1.18。
2、依賴
3、兼容性
- Nginx
- 1.15.x (最后一次測試：1.15.0)
- 1.14.x (最后一次測試：1.14.0)
- 1.13.x (最后一次測試：1.13.12)
- 1.12.x (最后一次測試 1.12.2)
- 1.11.x (最后一次測試：1.11.10)
- 1.10.x (最后一次測試：1.10.3)
- 1.8.x (最后一次測試：1.8.0)
- 1.6.x (最后一次測試 1.6.3)
- 1.4.x (最后一次測試：1.4.7)
早期版本不進行測試。
4、狀態(tài)截圖
5、安裝
- 克隆git存儲庫。
shell> git clone git://github.com/vozlt/nginx-module-vts.git
通過
--add-module=/path/to/nginx-module-vts將該模塊添加到構(gòu)建配置中構(gòu)建nginx二進制文件。
安裝nginx二進制文件。
6、概要
http {
vhost_traffic_status_zone;
...
server {
...
location /status {
vhost_traffic_status_display;
vhost_traffic_status_display_format html;
}
}
}
7、描述
這是一個Nginx模塊，提供對虛擬主機狀態(tài)信息的訪問。
它包含當(dāng)前狀態(tài)，例如servers, upstreams, caches。
這類似于nginx plus的實時活動監(jiān)視。
內(nèi)置的html和舊版本的演示頁面也保持一致。
首先，指令vhost_traffic_status_zone是必需的，如果指令vhost_traffic_status_display被設(shè)置，可以通過下方式訪問：
- /status/format/json
- 請求
/status/format/json將用一個包含當(dāng)前活動數(shù)據(jù)的json文檔進行響應(yīng)，以便在實時儀表板和三方監(jiān)視工具中使用。
- 請求
- /status/format/html
- 請求
/status/format/html將會用一個內(nèi)置的內(nèi)置的html儀表板網(wǎng)頁進行響應(yīng)，該儀表盤的內(nèi)部請求走/status/format/json。
- 請求
- /status/format/jsonp
- 請求
/status/format/jsonp將用一個jsonp回調(diào)函數(shù)進行響應(yīng)，該函數(shù)包含用于實時儀表板和三方監(jiān)視工具的當(dāng)前活動數(shù)據(jù)。
- 請求
- /status/format/prometheus
- 請求
/status/format/prometheus將用包含當(dāng)前活動數(shù)據(jù)的prometheus文檔來響應(yīng)。
- 請求
- /status/control
- 請求
/status/control將返回基于查詢語句字符串重置或刪除區(qū)域后的JSON文檔。更多可以參考Control.
- 請求
JSON文檔包含以下內(nèi)容：
{
"hostName": ...,
"nginxVersion": ...,
"loadMsec": ...,
"nowMsec": ...,
"connections": {
"active":...,
"reading":...,
"writing":...,
"waiting":...,
"accepted":...,
"handled":...,
"requests":...
},
"sharedZones": {
"name":...,
"maxSize":...,
"usedSize":...,
"usedNode":...
},
"serverZones": {
"...":{
"requestCounter":...,
"inBytes":...,
"outBytes":...,
"responses":{
"1xx":...,
"2xx":...,
"3xx":...,
"4xx":...,
"5xx":...,
"miss":...,
"bypass":...,
"expired":...,
"stale":...,
"updating":...,
"revalidated":...,
"hit":...,
"scarce":...
},
"requestMsecCounter":...,
"requestMsec":...,
"requestMsecs":{
"times":[...],
"msecs":[...]
},
"requestBuckets":{
"msecs":[...],
"counters":[...]
},
}
...
},
"filterZones": {
"...":{
"...":{
"requestCounter":...,
"inBytes":...,
"outBytes":...,
"responses":{
"1xx":...,
"2xx":...,
"3xx":...,
"4xx":...,
"5xx":...,
"miss":...,
"bypass":...,
"expired":...,
"stale":...,
"updating":...,
"revalidated":...,
"hit":...,
"scarce":...
},
"requestMsecCounter":...,
"requestMsec":...,
"requestMsecs":{
"times":[...],
"msecs":[...]
},
"requestBuckets":{
"msecs":[...],
"counters":[...]
},
},
...
},
...
},
"upstreamZones": {
"...":[
{
"server":...,
"requestCounter":...,
"inBytes":...,
"outBytes":...,
"responses":{
"1xx":...,
"2xx":...,
"3xx":...,
"4xx":...,
"5xx":...
},
"requestMsecCounter":...,
"requestMsec":...,
"requestMsecs":{
"times":[...],
"msecs":[...]
},
"requestBuckets":{
"msecs":[...],
"counters":[...]
},
"responseMsecCounter":...,
"responseMsec":...,
"responseMsecs":{
"times":[...],
"msecs":[...]
},
"responseBuckets":{
"msecs":[...],
"counters":[...]
},
"weight":...,
"maxFails":...,
"failTimeout":...,
"backup":...,
"down":...
}
...
],
...
}
"cacheZones": {
"...":{
"maxSize":...,
"usedSize":...,
"inBytes":...,
"outBytes":...,
"responses":{
"miss":...,
"bypass":...,
"expired":...,
"stale":...,
"updating":...,
"revalidated":...,
"hit":...,
"scarce":...
}
},
...
}
}
- main
- nginx版本，nginx運行時間((nowMsec - loadMsec)/1000)
- nowMsec，loadMsec是毫秒數(shù).
- connections
- 統(tǒng)計總連接數(shù)和總請求數(shù)(和nginx的stub_status_module相同)
- sharedZones
- 統(tǒng)計nginx-module-vts中使用的共享內(nèi)存信息
- serverZones
- 統(tǒng)計每個server的流量（in/out）以及請求和響應(yīng)計數(shù)和緩存命中率
- 統(tǒng)計總流量（in/out）以及總請求和總響應(yīng)計數(shù)（區(qū)域名稱為*）和總緩存命中率
- filterZones
- 通過
vhost_traffic_status_filter_by_set_key指令過濾統(tǒng)計的server的流量（輸入/輸出），請求和響應(yīng)計數(shù)以及緩存命中率。 - 總流量（in/out）以及總請求和總響應(yīng)計數(shù)（區(qū)域名稱為*）和命中率通過
vhost_traffic_status_filter_by_set_key指令過濾。
- 通過
- upstreamZones
- 統(tǒng)計每個upstream組中每個server的流量（in/out）以及請求和響應(yīng)計數(shù)
- nginx.conf中的當(dāng)前設(shè)置（權(quán)重，maxfails，failtimeout ...）
- cacheZones
- 使用proxy_cache指令時，每個緩存區(qū)域的流量（in/out）和大?。╟apacity/used）以及命中率。
JSON文檔中的overCounts對象主要用于32位系統(tǒng)，如果其值溢出，則將遞增1。使用指令vhost_traffic_status_display_format設(shè)置默認的輸出格式，即json、jsonp、html、prometheus之一。（默認值為json）
流量的計算規(guī)則如下：
- ServerZones
- in += requested_bytes
- out += sent_bytes
- FilterZones
- in += requested_bytes via the filter
- out += sent_bytes via the filter
- UpstreamZones
- in += requested_bytes via the ServerZones
- out += sent_bytes via the ServerZones
- cacheZones
- in += requested_bytes via the ServerZones
- out += sent_bytes via the ServerZones
所有計算都在Nginx的日志處理階段中進行。
內(nèi)部重定向（X-Accel-Redirect或error_page）不在UpstreamZones中計算。
注意：此模塊依賴于nginx日志記錄系統(tǒng)（NGX_HTTP_LOG_PHASE：nginx http的最后階段），因此流量可能在某些情況下和實際帶寬流量會有所不同。
Websocket以及取消的下載可能是造成差異的原因。
無論access_log指令是on還是off，模塊的工作都沒有關(guān)系。
同樣，此模塊在access_log off時也可以正常工作。
當(dāng)使用多個域時，它將設(shè)置為server_name指令的第一個域（左側(cè)）。
如果不需要，請參見vhost_traffic_status_filter_by_host, vhost_traffic_status_filter_by_set_key指令。
有關(guān)stream流量統(tǒng)計信息請參見以下模塊:
8、計算和間隔
平均值
所有的平均值目前都是用算術(shù)平均值AMM(Arithmetic Mean)基于最新的64 個值來計算的。
