HashiCorp Consul

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

  • 設定 Consul 以便回報指標。
  • 為 Managed Service for Prometheus 設定 PodMonitoring 資源，以便收集匯出的指標。
  • 在 Cloud Monitoring 中存取資訊主頁，查看指標。

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

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

如要瞭解 HashiCorp Consul，請參閱 Consul。

事前準備

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

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

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

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

設定遙測設定選項 prometheus_retention_time 和 disable_hostname 時，Consul 會公開 Prometheus 格式指標。您可以將設定檔對應圖掛載至 /consul/config/metrics.hcl，藉此設定這些選項。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 資源

針對目標探索，Prometheus Operator 的 Managed Service 需要與相同命名空間中的 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 總覽」。

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

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

    前往「Integrations」

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

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

疑難排解

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