裝完NG，為了拿到各種狀態(tài)指標(biāo)索昂，就要對(duì)NG做監(jiān)控建车。
Github 2.3k的開源項(xiàng)目nginx-module-vts沒準(zhǔn)真是你需求的。
鏈接數(shù)椒惨，qps缤至，1xx、2xx,框产、3xx凄杯、4xx、5xx的響應(yīng)數(shù)秉宿，響應(yīng)耗時(shí)戒突，響應(yīng)時(shí)間分布，訪問用戶國(guó)家分布描睦；甚至是基于各種狀態(tài)的流量控制統(tǒng)統(tǒng)能滿足你的需求膊存。
nginx-module-vts具體怎么用？我們還是從官方文檔開始擼吧忱叭，還是英文的隔崎，那就翻譯一下吧。
內(nèi)容有點(diǎn)長(zhǎng)韵丑，你看到的文檔會(huì)四篇文檔的方式分別出現(xiàn)爵卒。這里是第四篇，第一篇你可以點(diǎn)這里查看撵彻，第二篇你可以點(diǎn)這里查看钓株，第三篇你可以點(diǎn)這里查看实牡。

Nginx虛擬主機(jī)流量狀態(tài)模塊

License

目錄

• 16、指令
  • vhost_traffic_status
  • vhost_traffic_status_zone
  • vhost_traffic_status_dump
  • vhost_traffic_status_display
  • vhost_traffic_status_display_format
  • vhost_traffic_status_display_jsonp
  • vhost_traffic_status_display_sum_key
  • vhost_traffic_status_filter
  • vhost_traffic_status_filter_by_host
  • vhost_traffic_status_filter_by_set_key
  • vhost_traffic_status_filter_check_duplicate
  • vhost_traffic_status_filter_max_node
  • vhost_traffic_status_limit
  • vhost_traffic_status_limit_traffic
  • vhost_traffic_status_limit_traffic_by_set_key
  • vhost_traffic_status_limit_check_duplicate
  • vhost_traffic_status_set_by_filter
  • vhost_traffic_status_average_method
  • vhost_traffic_status_histogram_buckets
  • vhost_traffic_status_bypass_limit
  • vhost_traffic_status_bypass_stats
• 17轴合、另請(qǐng)參閱
• 18、待辦事項(xiàng)
• 19题涨、捐贈(zèng)
• 20总滩、作者

16、指令

draw_io_vts_diagram

vhost_traffic_status

說明： 啟用或禁用模塊工作婉支。如果設(shè)置vhost_traffic_status_zone指令澜建，則會(huì)自動(dòng)啟用向挖。

vhost_traffic_status_zone

說明： 為共享內(nèi)存區(qū)域設(shè)置參數(shù)，該區(qū)域?qū)⒈４娓鞣N鍵的狀態(tài)炕舵。緩存在所有工作進(jìn)程之間共享何之。
在大多數(shù)情況下，nginx-module-vts使用的共享內(nèi)存大小不會(huì)增加太多咽筋。
當(dāng)使用vhost_traffic_status_filter_by_set_key指令時(shí)溶推，共享內(nèi)存的大小會(huì)增加很多，但是如果過濾器的鍵是固定的（例如奸攻，國(guó)家代碼的總數(shù)約為240）蒜危，則不會(huì)持續(xù)增加。

如果使用vhost_traffic_status_filter_by_set_key指令睹耐，請(qǐng)按如下方式設(shè)置：

• 默認(rèn)設(shè)置為32M共享內(nèi)存大小辐赞。(vhost_traffic_status_zone shared:vhost_traffic_status:32m)
• 如果出現(xiàn)("ngx_slab_alloc() failed: no memory in vhost_traffic_status_zone")的異常日志，則增加到大于（usedSize*2）

vhost_traffic_status_dump

說明： 啟用統(tǒng)計(jì)數(shù)據(jù)存儲(chǔ)和還原硝训。
path 是存儲(chǔ)統(tǒng)計(jì)數(shù)據(jù)的位置响委。(例如 /var/log/nginx/vts.db)
period 是一個(gè)備份周期。(默認(rèn): 60s)
如果nginx被（SIGKILL）信號(hào)退出窖梁，則不管備份周期如何赘风，它都會(huì)立即備份。

vhost_traffic_status_display

說明： 啟用或禁用顯示處理程序模塊纵刘。

vhost_traffic_status_display_format

