Nginx配置nginx-module-vts

用Prometheus进行nginx的监控可以自动的对相关server_name和upstream进行监控，你也可以自定义Prometheus的数据标签，实现对不同机房和不同项目的nginx进行监控。

监控Nginx主要用到以下三个模块：

nginx-module-vts：Nginx的监控模块，能够提供JSON格式的数据产出。

nginx-vts-exporter：主要用于收集Nginx的监控数据，并给Prometheus提供监控接口，默认端口号9913。

Prometheus：监控Nginx-vts-exporter提供的Nginx数据，并存储在时序数据库中，可以使用PromQL对时序数据进行查询和聚合。

nginx-module-vts模块的编译

nginx_vts_exporter依赖nginx-module-vts模块，安装此模块无需任何其他依赖。

现网nging需重新编译，步骤如下：

1、查看当前编译参数：

#执行：
cd /usr/local/nginx/
sbin/nginx -V
#结果如下（例）：
nginx version: nginx/1.10.1
built by gcc 4.4.7 20120313 (Red Hat 4.4.7-17) (GCC) 
built with OpenSSL 1.0.1e-fips 11 Feb 2013
TLS SNI support enabled
configure arguments: --prefix=/usr/local/nginx --with-pcre=/home/soft/pcre-8.36/ --with-http_ssl_module --with-http_stub_status_module

2、在nginx编译时添加vts模块

软件包存放在/home/soft下，因此编译时加入/home/soft/nginx-module-vts-master/

具体如下：

# 找到nginx源码存放路径/home/soft/nginx-1.10.1，重新编译：

cd /home/soft/nginx-1.10.1
./configure --prefix=/usr/local/nginx --with-pcre=/home/soft/pcre-8.36/ --with-http_ssl_module --with-http_stub_status_module --add-module=/home/soft/nginx-module-vts-master/

#编译执行完成后，确认结果中存在
adding module in /home/soft/nginx-module-vts-master/
 + ngx_http_vhost_traffic_status_module was configured

 表示configure正确

# 执行编译
make

# make完成后，备份并替换现网的nginx可执行文件

cd /usr/local/nginx/sbin
cp nginx nginx.bak
cp /home/soft/nginx-1.10.1/objs/nginx ./

Nginx编译后，新的二进制文件会存放在objs目录下

Nginx配置

更改Nginx Conf的配置，添加监控接口/status/：

        location /status {
            vhost_traffic_status_display;
            vhost_traffic_status_display_format html;
        }

监控数据的查看

安装完vts模块后，可以通过nginx status接口进行监控数据的查看，比如：http://127.0.0.1:90/status：

在页面的最下方可以指定监控页面刷新的时间间隔，点击JSON，可以转为JSON格式输出。

nginx-vts-exporter的使用

exporter的安装参考https://www.sumaott.com/doc/static/pms/index.html

Nginx的监控数据类型

nginx-vts-exporter的数据类型命名空间默认以“nginx”开头，主要有如下9个：

HELP是对监控条目的解释，TYPE的格式是监控条目名称+Prometheus数据类型

# HELP nginx_server_bytes request/response bytes
# TYPE nginx_server_bytes counter
# HELP nginx_server_cache cache counter
# TYPE nginx_server_cache counter
# HELP nginx_server_connections nginx connections# TYPE nginx_server_connections gauge
# HELP nginx_server_requestMsec average of request processing timesin milliseconds
# TYPE nginx_server_requestMsec gauge
# HELP nginx_server_requests requests counter，可以区分状态码

# TYPE nginx_server_requests counter
# HELP nginx_upstream_bytes request/response bytes
# TYPE nginx_upstream_bytes counter
# HELP nginx_upstream_requestMsec average of request processing timesin milliseconds
# TYPE nginx_upstream_requestMsec gauge
# HELP nginx_upstream_requests requests counter，可以区分状态码
# TYPE nginx_upstream_requests counter
# HELP nginx_upstream_responseMsec average of only upstream/backend response processing timesin milliseconds
# TYPE nginx_upstream_responseMsec gauge

Nginx监控在Prometheus的数据汇总

常用监控汇总表达式：

DomainName对应nginx conf里的server_name，这里可以根据不同的server_name和upstream分别进行qps、2xx/3xx/4xx/5xx的状态码监控，另外也可以监控nginx每台后端server的qps和后端接口响应时间。

如果不需要区分server_name，可以把表达式里的$DomainName改为星号，“*****”代表所有；
求Nginx的QPS：
sum(irate(nginx_server_requests{code="total",host=~"$DomainName"}[5m]))

求4xx万分率（5xx类似，code=“5xx”）：
(sum(irate(nginx_server_requests{code="4xx",host=~"$DomainName"}[5m])) / sum(irate(nginx_server_requests{code="total",host=~"$DomainName"}[5m]))) * 10000

求upstream的QPS(示例求group1的qps):
sum(irate(nginx_upstream_requests{code="total",upstream="group1"}[5m]))

求upstream后端server的响应时间（示例求group1的后端响应时间）：
nginx_upstream_responseMsec{upstream=“group1”}