nginx

nginx 是一个开源的免费高性能 HTTP 服务器和反向代理,也是一个 IMAP/POP3 代理服务器。如需了解详情,请访问 nginx.org

nginx 接收器可以从 nginx 实例收集和注入日志和指标。

前提条件

如需收集和注入 nginx 日志和指标,您必须安装 Ops Agent 2.1.0 或更高版本。

配置您的 nginx 实例

您必须在 nginx 配置文件中启用 stub_status 模块,以设置在本地可访问的网址,例如,为状态页面设置 http://www.example.com/status。如需启用 stub_status 模块,请完成以下步骤:

  1. 修改 status.conf 文件,如果尚不存在,请创建该文件。您可以在 nginx 配置目录中找到此文件,通常位于 /etc/nginx/conf.d

  2. 将以下行添加到 server 部分中:

    location /status {
        stub_status on;
        access_log off;
        allow 127.0.0.1;
        deny all;
    }
    

    您的配置文件可能类似于以下示例:

    server {
       listen 80;
       server_name 127.0.0.1;
       location /status {
           stub_status on;
           access_log off;
           allow 127.0.0.1;
           deny all;
       }
       location / {
           root /dev/null;
       }
    }
    
  3. 重新加载 nginx 配置。

    sudo service nginx reload
    

您可以运行以下命令来自动执行上述步骤。如果文件不存在,则会创建一个 status.conf 文件;如果文件已存在,则会覆盖现有文件。该命令会启用 stub_status、重新加载 nginx,并验证通过端点公开预期的信息。

sudo tee /etc/nginx/conf.d/status.conf > /dev/null << EOF
server {
    listen 80;
    server_name 127.0.0.1;
    location /status {
        stub_status on;
        access_log off;
        allow 127.0.0.1;
        deny all;
    }
    location / {
       root /dev/null;
    }
}
EOF
sudo service nginx reload
curl http://127.0.0.1:80/status

示例输出如下所示:

Active connections: 1
server accepts handled requests
 23 23 74
Reading: 0 Writing: 1 Waiting: 0

或者,您也可以将这些行直接嵌入到主 nginx.conf 文件(通常位于下列某个目录)中,而不是使用单独的 status.conf 文件:/etc/nginx/usr/local/nginx/conf/usr/local/etc/nginx

为 nginx 配置 Ops Agent

按照配置 Ops Agent 指南,添加从 nginx 实例收集日志和指标所需的元素并重启代理

配置示例

以下命令会创建配置文件,以收集和注入 nginx 的日志和指标,并在 Linux 上重启 Ops Agent。

sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
logging:
  receivers:
    nginx_default_access:
      type: nginx_access
    nginx_default_error:
      type: nginx_error
  service:
    pipelines:
      nginx:
        receivers:
          - nginx_default_access
          - nginx_default_error
metrics:
  receivers:
    nginx_metrics:
      type: nginx
      stub_status_url: http://127.0.0.1:80/status
      collection_interval: 60s
  service:
    pipelines:
      nginx_pipeline:
        receivers:
          - nginx_metrics
EOF
sudo service google-cloud-ops-agent restart

配置日志收集

如需从 nginx 中提取日志,您必须为 nginx 生成的日志创建接收器,然后为新的接收器创建流水线。如需为 nginx_access 日志配置接收器,请指定以下字段:

字段 默认 说明
type 该值必须为 nginx_access
include_paths [/var/log/nginx/access.log] 要读取的日志文件。
exclude_paths 如果 include_paths 包含 glob 或目录,则该字段为要排除的日志文件。
wildcard_refresh_interval 1m0s include_paths 中通配符文件路径的刷新间隔。指定为时长,例如 30s2m。该属性在高日志记录吞吐量下可能很有用,因为日志文件的轮替速度快于默认时间间隔。


如需为 nginx_error 日志配置接收器,请指定以下字段:

字段 默认 说明
type 该值必须为 nginx_error
include_paths [/var/log/nginx/error.log] 要读取的日志文件。
exclude_paths 如果 include_paths 包含 glob 或目录,则该字段为要排除的日志文件。
wildcard_refresh_interval 1m0s include_paths 中通配符文件路径的刷新间隔。指定为时长,例如 30s2m。该属性在高日志记录吞吐量下可能很有用,因为日志文件的轮替速度快于默认时间间隔。