說明： 設(shè)置顯示處理模塊輸出的格式假哎。
如果設(shè)置json，則將用JSON文檔響應(yīng)。
如果設(shè)置了html笋轨，則將以內(nèi)置的HTML格式的實(shí)時(shí)儀表板進(jìn)行響應(yīng)。
如果設(shè)置jsonp钾挟，則將使用JSONP回調(diào)函數(shù)（默認(rèn)值：ngx_http_vhost_traffic_status_JSONP_callback）響應(yīng)。
如果設(shè)置prometheus汤锨，則將用一個(gè)prometheus 文檔來響應(yīng)。

vhost_traffic_status_display_jsonp

說明： 設(shè)置JSONP的回調(diào)名稱柬泽。

vhost_traffic_status_display_sum_key

說明： 在serverZones字段的JSON中設(shè)置sum鍵對(duì)應(yīng)的字符串。默認(rèn)的sum鍵字符串是“*”琳疏。

vhost_traffic_status_filter

說明： 啟用或禁用篩選器功能。

vhost_traffic_status_filter_by_host

說明： 啟用或禁用keys by Host header 字段。
如果設(shè)置on同時(shí)nginx的server_name指令設(shè)置多個(gè)或以星號(hào)開頭的通配符名稱篱瞎，例如“.example.org”牵素，同時(shí)請(qǐng)求server使用主機(jī)名，如(a|b|c).example.org或.example.org赠幕，則json格式的 serverZones將按如下方式打娱叛摺：

server {
  server_name *.example.org;
  vhost_traffic_status_filter_by_host on;

  ...

}

  ...
  "serverZones": {
      "a.example.org": {
      ...
      },
      "b.example.org": {
      ...
      },
      "c.example.org": {
      ...
      }
      ...
   },
   ...

It provides the same function that set vhost_traffic_status_filter_by_set_key $host.
它與設(shè)置vhost_traffic_status_filter_by_set_key $host提供了相同的函數(shù)踱讨。

vhost_traffic_status_filter_by_set_key

說明： 啟用由用戶定義的鍵沫勿。
key 是用于計(jì)算流量的鍵字符串。
name 是用于計(jì)算流量的分組字符串蔓挖。
key和name 可以包含變量，如server_name。
指定第二個(gè)參數(shù)name時(shí)對(duì)應(yīng)的分組信息在filterZones中體現(xiàn)驮吱。
如果沒有指定第二個(gè)參數(shù)name桐筏，則key的組屬于serverZones梅忌。
geoip模塊示例如下：

server {
  server_name example.org;
  vhost_traffic_status_filter_by_set_key $geoip_country_code country::$server_name;

  ...

}

  ...
  "serverZones": {
  ...
  },
  "filterZones": {
      "country::example.org": {
          "KR": {
              "requestCounter":...,
              "inBytes":...,
              "outBytes":...,
              "responses":{
                  "1xx":...,
                  "2xx":...,
                  "3xx":...,
                  "4xx":...,
                  "5xx":...,
                  "miss":...,
                  "bypass":...,
                  "expired":...,
                  "stale":...,
                  "updating":...,
                  "revalidated":...,
                  "hit":...,
                  "scarce":...
              },
              "requestMsecCounter":...,
              "requestMsec":...,
              "requestMsecs":{
                  "times":[...],
                  "msecs":[...]
              },
          },
          "US": {
          ...
          },
          ...
      },
      ...
  },
  ...

vhost_traffic_status_filter_check_duplicate

說明： 啟用或禁用vhost_traffic_status_filter_by_set_key的重復(fù)數(shù)據(jù)刪除皂岔。
如果啟用此選項(xiàng)，則在每個(gè)指令（http教馆、server土铺、location）中只處理一個(gè)重復(fù)值（key + name）。

vhost_traffic_status_filter_max_node

說明： 基于指定的number和string參數(shù)啟用篩選器大小限制后德。
如果超過制定的number，則通過LRU 算法刪除現(xiàn)有節(jié)點(diǎn)绵患。
number參數(shù)是將限制的節(jié)點(diǎn)的大小。默認(rèn)值0不限制過濾器掘殴。
一個(gè)節(jié)點(diǎn)是JSON文檔中filterZones中的一個(gè)對(duì)象起意。
string參數(shù)匹配在vhost_traffic_status_filter_by_set_key指令中設(shè)置的組字符串對(duì)應(yīng)的值。
即使只有第一部分匹配亲善，匹配也是成功的蛹头，就像正則表達(dá)式/^string.*/。
默認(rèn)情況下，如果不設(shè)置string參數(shù)骚烧，則它將應(yīng)用于所有的篩選器止潘。

