Ingress NGINX Controller

本文說明如何設定 Google Kubernetes Engine 部署作業，以便使用 Google Cloud Managed Service for Prometheus 從 Ingress NGINX 控制器收集指標。本文將說明如何執行下列操作：

• 設定 Ingress NGINX，回報指標。
• 設定 Managed Service for Prometheus 的 PodMonitoring 資源，以收集匯出的指標。
• 在 Cloud Monitoring 中存取資訊主頁，即可查看指標。
• 設定快訊規則來監控指標。

只有在使用 Managed Service for Prometheus 的 代管收集作業時，才適用這些操作說明。如果您使用自行部署的收集功能，請參閱 Ingress NGINX 說明文件，瞭解安裝資訊。

這些操作說明僅供參考，適用於大多數 Kubernetes 環境。 如果因安全或機構政策限制而無法安裝應用程式或匯出工具，建議您參閱開放原始碼文件尋求支援。

如要瞭解 Ingress NGINX 控制器，請參閱「Ingress NGINX」。

必要條件

如要使用 Managed Service for Prometheus 和代管收集作業，從 Ingress NGINX 控制器收集指標，部署作業必須符合下列規定：

• 叢集必須執行 Google Kubernetes Engine 1.21.4-gke.300 以上版本。
• 您必須執行 Managed Service for Prometheus，並啟用代管收集作業。詳情請參閱「 開始使用代管集合」一文。

Ingress NGINX 會自動公開 Prometheus 格式的指標，您不必另外安裝。如要確認 Ingress NGINX 控制器是否公開指標，請執行下列指令：

  kubectl exec -n NAMESPACE_NAME deploy/ingress-nginx-controller -- curl http://localhost:10254/metrics
  

定義 PodMonitoring 資源

如要探索目標，Managed Service for Prometheus 運算子需要與相同命名空間中的 Ingress NGINX 控制器對應的 PodMonitoring 資源。

您可以使用下列 PodMonitoring 設定：

# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: monitoring.googleapis.com/v1
kind: PodMonitoring
metadata:
  name: ingress-nginx
  labels:
    app.kubernetes.io/name: ingress-nginx
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: 10254
    scheme: http
    interval: 30s
    path: /metrics
  selector:
    matchLabels:
      app.kubernetes.io/name: ingress-nginx

確認 port 和 matchLabels 欄位的值與要監控的 Ingress NGINX Pod 相符。根據預設，Ingress NGINX 控制器會在通訊埠 10254 上公開指標，並具有 app.kubernetes.io/name: ingress-nginx 標籤。

如要套用本機檔案的設定變更，請執行下列指令：

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

您也可以使用 Terraform 管理設定。

定義規則和快訊

您可以使用下列 Rules 設定，針對 Ingress NGINX 指標定義快訊：

# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: monitoring.googleapis.com/v1
kind: Rules
metadata:
  name: ingress-nginx-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: ingress-nginx-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: ingress-nginx
    interval: 30s
    rules:
    - alert: NGINXIngressDroppedConnections
      annotations:
        description: |-
          NGINX Ingress dropped connections
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: NGINX Ingress dropped connections (instance {{ $labels.instance }})
      expr: (nginx_ingress_controller_nginx_process_connections_total{state="accepted"} - nginx_ingress_controller_nginx_process_connections_total{state="handled"}) > 0
      for: 5m
      labels:
        severity: critical
    - alert: NGINXIngressHighRequestRate
      annotations:
        description: |-
          NGINX Ingress high request rate
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: NGINX Ingress high request rate (instance {{ $labels.instance }})
      expr: rate(nginx_ingress_controller_requests[5m]) > 100
      for: 5m
      labels:
        severity: warning
    - alert: NGINXIngressLowRequestRate
      annotations:
        description: |-
          NGINX Ingress low request rate
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: NGINX Ingress low request rate (instance {{ $labels.instance }})
      expr: rate(nginx_ingress_controller_requests[5m]) < 10
      for: 5m
      labels:
        severity: warning

如要套用本機檔案的設定變更，請執行下列指令：

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

您也可以使用 Terraform 管理設定。

如要進一步瞭解如何將規則套用至叢集，請參閱「受管理規則評估和快訊」。

您可以根據應用程式調整快訊閾值。

驗證設定

您可以使用 Metrics Explorer 確認 Ingress NGINX 控制器設定正確無誤。Cloud Monitoring 可能需要一到兩分鐘才能擷取指標。

如要確認指標已擷取，請按照下列步驟操作：

1. 前往 Google Cloud 控制台的 「Metrics Explorer」頁面：

   前往 Metrics Explorer

   如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。

2. 在查詢建構工具窗格的工具列中，選取名稱為  MQL 或  PromQL 的按鈕。
3. 確認已在「Language」(語言) 切換按鈕中選取「PromQL」。語言切換按鈕位於同一工具列，可供你設定查詢格式。
4. 輸入並執行下列查詢：
   

   up{job="ingress-nginx", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

查看資訊主頁

Cloud Monitoring 整合功能包含 Ingress NGINX Prometheus 總覽資訊主頁。設定整合作業後，系統會自動安裝資訊主頁。 您也可以查看資訊主頁的靜態預覽畫面，不需安裝整合服務。

注意：初始設定後，資訊主頁中的部分圖表可能不會顯示任何資料，因為 Ingress NGINX 只會在 Ingress 資源開始接收要求後，才匯出 nginx_ingress_controller_requests 等指標。

如要查看已安裝的資訊主頁，請按照下列步驟操作：

1. 在 Google Cloud 控制台中，前往「Dashboards」(資訊主頁) 頁面：

   前往「Dashboards」(資訊主頁)

   如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。

2. 選取「資訊主頁清單」分頁標籤。
3. 選擇「整合」類別。
4. 按一下資訊主頁名稱，例如「Ingress NGINX Prometheus Overview」。

如要查看資訊主頁的靜態預覽畫面，請按照下列步驟操作：

1. 前往 Google Cloud 控制台的 「Integrations」(整合) 頁面：

   前往「整合」

   如果您是使用搜尋列尋找這個頁面，請選取子標題為「Monitoring」的結果。

2. 按一下「Kubernetes Engine」部署平台篩選器。
3. 找出 Ingress NGINX Controller 整合項目，然後按一下「查看詳細資料」。
4. 選取「資訊主頁」分頁標籤。

疑難排解

如要瞭解如何排解指標擷取問題，請參閱「 排解擷取端問題」一文中的「 收集匯出工具資料時發生問題」一節。