记录的内容

nginx_accessnginx_error 日志的 logName 衍生自配置中指定的接收器 ID。LogEntry 中的详细字段如下所示。

nginx_access 日志包含 httpRequest 字段

字段 类型 说明
httpRequest.protocol 字符串 用于请求的协议
httpRequest.referer 字符串 Referer 标头的内容
httpRequest.remoteIp 字符串 客户端 IP 地址
httpRequest.requestMethod 字符串 HTTP 方法
httpRequest.requestUrl 字符串 请求网址(通常只是网址的路径部分)
httpRequest.responseSize 字符串 (int64) 响应大小
httpRequest.status 数字 HTTP 状态代码
httpRequest.userAgent 字符串 User-Agent 标头的内容
jsonPayload.host 字符串 Host 标头的内容(通常 nginx 不会报告)
jsonPayload.user 字符串 请求经过身份验证的用户名
timestamp 字符串 (Timestamp) 收到请求的时间

日志条目不包含任何空白字段或缺失字段。


nginx_error 日志包含 LogEntry 中的以下字段:

字段 类型 说明
jsonPayload.level 字符串 日志条目级别
jsonPayload.pid 数字 进程 ID
jsonPayload.tid 数字 线程 ID
jsonPayload.connection 数字 连接 ID
jsonPayload.message 字符串 日志消息
jsonPayload.client 字符串 客户端 IP 地址(可选)
jsonPayload.server 字符串 Nginx 服务器名称(可选)
jsonPayload.request 字符串 原始 HTTP 请求(可选)
jsonPayload.subrequest 字符串 Nginx 子请求(可选)
jsonPayload.upstream 字符串 上游请求 URI(可选)
jsonPayload.host 字符串 主机标头(可选)
jsonPayload.referer 字符串 Referer 标头(可选)
severity 字符串 (LogSeverity) 日志条目级别(已转换)
timestamp 字符串 (Timestamp) 记录条目的时间

配置指标收集

如需从 nginx 收集指标,您必须为 nginx 指标创建接收器,然后为新接收器创建流水线。如需为 nginx 指标配置接收器,请指定以下字段:

字段 默认 说明
type 该值必须为 nginx
stub_status_url http://localhost/status 由 nginx 存根状态模块公开的网址。
collection_interval 60s time.Duration 值,例如 30s5m

监控的内容

下表提供了 Ops Agent 从 nginx 实例收集的指标列表。

指标类型
种类、类型
受监控的资源
标签
workload.googleapis.com/nginx.requests
CUMULATIVEINT64
gce_instance
 
workload.googleapis.com/nginx.connections_accepted
CUMULATIVEINT64
gce_instance
 
workload.googleapis.com/nginx.connections_handled
CUMULATIVEINT64
gce_instance
 
workload.googleapis.com/nginx.connections_current
GAUGEINT64
gce_instance
state

示例信息中心

您可以使用示例 Cloud Monitoring 信息中心查看集成中的指标。完成安装示例信息中心过程,从示例库中导入 Nginx 概览信息中心并查看显示您的 nginx 指标的图表。

验证配置

您可以使用日志浏览器和 Metrics Explorer 来验证已正确配置 nginx 接收器。Ops Agent 可能需要一两分钟才会开始收集日志和指标。

如需验证是否已注入日志,请转到日志浏览器并运行以下查询来查看 nginx 日志:

resource.type="gce_instance"
logName=("projects/PROJECT_ID/logs/nginx_default_error" OR "projects/PROJECT_ID/logs/nginx_default_access")


如需验证指标是否已注入,请转到 Metrics Explorer 并在 MQL 标签页中运行以下查询。

fetch gce_instance
| metric 'workload.googleapis.com/nginx.requests'
| align rate(1m)
| every 1m

问题排查

对于大多数发行版,nginx 启用了 ngx_http_stub_status_module。您可以通过运行以下命令来检查是否已启用该模块:

sudo nginx -V 2>&1 | grep -o with-http_stub_status_module

预期输出为 with-http_stub_status_module,表示该模块已启用。在极少数情况下,如果该命令未返回输出,您必须按照 nginx 公开文档,使用 -with-http_stub_status_module 从源代码编译 nginx。