文档中心>Prometheus 监控服务>接入指南>Exporters 接入>Nginx Ingress Controller Exporter 接入

Nginx Ingress Controller Exporter 接入

最近更新时间:2025-07-28 09:35:32

我的收藏

操作场景

在使用 Nginx Ingress Controller 过程中需要对 Nginx Ingress Controller 运行状态进行监控,以便了解 Nginx Ingress Controller 服务是否运行正常,排查 Nginx Ingress Controller 故障等。Prometheus 监控服务提供基于 Exporter 的方式来监控 Nginx Ingress Controller 运行状态,并提供了开箱即用的 Grafana 监控大盘。本文为您介绍如何使用 Prometheus 监控服务 Nginx Ingress Controller。

接入方式

方式一:一键安装(TKE Nginx Ingress)

操作步骤

2. 在实例列表中,选择对应的 Prometheus 实例。
3. 进入实例详情页,选择数据采集 > 集成中心
4. 在集成中心找到并单击 Nginx Ingress Controller,即会弹出一个安装窗口,在安装页面填写集成名称,选取待监控的 nginx-ingress controller 所在的集群以及它的实例名,然后单击保存


配置说明

名称
描述
名称
集成名称,命名规范如下:
名称具有唯一性。
名称需要符合下面的正则:'^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$'。
集群
选取待监控的 nginx-ingress controller 所在的集群
实例
选取待监控的 nginx-ingress controller 所在的实例名

方式二:自定义安装

说明:
容器服务的 NginxIngress 扩展组件 已于2024年6月停止迭代新版本和新功能,并于2024年10月1日起停止新建 Nginx Ingress 实例。若您仍有 Nginx Ingress 相关需求,建议迁移到自建的 Nginx Ingress,您可以参考 自建 Nginx Ingress 实践教程 系列文档进行迁移。

前提条件

在 Prometheus 实例对应地域及私有网络(VPC)下,创建腾讯云容器服务 Kubernetes 集群,并为集群创建 命名空间
在容器集群中已成功部署自建的 Nginx Ingress。
Prometheus 监控服务控制台,选择对应的 Prometheus 实例,在数据采集 > 集成容器服务中找到对应容器集群完成关联集群操作。可参见指引 关联集群

操作步骤

步骤1:确认 Nginx Ingress 暴露指标
1. 用户使用社区提供的 Helm repo 进行安装。需确认 values.yaml 中设置了开启指标的配置项 metrics,具体配置如下:
controller:
metrics:
port: 10254
portName: metrics
2. 用户自行创建 Nginx Ingress 工作负载。
2.1 需在工作负载 ingress-nginx-controller 的端口设置 spec.template.spec.containers[0].ports 中增加以下配置项:
- containerPort: 10254
name: metrics
protocol: TCP
配置完成后的效果如下图所示:

2.2 如果使用 v1.12.0及以上的 ingress-nginx-controller 镜像版本,还需在启动参数中增加开启指标的配置项,需在工作负载 ingress-nginx-controller 的参数设置 spec.template.spec.containers[0].args 中增加配置项 --enable-metrics=true,配置完成后的效果如下图所示:

2.3 重启工作负载 ingress-nginx-controller 以应用最新配置。
步骤2:添加采集任务
1. 登录 Prometheus 控制台,选择对应 Prometheus 实例进入管理页面。
2. 数据采集 > 集成容器服务中选择已经关联的集群,通过数据采集配置 > 新建自定义监控来添加采集配置。
方式一
方式二
通过服务发现添加 PodMonitors 来定义 Prometheus 抓取任务,选择 yaml 编辑 > PodMonitors,填写 yaml 配置后单击确定即可,如下图所示:

YAML 配置示例如下:
apiVersion: monitoring.coreos.com/v1
kind: PodMonitor
metadata:
name: ingress-nginx-monitor # 填写一个唯一名称
namespace: prom-xxxxxxxx # 可填prometheus实例ID对应的namespace,也可填写ingress-nginx-controller所在的namespace
spec:
podMetricsEndpoints:
- interval: 30s
port: metrics # 填写步骤一values.yaml中metrics对应的portName
path: /metrics
honorLabels: true
relabelings:
- action: labeldrop
regex: endpoint
namespaceSelector: # 选择要监控的ingress-nginx-controller pod所在的namespace
matchNames:
- ingress-nginx
selector: # 填写要监控pod的Label值,以定位目标pod
matchLabels:
app.kubernetes.io/name: ingress-nginx
app.kubernetes.io/component: controller
通过控制台的页面编辑能力添加 Prometheus 原生采集配置,选择页面编辑,根据提示填充各配置项。配置完成后单击保存即可,具体示例如下:
监控类型选择 PodMonitors。
采集任务填写一个唯一名称。
命名空间选择 ingress-nginx-controller 所在的命名空间。
工作负载类型选择 ingress-nginx-controller 的负载类型。
工作负载选择 ingress-nginx-controller 的负载名称。
targetPort 填写步骤一中设置的端口号数字。
metricsPath 保持为 /metrics。

步骤3:验证
1. 在当前 Prometheus 实例,在数据采集 > 集成容器服务中选择对应集群,通过数据采集配置 > 自定义监控来查看采集配置。
2. 找到步骤二中添加的采集配置(二者选其一即可),查看指标采集速率是否大于0,Targets 是否与 ingress-nginx-controller pod 数量一致且均为 up 状态,如下图所示:

3. 单击采集配置对应的指标明细,可查看指标的采集详情,检查指标列表中包含以 nginx_ingress 为前缀的指标即可,如下图所示:


查看监控

前提条件

Prometheus 实例已绑定 Grafana 实例。

操作步骤

1. 登录 腾讯云可观测平台 Prometheus 控制台,选择对应 Prometheus 实例进入管理页面。
2. 在实例基本信息页面,找到绑定的 Grafana 地址,打开并登录,然后在 middleware 文件夹中找到 nginx-ingress 相关面板,即可观察上述 ingress-nginx-controller 的 dashboards,如下图所示:

截屏2024-03-19 14.25.09.png


NGINX Ingress controller

截屏2024-03-13 19.23.27.png


Request Handling Performance

截屏2024-03-13 19.23.38.png