Nginx

·

NGINX 采集器可以从 NGINX 实例中采取很多指标，比如请求总数连接数、缓存等多种指标，并将指标采集到观测云，帮助监控分析 NGINX 各种异常情况。

配置¶

前置条件¶

• NGINX 版本 >= 1.8.0; 已测试的版本：

  • 1.23.2
  • 1.22.1
  • 1.21.6
  • 1.18.0
  • 1.14.2
  • 1.8.0

• NGINX 默认采集 http_stub_status_module 模块的数据，开启 http_stub_status_module 模块参见这里，开启了以后会上报 NGINX 指标集的数据；

• 如果您正在使用 VTS 或者想监控更多数据，建议开启 VTS 相关数据采集，可在 nginx.conf 中将选项 use_vts 设置为 true。如何开启 VTS 参见这里;

• 开启 VTS 功能后，能产生如下指标集：

  • nginx
  • nginx_server_zone
  • nginx_upstream_zone (NGINX 需配置 upstream 相关配置)
  • nginx_cache_zone (NGINX 需配置 cache 相关配置)

• 以产生 nginx_upstream_zone 指标集为例，NGINX 相关配置示例如下：

...
http {
   ...
   upstream your-upstreamname {
     server upstream-ip:upstream-port;
  }
   server {
   ...
   location / {
   root  html;
   index  index.html index.htm;
   proxy_pass http://yourupstreamname;
}}}

• 已经开启了 VTS 功能以后，不必再去采集 http_stub_status_module 模块的数据，因为 VTS 模块的数据会包括 http_stub_status_module 模块的数据

• NGINX Plus 用户仍可以使用 http_stub_status_module 采集基础数据，同时需要在 NGINX 配置文件中开启 http_api_module 模块 (参考)，并在想要监控的 server 中设置 status_zone，配置示例如下：

# 开启 http_api_module
server {
  listen 8080;
  location /api {
     api write=on;
  }
}
# 监控更多指标
server {
  listen 80;
  status_zone <ZONE_NAME>;
  ...
}

• 开启 NGINX Plus 采集需要在 nginx.conf 中将选项 use_plus_api 设置为 true，并将 plus_api_url 的注释去除。（注意， VTS 功能暂不支持 NGINX Plus）

• NGINX Plus 额外产生如下指标集：

  • nginx_location_zone

采集器配置¶

[[inputs.nginx]]
  ## Nginx status URL.
  ## (Default) If not use with VTS, the formula is like this: "http://localhost:80/basic_status".
  ## If using with VTS, the formula is like this: "http://localhost:80/status/format/json".
  url = "http://localhost:80/basic_status"
  # If using Nginx Plus, this formula is like this: "http://localhost:8080/api/<api_version>".
  # Note: Nginx Plus not support VTS and should be used with http_stub_status_module (Default)
  # plus_api_url = "http://localhost:8080/api/9"

  ## Optional Can set ports as [<form>,<to>], Datakit will collect all ports.
  # ports = [80,80]

  ## Optional collection interval, default is 10s
  # interval = "30s"
  use_vts = false
  use_plus_api = false
  ## Optional TLS Config
  # tls_ca = "/xxx/ca.pem"
  # tls_cert = "/xxx/cert.cer"
  # tls_key = "/xxx/key.key"
  ## Use TLS but skip chain & host verification
  insecure_skip_verify = false
  ## HTTP response timeout (default: 5s)
  response_timeout = "20s"

  ## Set true to enable election
  election = true

# [inputs.nginx.log]
  # files = ["/var/log/nginx/access.log","/var/log/nginx/error.log"]
  ## grok pipeline script path
  # pipeline = "nginx.p"
# [inputs.nginx.tags]
  # some_tag = "some_value"
  # more_tag = "some_other_value"

指标¶

以下所有数据采集，默认会追加全局选举 tag，也可以在配置中通过 [inputs.nginx.tags] 指定其它标签：

[inputs.nginx.tags]
 # some_tag = "some_value"
 # more_tag = "some_other_value"
 # ...

nginx¶

• 标签

• 指标列表

nginx_server_zone¶

• 标签

• 指标列表

nginx_upstream_zone¶

• 标签

• 指标列表

nginx_cache_zone¶

• 标签

• 指标列表

nginx_location_zone¶

• 标签

• 指标列表

自定义对象¶

日志¶

如需采集 NGINX 的日志，可在 nginx.conf 中 将 files 打开，并写入 NGINX 日志文件的绝对路径。比如：

[[inputs.nginx]]
  ...
  [inputs.nginx.log]
    files = ["/var/log/nginx/access.log","/var/log/nginx/error.log"]

开启日志采集以后，默认会产生日志来源（source）为 nginx 的日志。

注意：必须将 DataKit 安装在 NGINX 所在主机才能采集 NGINX 日志。

日志 Pipeline 功能切割字段说明¶

• NGINX 错误日志切割

错误日志文本示例：

2021/04/21 09:24:04 [alert] 7#7: *168 write() to "/var/log/nginx/access.log" failed (28: No space left on device) while logging request, client: 120.204.196.129, server: localhost, request: "GET / HTTP/1.1", host: "47.98.103.73"

切割后的字段列表如下：

错误日志文本示例：

2021/04/29 16:24:38 [emerg] 50102#0: unexpected ";" in /usr/local/etc/nginx/nginx.conf:23

切割后的字段列表如下：

• NGINX 访问日志切割

访问日志文本示例：

127.0.0.1 - - [24/Mar/2021:13:54:19 +0800] "GET /basic_status HTTP/1.1" 200 97 "-" "Mozilla/5.0 (Macintosh; Intel Mac OS X 11_1_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.72 Safari/537.36"

切割后的字段列表如下：