nginx 集成会收集连接指标和访问日志。连接指标可捕获连接的当前状态:活动、读取或等待。系统会根据连接详情解析访问日志,其中包括映射到请求、客户端、服务器和消息的字段。
如需详细了解 nginx,请参阅 nginx 文档。
前提条件
如需收集 nginx 遥测数据,您必须安装 Ops Agent:
- 对于指标,请安装 2.1.0 版或更高版本。
- 对于日志,请安装 2.1.0 版或更高版本。
此集成支持 nginx 1.18 和 1.20 版。
配置您的 nginx 实例
您必须在 nginx 配置文件中启用 stub_status
模块,以设置在本地可访问的网址,例如,为状态页面设置 http://www.example.com/nginx_status
。如需启用 stub_status
模块,请完成以下步骤:
修改
status.conf
文件,如果尚不存在,请创建该文件。您可以在 nginx 配置目录中找到此文件,通常位于/etc/nginx/conf.d
。将以下行添加到
server
部分中:location /nginx_status { stub_status on; access_log off; allow 127.0.0.1; deny all; }
您的配置文件可能类似于以下示例:
server { listen 80; server_name 127.0.0.1; location /nginx_status { stub_status on; access_log off; allow 127.0.0.1; deny all; } location / { root /dev/null; } }
重新加载 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 /nginx_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/nginx_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 的遥测数据,并重启 Ops Agent。
配置日志收集
如需从 nginx 注入日志,您必须为 nginx 生成的日志创建接收器,然后为新的接收器创建流水线。
如需为 nginx_access
日志配置接收器,请指定以下字段:
字段 | 默认值 | 说明 |
---|---|---|
exclude_paths |
要从 include_paths 匹配的集合中排除的文件系统路径模式列表。 |
|
include_paths |
[/var/log/nginx/access.log] |
要通过对每个文件执行 tail 来读取的文件系统路径列表。路径中可以使用通配符 (* )。 |
record_log_file_path |
false |
如果设置为 true ,则从中获取日志记录的特定文件的路径将作为 agent.googleapis.com/log_file_path 标签的值显示在输出日志条目中。使用通配符时,系统只会记录从中获取记录的文件的路径。 |
type |
该值必须为 nginx_access 。 |
|
wildcard_refresh_interval |
60s |
include_paths 中通配符文件路径的刷新间隔。指定为时长,例如 30s 或 2m 。该属性在高日志记录吞吐量下可能很有用,因为日志文件的轮替速度快于默认时间间隔。 |
如需为 nginx_error
日志配置接收器,请指定以下字段:
字段 | 默认值 | 说明 |
---|---|---|
exclude_paths |
要从 include_paths 匹配的集合中排除的文件系统路径模式列表。 |
|
include_paths |
[/var/log/nginx/error.log] |
要通过对每个文件执行 tail 来读取的文件系统路径列表。路径中可以使用通配符 (* )。 |
record_log_file_path |
false |
如果设置为 true ,则从中获取日志记录的特定文件的路径将作为 agent.googleapis.com/log_file_path 标签的值显示在输出日志条目中。使用通配符时,系统只会记录从中获取记录的文件的路径。 |
type |
该值必须为 nginx_error 。 |
|
wildcard_refresh_interval |
60s |
include_paths 中通配符文件路径的刷新间隔。指定为时长,例如 30s 或 2m 。该属性在高日志记录吞吐量下可能很有用,因为日志文件的轮替速度快于默认时间间隔。 |
记录的内容
logName
派生自配置中指定的接收器 ID。LogEntry
中的详细字段如下所示。
nginx_access
日志包含 LogEntry
中的以下字段:
字段 | 类型 | 说明 |
---|---|---|
httpRequest |
对象 | 参见HttpRequest |
jsonPayload.host |
字符串 | Host 标头的内容(通常 nginx 不会报告) |
jsonPayload.level |
字符串 | 日志条目级别 |
jsonPayload.user |
字符串 | 请求经过身份验证的用户名 |
severity |
字符串 (LogSeverity ) |
日志条目级别(已转换)。 |
nginx_error
日志包含 LogEntry
中的以下字段:
字段 | 类型 | 说明 |
---|---|---|
jsonPayload.client |
字符串 | 客户端 IP 地址(可选) |
jsonPayload.connection |
数字 | 连接 ID |
jsonPayload.host |
字符串 | 主机标头(可选) |
jsonPayload.level |
字符串 | 日志条目级别 |
jsonPayload.message |
字符串 | 日志消息 |
jsonPayload.pid |
数字 | 发出日志的进程 ID |
jsonPayload.referer |
字符串 | Referer 标头(可选) |
jsonPayload.request |
字符串 | 原始 HTTP 请求(可选) |
jsonPayload.server |
字符串 | Nginx 服务器名称(可选) |
jsonPayload.subrequest |
字符串 | Nginx 子请求(可选) |
jsonPayload.tid |
数字 | 日志源自的线程 ID |
jsonPayload.upstream |
字符串 | 上游请求 URI(可选) |
severity |
字符串 (LogSeverity ) |
日志条目级别(已转换)。 |
配置指标收集
如需从 nginx 注入指标,您必须为 nginx 生成的指标创建接收器,然后为新的接收器创建流水线。
此接收器不支持在配置中使用多个实例,例如,监控多个端点。所有这些实例都会写入相同的时序,并且 Cloud Monitoring 无法区分它们。
如需为 nginx
指标配置接收器,请指定以下字段:
字段 | 默认值 | 说明 |
---|---|---|
collection_interval |
60s |
时长值,例如 30s 或 5m 。 |
server_status_url |
http://localhost/status |
由 nginx 存根状态模块公开的网址。 |
type |
该值必须为 nginx 。 |
监控的内容
下表提供了 Ops Agent 从 nginx 实例收集的指标列表。
指标类型 | |
---|---|
种类、类型 受监控的资源 |
标签 |
workload.googleapis.com/nginx.connections_accepted
|
|
CUMULATIVE 、INT64 gce_instance |
|
workload.googleapis.com/nginx.connections_current
|
|
GAUGE 、INT64 gce_instance |
state
|
workload.googleapis.com/nginx.connections_handled
|
|
CUMULATIVE 、INT64 gce_instance |
|
workload.googleapis.com/nginx.requests
|
|
CUMULATIVE 、INT64 gce_instance |
验证配置
本部分介绍如何验证您是否正确配置了 nginx 接收器。Ops Agent 可能需要一两分钟才会开始收集遥测数据。
如需验证 nginx 日志是否已发送到 Cloud Logging,请执行以下操作:
-
在 Google Cloud 控制台中,转到 Logs Explorer 页面。
如果您使用搜索栏查找此页面,请选择子标题为 Logging 的结果。
- 在编辑器中输入以下查询,然后点击运行查询:
resource.type="gce_instance" (log_id("nginx_access") OR log_id("nginx_error"))
如需验证 nginx 指标是否已发送到 Cloud Monitoring,请执行以下操作:
-
在 Google Cloud 控制台中,转到 leaderboard Metrics Explorer 页面:
如果您使用搜索栏查找此页面,请选择子标题为监控的结果。
- 在查询构建器窗格的工具栏中,选择名为 code MQL 或 code MQL 的按钮。
- 验证已在MQL切换开关中选择 MQL。语言切换开关位于同一工具栏中,用于设置查询的格式。
- 在编辑器中输入以下查询,然后点击运行查询:
fetch gce_instance | metric 'workload.googleapis.com/nginx.requests' | every 1m
查看信息中心
如需查看 nginx 指标,您必须配置一个图表或信息中心。 nginx 集成服务可为您提供一个或多个信息中心。在您配置集成并且 Ops Agent 开始收集指标数据后,所有信息中心都会自动安装。
您还可以在不安装集成的情况下查看信息中心的静态预览。
如需查看已安装的信息中心,请执行以下操作:
-
在 Google Cloud 控制台中,转到 信息中心页面:
如果您使用搜索栏查找此页面,请选择子标题为监控的结果。
- 选择信息中心列表标签页,然后选择集成类别。
- 点击您要查看的信息中心的名称。
如果您已配置集成,但尚未安装信息中心,请检查 Ops Agent 是否正在运行。如果信息中心内没有图表的指标数据,则信息中心的安装将失败。Ops Agent 开始收集指标后,系统会为您安装信息中心。
如需查看信息中心的静态预览,请执行以下操作:
-
在 Google Cloud 控制台中,转到 集成页面:
如果您使用搜索栏查找此页面,请选择子标题为监控的结果。
- 点击 Compute Engine 部署平台过滤条件。
- 找到 nginx 的条目,然后点击查看详细信息。
- 选择信息中心标签页以查看静态预览。如果信息中心已安装,您可以通过点击查看信息中心来转到信息中心。
如需详细了解 Cloud Monitoring 中的信息中心,请参阅信息中心和图表。
如需详细了解如何使用集成页面,请参阅管理集成。
安装提醒政策
提醒政策会指示 Cloud Monitoring 在满足指定条件时通知您。 nginx 集成包含一项或多项提醒政策供您使用。您可以从 Monitoring 中的集成页面查看和安装这些提醒政策。
如需查看可用提醒政策的说明并安装它们,请执行以下操作:
-
在 Google Cloud 控制台中,转到 集成页面:
如果您使用搜索栏查找此页面,请选择子标题为监控的结果。
- 找到 nginx 的条目,然后点击查看详细信息。
- 选择提醒标签页。此标签页提供可用提醒政策的说明,并提供一个安装政策的界面。
- 安装提醒政策。提醒政策需要知道将提醒触发的通知发送到何处,因此它们需要您提供信息才能进行安装。如需安装提醒政策,请执行以下操作:
- 从可用提醒政策列表中,选择您要安装的提醒政策。
在配置通知部分中,选择一个或多个通知渠道。您可以选择禁止使用通知渠道,但如果您这样做,则您的提醒政策将以静默方式触发。您可以在 Monitoring 中查看其状态,但不会收到通知。
如需详细了解通知渠道,请参阅管理通知渠道。
- 点击创建政策。
如需详细了解 Cloud Monitoring 中的提醒政策,请参阅提醒简介。
如需详细了解如何使用集成页面,请参阅管理集成。
问题排查
对于大多数发行版,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。
后续步骤
如需查看有关如何使用 Ansible 安装 Ops Agent、配置第三方应用和安装示例信息中心的演示,请观看安装 Ops Agent 以排查第三方应用的问题视频。