例如：

$ vi nginx.conf

http {

    geoip_country /usr/share/GeoIP/GeoIP.dat;

    vhost_traffic_status_zone;

    # The all filters are limited to a total of 16 nodes.
    # vhost_traffic_status_filter_max_node 16

    # The `/^uris.*/` and `/^client::ports.*/` group string patterns are limited to a total of 64 nodes.
    vhost_traffic_status_filter_max_node 16 uris client::ports

    ...

    server {

        server_name example.org;

        ...

        vhost_traffic_status_filter_by_set_key $uri uris::$server_name;
        vhost_traffic_status_filter_by_set_key $remote_port client::ports::$server_name;
        vhost_traffic_status_filter_by_set_key $geoip_country_code country::$server_name;

    }
}

$ for i in {0..1000}; do curl -H 'Host: example.org' -i "http://localhost:80/test$i"; done

screenshot-vts-filter-max-node

在上面的例子中炕矮，/^uris.*/和/^client::ports.*/分組字符串被限制為總共16個(gè)節(jié)點(diǎn)档痪。其他過濾器腐螟，如country::.*不受限制衬廷。

vhost_traffic_status_limit

說明： 啟用或禁用限制功能。

vhost_traffic_status_limit_traffic

說明： 為指定member啟用流量限制跌宛。
參數(shù)member是限制流量的統(tǒng)計(jì)粒度字符串寂曹。
參數(shù)size是限制流量的大小字符串芬失，單位（k/m/g）。
參數(shù)code是請(qǐng)求被拒絕時(shí)候的響應(yīng)代碼阶女。(默認(rèn)響應(yīng)碼:503）

可用的member字符串如下

• request
  • 從客戶端接收的請(qǐng)求總數(shù)。
• in
  • 從客戶端接收的總字節(jié)數(shù)。
• out
  • 發(fā)送到客戶端的總字節(jié)數(shù)消别。
• 1xx
  • 狀態(tài)代碼為1xx的響應(yīng)數(shù)。
• 2xx
  • 狀態(tài)代碼為2xx的響應(yīng)數(shù)蛇券。
• 3xx
  • 狀態(tài)代碼為3xx的響應(yīng)數(shù)塘慕。
• 4xx
  • 狀態(tài)代碼為4xx的響應(yīng)數(shù)。
• 5xx
  • 狀態(tài)代碼為5xx的響應(yīng)數(shù)岳瞭。
• cache_miss
  • 緩存未命中數(shù)牡昆。
• cache_bypass
  • 緩存旁路數(shù)柱宦。
• cache_expired
  • 緩存已過期數(shù)。
• cache_stale
  • 緩存失效的數(shù)量。
• cache_updating
  • 緩存更新的次數(shù)蚓炬。
• cache_revalidated
  • 重新驗(yàn)證的緩存數(shù)。
• cache_hit
  • 緩存命中數(shù)
• cache_scarce
  • 未達(dá)緩存要求的請(qǐng)求的數(shù)量。

vhost_traffic_status_limit_traffic_by_set_key

說明： 針對(duì)制定的key和member進(jìn)行流量控制
參數(shù)key是限制流量的key字符串
參數(shù)member是限制流量的member字符串
參數(shù)size是流量的限制的大小字符串，單位（k/m/g）币喧。
參數(shù)code是請(qǐng)求被拒絕時(shí)候的響應(yīng)代碼。(默認(rèn)響應(yīng)碼:503）

key 語(yǔ)法如下：

• group@[subgroup@]name

可用的group 字符串如下：

• NO
  • server group史翘。
• UA
  • upstream alone group洪唐。
• UG
  • The group of upstream group.(use subgroup)
• CC
  • cache group钻蹬。
• FG
  • filter group。(use subgroup)

可用的member字符串如下：

• request
  • 從客戶端接收的請(qǐng)求總數(shù)凭需。
• in
  • 從客戶端接收的總字節(jié)數(shù)问欠。
• out
  • 發(fā)送到客戶端的總字節(jié)數(shù)。
• 1xx
  • 狀態(tài)代碼為1xx的響應(yīng)數(shù)粒蜈。
• 2xx
  • 狀態(tài)代碼為2xx的響應(yīng)數(shù)顺献。
• 3xx
  • 狀態(tài)代碼為3xx的響應(yīng)數(shù)枯怖。
• 4xx
  • 狀態(tài)代碼為4xx的響應(yīng)數(shù)蚂斤。
• 5xx
  • 狀態(tài)代碼為5xx的響應(yīng)數(shù)。
• cache_miss
  • 緩存未命中數(shù)视搏。
• cache_bypass
  • 緩存旁路數(shù)漓滔。
• cache_expired
  • 緩存已過期數(shù)。
• cache_stale
  • 緩存失效的數(shù)量日熬。
• cache_updating
  • 緩存更新的次數(shù)艳馒。
• cache_revalidated
  • 重新驗(yàn)證的緩存數(shù)。
• cache_hit
  • 緩存命中數(shù)
• cache_scarce
  • 未達(dá)緩存要求的請(qǐng)求的數(shù)量。

這里的member與vhost_traffic_status_limit_traffic指令下的member相同飒赃。

vhost_traffic_status_limit_check_duplicate

說明： 啟用或禁用vhost_traffic_status_limit_by_set_key的重復(fù)數(shù)據(jù)刪除。
如果啟用此選項(xiàng)阐枣，則只處理每個(gè)指令（http锁孟、server盆昙、location）中的重復(fù)值（member或者key + member）中的一個(gè)。

vhost_traffic_status_set_by_filter

說明： 獲取存儲(chǔ)在共享內(nèi)存中的指定狀態(tài)值磕洪。
它可以獲取幾乎所有的狀態(tài)值晰绎，并將獲得的值存儲(chǔ)在第一個(gè)參數(shù)$variable中河绽。

• group
  • server
  • filter
  • upstream@alone
  • upstream@group
  • cache
• zone
  • server
    • name
  • filter
    • filter_group@name
  • upstream@group
    • upstream_group@name
  • upstream@alone
    • @name
  • cache
    • name
• name
  • requestCounter
    • 從客戶端接收的客戶端請(qǐng)求總數(shù)。
  • requestMsecCounter
    • 累積的請(qǐng)求處理時(shí)間（毫秒）趟咆。
  • requestMsec
    • 請(qǐng)求處理時(shí)間的平均值（毫秒）
  • responseMsecCounter
    • 僅上游響應(yīng)處理時(shí)間的累積數(shù)（毫秒）。
  • responseMsec
    • 僅上游響應(yīng)處理時(shí)間的平均值（毫秒）息楔。
  • inBytes
    • 從客戶端接收的總字節(jié)數(shù)辆亏。
  • outBytes
    • 發(fā)送到客戶端的總字節(jié)數(shù)
  • 1xx, 2xx, 3xx, 4xx, 5xx
    • 狀態(tài)代碼為1xx、2xx、3xx交洗、4xx和5xx的響應(yīng)數(shù)殷蛇。
  • cacheMaxSize
    • 配置中指定的緩存的最大大小限制。
  • cacheUsedSize
    • 緩存的當(dāng)前大小拣播。
  • cacheMiss
    • 緩存未命中數(shù)晾咪。
  • cacheBypass
    • 緩存旁路數(shù)。
  • cacheExpired
    • 緩存過期數(shù)贮配。
  • cacheStale
    • 緩存失效的數(shù)量谍倦。
  • cacheUpdating
    • 緩存更新的次數(shù)。
  • cacheRevalidated
    • 重新驗(yàn)證的緩存數(shù)泪勒。
  • cacheHit
    • 緩存命中的數(shù)量
  • cacheScarce
    • 未達(dá)緩存要求的請(qǐng)求的數(shù)量昼蛀。
  • weight
    • server的當(dāng)前權(quán)重值。
  • maxFails
    • server的當(dāng)前max_fails設(shè)置圆存。
  • failTimeout
    • server的當(dāng)前fail_timeout設(shè)置叼旋。
  • backup
    • server的當(dāng)前備份設(shè)置(0或1)
  • down
    • server的當(dāng)前下線設(shè)置(0或1)

注意：name區(qū)分大小寫。所有返回值都采用整數(shù)類型沦辙。

例如：

• serverZones中的請(qǐng)求計(jì)數(shù)器設(shè)置
  • vhost_traffic_status_set_by_filter $requestCounter server/example.org/requestCounter
• filterZones中的請(qǐng)求計(jì)數(shù)器設(shè)置
  • vhost_traffic_status_set_by_filter $requestCounter filter/country::example.org@KR/requestCounter
• upstreamZones中的請(qǐng)求計(jì)數(shù)器設(shè)置
  • vhost_traffic_status_set_by_filter $requestCounter upstream@group/backend@10.10.10.11:80/requestCounter
• upstreamZones::nogroups中的請(qǐng)求計(jì)數(shù)器設(shè)置
  • vhost_traffic_status_set_by_filter $requestCounter upstream@alone/10.10.10.11:80/requestCounter
• cacheZones中的命中率計(jì)數(shù)器設(shè)置
• vhost_traffic_status_set_by_filter $cacheHit cache/my_cache_name/cacheHit

vhost_traffic_status_average_method

說明： 設(shè)置計(jì)算響應(yīng)處理時(shí)間平均值的公式和方法夫植。
The period is an effective time of the values used for the average calculation.(Default: 60s)
參數(shù)period用來平均值的有效期(默認(rèn)值: 60s)。
如果period設(shè)置為0油讯，則忽略有效時(shí)間详民。在這種情況下，即使沒有請(qǐng)求并且經(jīng)過一段時(shí)間后陌兑，也會(huì)顯示最后的平均值沈跨。
在JSON中，對(duì)應(yīng)的值是requestMsec和responseMsec兔综。

• AMM
  • AMMarithmetic mean 是算術(shù)平均數(shù)饿凛。
• WMA
  • WMAweighted moving average 是加權(quán)移動(dòng)平均數(shù)狞玛。

vhost_traffic_status_histogram_buckets

說明： 設(shè)置要在直方圖中使用的觀察桶。
默認(rèn)情況下涧窒，如果不設(shè)置此指令心肪，它將不起作用。
參數(shù)second可以用小數(shù)位表示杀狡，最小值為0.001（1ms）蒙畴。
桶的最大尺寸為32贰镣。如果這個(gè)值不夠呜象，請(qǐng)?jiān)?code>src/ngx_http_vhost_traffic_status_node.h中更改NGX_HTTP_VHOST_TRAFFIC_STATUS_DEFAULT_BUCKET_LEN對(duì)應(yīng)的值。

例如：

• vhost_traffic_status_histogram_buckets 0.005 0.01 0.05 0.1 0.5 1 5 10
  • 觀察桶是[5ms 10ms 50ms 1s 5s 10s]碑隆。
• vhost_traffic_status_histogram_buckets 0.005 0.01 0.05 0.1
  • 觀察桶是[5ms 10ms 50ms 1s]恭陡。

注意： 默認(rèn)情況下，如果不設(shè)置此指令上煤，則直方圖統(tǒng)計(jì)不起作用休玩。
使用指令vhost_traffic_status_dump恢復(fù)的直方圖不受指令vhost_traffic_status_histogram_buckets對(duì)存儲(chǔ)桶的更改的影響。
因此劫狠，在通過vhost_traffic_status_histogram_buckets指令更改存儲(chǔ)桶之前拴疤，必須首先刪除zone或dump文件。
與上面類似独泞，在第一次使用直方圖時(shí)也需要?jiǎng)h除dump文件呐矾。

