HashiCorp Consul

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

  • 設定 Consul 回報指標。
  • 在 Cloud Monitoring 中存取資訊主頁，即可查看指標。

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

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

如需 HashiCorp Consul 的相關資訊，請參閱 Consul。

必要條件

如要使用 Managed Service for Prometheus 和代管收集作業，從 Consul 匯出工具收集指標，部署作業必須符合下列規定：

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

  • 如要使用 Cloud Monitoring 提供的 Consul 整合資訊主頁，請務必使用 consul 1.13.3 以上版本。

    如要進一步瞭解可用的資訊主頁，請參閱「查看資訊主頁」。

設定遙測設定選項 prometheus_retention_time 和 disable_hostname 後，Consul 就會公開 Prometheus 格式的指標。如要設定這些選項，請在 /consul/config/metrics.hcl 掛接 configmap。HashiCorp 建議保留時間是收集間隔的兩倍。

修改 Consul 設定

修改 Consul 設定，如以下範例所示：

# 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.

kind: StatefulSet
metadata:
  name: consul
spec:
  serviceName: consul
  selector:
    matchLabels:
+     app.kubernetes.io/name: consul
  template:
    metadata:
      labels:
+       app.kubernetes.io/name: consul
    spec:
      containers:
      - name: consul
        image: hashicorp/consul:1.16.0
        ports:
        - containerPort: 8500
          name: consul
          protocol: TCP
+       volumeMounts:
+       - mountPath: /consul/config/metrics.hcl
+         subPath: metrics.hcl
+         name: consul-telemetry
+     volumes:
+     - name: consul-telemetry
+       configMap:
+         name: consul-telemetry
+         items:
+         - key: metrics.hcl
+           path: metrics.hcl

您必須將以 + 符號開頭的任何行新增至設定。

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

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

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

如要判斷 Consul 是否公開指標，請執行下列指令： 
  kubectl exec -n NAMESPACE_NAME POD_NAME -- curl -sS localhost:8500/v1/agent/metrics?format=prometheus

定義 PodMonitoring 資源

如要探索目標，Managed Service for Prometheus Operator 需要與相同命名空間中的 Consul 匯出工具對應的 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: consul
  labels:
    app.kubernetes.io/name: consul
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: 8500
    scheme: http
    interval: 30s
    path: /v1/agent/metrics
    params:
      format:
      - prometheus
  selector:
    matchLabels:
      app.kubernetes.io/name: consul

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

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

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

驗證設定

您可以使用 Metrics Explorer 確認 Consul 匯出工具設定正確無誤。Cloud Monitoring 可能需要一到兩分鐘才能擷取指標。

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

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

    前往 Metrics Explorer

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

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

查看資訊主頁

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

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

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

    前往「Dashboards」(資訊主頁)

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

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

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

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

    前往「整合」

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

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

疑難排解

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