文档

Nginx组件接入

更新时间:

可观测监控 Prometheus 版提供一键安装配置Nginx类型的组件,并提供开箱即用的专属监控大盘。本文介绍旧版Nginx类型组件的安装配置详情。

背景信息

  • 旧版Nginx类型组件安装的是nginx-module-vts模块。

  • 旧版Nginx类型组件采集的Nginx指标如下表所示。

    指标

    类型

    描述

    nginx_server_requests

    Server

    Server请求数

    nginx_server_bytes

    Server

    Server字节数

    nginx_server_cache

    Server

    Server缓存

    nginx_filter_requests

    Filter

    Filter请求数

    nginx_filter_bytes

    Filter

    Filter字节数

    nginx__filter_responseMsec

    Filter

    Filter响应时间

    nginx_upstream_requests

    Upstreams

    上行请求数

    nginx_upstream_bytes

    Upstreams

    上行字节数

    nginx_upstream_responseMsec

    Upstreams

    上行响应时间

前提条件

您已成功安装并运行Nginx服务,之后需要安装nginx-module-vts模块。安装nginx-module-vts模块的具体操作如下。

  1. 下载nginx-module-vts模块。

    说明

    git@github.com:vozlt/nginx-module-vts.git

  2. 编译配置。

    1. 在nginx编译时添加nginx-module-vts模块。

      --add-module=/path/to/nginx-module-vts
    2. 下载官方软件包并编译进nginx-module-vts模块。

      ./configure --user=www --group=www --prefix=/usr/local/nginx --with-http_sysguard_module  --add-module=nginx-module-vts
  3. 安装nginx-module-vts模块。

    make && make install
  4. Nginx配置。更改nginx.conf的配置,并添加监控接口。

    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;
            }
        }
    }

    在配置文件中打开vhost过滤。

    vhost_traffic_status_filter_by_host on
    说明

    开启此功能,当Nginx配置有多个server_name的情况下,系统会根据不同的server_name进行流量的统计,否则默认会把流量全部计算到第一个server_name上。

    若您不需要统计流量的server区域,可以执行如下命令禁用vhost_traffic_status。以下示例中的...部分是省略的内容。

    server {
    ...
    vhost_traffic_status off;
    ...
    }
  5. 验证nginx-module-vts模块是否安装成功。

    curl http://127.0.0.1/status

功能入口

功能入口一:集成中心

  1. 登录ARMS控制台

  2. 在左侧导航栏选择Prometheus监控 > 实例列表,进入可观测监控 Prometheus 版的实例列表页面。

  3. 单击目标Prometheus实例名称,进入集成中心页面。

功能入口二:接入中心

  1. 登录ARMS控制台

  2. 在左侧导航栏单击接入中心,然后在组件应用区域单击Nginx卡片的添加,然后在弹出的页面根据控制台指引完成组件接入。

接入Nginx

这里以从集成中心入口为例,介绍接入Nginx组件的操作,具体步骤如下。

  1. 接入Nginx组件。

    • 若您初次安装Nginx类型的组件:

      在集成中心页面单击未安装区域Nginx组件卡片的安装at

    • 若您已安装Nginx类型的组件,需要再次添加该组件:

      在集成中心页面单击已安装区域Nginx组件卡片的添加

  2. STEP2区域的配置页签配置相关参数,并单击确定,完成组件接入。

    参数

    描述

    Exporter名称

    当前Nginx监控唯一命名。命名规范要求如下:

    • 仅可包含小写字母、数字和短划线(-),且短划线不可出现在开头或结尾。

    • 名称具有唯一性。

    说明

    默认名称由组件类型及数字后缀组成。

    Nginx(旧)地址

    Nginx的连接地址。

    Nginx(旧)端口

    Nginx的端口号,例如:80。

    重要
    • 您需要先安装Nginx的监控模块nginx-module-vts:Nginx virtual host traffic status module,此模块可以提供JSON格式的数据产出。

    • STEP2区域的指标页签可查看监控指标。

    已接入的组件会显示在集成中心页面的已安装区域。单击该组件卡片,在弹出的面板中可以查看Targets、指标、大盘、告警、服务发现配置、Exporter等信息。集成中心的更多信息,请参见集成中心

  • 本页导读 (1)
文档反馈