跳到主要内容

监控nginx

前言​

首先nginx需要编译第三方模块nginx-module-vts，然后通过nginx-vts-exporter提供metrics，接着Prometheus收集nginx-vts-exporter提供的merics即可。

编译nginx​

仓库地址为：https://github.com/vozlt/nginx-module-vts

这个第三方模块有nginx版本依赖限制，建议参考文档下载对应的nginx版本。这里使用nginx 1.22作为测试

  1. 克隆仓库
git clone --depth=1 --single-branch https://github.com/vozlt/nginx-module-vts.git /tmp/nginx-module-vts
  1. 安装依赖
# yum
yum -y install gcc pcre-devel zlib-devel openssl-devel libxml2-devel libxslt-devel gd-devel GeoIP-devel jemalloc-devel libatomic_ops-devel perl-devel perl-ExtUtils-Embeb

# apt
apt install -y libpcre3-dev openssl libssl-dev libxml2-dev libgd-dev libxml2 libgeoip-dev libxslt-dev
  1. 预编译。这里加了很多编译参数，可根据实际需求修改，主要的编译参数是--add-module=/tmp/nginx-module-vts
./configure --with-threads \
    --with-file-aio \
    --with-http_ssl_module \
    --with-http_v2_module \
    --with-http_realip_module \
    --with-http_addition_module \
    --with-http_xslt_module=dynamic \
    --with-http_image_filter_module=dynamic \
    --with-http_geoip_module=dynamic \
    --with-http_sub_module \
    --with-http_dav_module \
    --with-http_flv_module \
    --with-http_mp4_module \
    --with-http_gunzip_module \
    --with-http_gzip_static_module \
    --with-http_auth_request_module \
    --with-http_random_index_module \
    --with-http_secure_link_module \
    --with-http_degradation_module \
    --with-http_slice_module \
    --with-http_stub_status_module \
    --with-stream \
    --with-stream_ssl_module \
    --with-stream_realip_module \
    --with-stream_geoip_module=dynamic \
    --with-stream_ssl_preread_module \
    --with-compat \
    --with-pcre-jit \
    --add-module=/tmp/nginx-module-vts \
    --prefix=/home/atlas/apps/nginx-vts
  1. 编译及安装。如果是更新nginx，就不要make install了，make后将编译结果更新到原先nginx路径即可。

修改nginx配置​

常用配置参数如下，更多配置参数可查看nginx-module-vts的文档。

http {
    vhost_traffic_status_zone;
    vhost_traffic_status_filter_by_host on;
	# ...
	server {
	# ...
	    location /status {
             vhost_traffic_status_display;
             vhost_traffic_status_display_format html;
        }
	}
	# ...
}

启动nginx后，访问/status路由即可看到包含nginx状态信息的页面

部署nginx-vts-exporter​

代码仓库为https://github.com/hnlq715/nginx-vts-exporter

先从代码仓库的release下载二进制文件的压缩包并解压到服务器，指定nginx vts的路由来启动

./nginx-vtx-exporter -telemetry.address=":19094" -nginx.scrape_uri="http://127.0.0.1:8001/status/format/json"

配置Prometheus​

prometheus.yml

# ...
scrape_configs:
  - job_name: "nginx"
    file_sd_configs:
    - files: ['/home/atlas/apps/prometheus/prometheus/sd_configs/nginx/*.yaml']
      refresh_interval:  10s

/home/atlas/apps/prometheus/prometheus/sd_configs/nginx/target.yaml

- targets: ['192.168.1.112:19094']
  labels:
    instance: 192.168.1.112

配置grafana​

nginx-vts-exporter的代码仓库中附带了一个dashboard的json，测试可直接导入到grafana中使用。

补充​

nginx-vts-exporter的启动脚本​

#!/bin/bash

set -u

script_dir=$(cd $(dirname $0) && pwd)
port=19094
app_name="nginx-vtx-exporter"
nginx_scrape_uri="http://127.0.0.1:8001/status/format/json"

check_env() {
    timeout 1 bash -c "cat < /dev/null > /dev/tcp/127.0.0.1/${port}" > /dev/null 2>&1
    if [ $? -eq 0 ]; then
        echo "port ${port} has been used"
        exit 1
    fi
}

start_app() {
    check_env
    nohup ${script_dir}/${app_name} \
        -nginx.scrape_uri=${nginx_scrape_uri} \
        -telemetry.address=":${port}" > /dev/null 2>&1 &
    echo "start ${app_name} called"
}

stop_app() {
	local pid=$(ps -ef | grep -v grep | grep "${script_dir}/${app_name}" | awk '{print $2}')
	if [ x"${pid}" == x ]; then
		echo "${script_dir}/${app_name} is not runnning"
		exit 0
	fi
	kill ${pid}
	echo "stop ${app_name} called"
}

status_app() {
	ps -ef | grep -v grep | grep "${script_dir}/${app_name}"
	if [ $? -ne 0 ]; then
		echo "${script_dir}/${app_name} is not runnning"
		exit 0
	fi
	echo "status ${app_name} called"
}

main() {
    case $1 in
    	start)
    		start_app
    		;;
    	stop)
    		stop_app
    		;;
    	status)
    		status_app
    		;;
    	*)
    		echo "Available options: start | stop | status"
    esac
}

main $@