vhost_traffic_status_bypass_limit

說明： 啟用或禁用繞過vhost_traffic_status_limit指令。
如果啟用此選項(xiàng)懦砂，將繞過限制功能蜒犯。如果通過/status訪問狀態(tài)網(wǎng)頁(yè)，而希望不考慮vhost_traffic_status_limit指令對(duì)它的限制荞膘，則這一點(diǎn)非常有用罚随，使用如下的配置：

http {
    vhost_traffic_status_zone;

    ...

    server {

        ...

        location /status {
            vhost_traffic_status_bypass_limit on;
            vhost_traffic_status_display;
            vhost_traffic_status_display_format html;
        }
    }
}

vhost_traffic_status_bypass_stats

說明： 啟用或禁用繞過vhost_traffic_status。
如果啟用此選項(xiàng)羽资，將繞過流量狀態(tài)統(tǒng)計(jì)功能淘菩。也就是說，它被排除在流量狀態(tài)統(tǒng)計(jì)之外屠升。
如果需要在像/status這樣的狀態(tài)網(wǎng)頁(yè)中忽略請(qǐng)求潮改，可以使用如下的設(shè)置：

http {
    vhost_traffic_status_zone;

    ...

    server {

        ...

        location /status {
            vhost_traffic_status_bypass_stats on;
            vhost_traffic_status_display;
            vhost_traffic_status_display_format html;
        }
    }
}

17、另請(qǐng)參閱

• Stream traffic status

  • nginx-module-sts
  • nginx-module-stream-sts

• Prometheus

  • nginx-vts-exporter

• System protection

  • nginx-module-sysguard

18弥激、待辦事項(xiàng)

19进陡、捐贈(zèng)

License

20、作者

YoungJoo.Kim(???) [vozltx@gmail.com]