HashiCorp Consul

במאמר הזה מוסבר איך להגדיר את הפריסה שלכם ב-Google Kubernetes Engine כדי שתוכלו להשתמש בשירות המנוהל של Google Cloud ל-Prometheus כדי לאסוף מדדים מ-HashiCorp Consul. במאמר הזה מוסבר איך:

• מגדירים את Consul לדיווח על מדדים.
• אפשר לגשת למרכז בקרה מוגדר מראש ב-Cloud Monitoring כדי לראות את המדדים.

ההוראות האלה רלוונטיות רק אם אתם משתמשים ב אוסף מנוהל עם שירות מנוהל ל-Prometheus. אם אתם משתמשים באיסוף שמוטמע באופן עצמאי, תוכלו לקרוא את המסמכים בנושא Consul כדי לקבל מידע על ההתקנה.

ההוראות האלה הן דוגמה, והן צפויות לפעול ברוב סביבות Kubernetes. אם נתקלתם בבעיה בהתקנת אפליקציה או כלי לייצוא בגלל מדיניות אבטחה או מדיניות ארגונית מגבילה, מומלץ לעיין במסמכי קוד פתוח לקבלת תמיכה.

מידע על HashiCorp Consul זמין במאמר Consul.

דרישות מוקדמות

כדי לאסוף מדדים מ-Consul exporter באמצעות שירות מנוהל ל-Prometheus ואיסוף מנוהל, הפריסה צריכה לעמוד בדרישות הבאות:

• האשכול צריך להריץ את Google Kubernetes Engine בגרסה ‎1.28.15-gke.2475000 ואילך.
• צריך להפעיל את השירות המנוהל ל-Prometheus עם איסוף מנוהל. מידע נוסף זמין במאמר תחילת העבודה עם אוסף מנוהל.

• כדי להשתמש בלוחות הבקרה שזמינים ב-Cloud Monitoring לשילוב של Consul, צריך להשתמש בגרסה 1.13.3 ואילך של consul.

  מידע נוסף על לוחות בקרה זמינים מופיע במאמר הצגת לוחות בקרה.

‫Consul חושף מדדים בפורמט Prometheus כשמגדירים את אפשרויות ההגדרה של הטלמטריה prometheus_retention_time ו-disable_hostname. אפשר להגדיר את האפשרויות האלה על ידי טעינה של configmap ב-/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

כדי לגלות את היעד, ל-Managed Service for Prometheus Operator נדרש משאב PodMonitoring שתואם ל-Consul exporter באותו מרחב שמות.

אפשר להשתמש בהגדרה הבאה של 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 exporter. יכול להיות שיחלפו דקה או שתיים עד שמערכת Cloud Monitoring תעבד את המדדים.

כדי לוודא שהמדדים נאספים, מבצעים את הפעולות הבאות:

1. נכנסים לדף  Metrics explorer במסוף Google Cloud :

   כניסה אל Metrics Explorer

   אם משתמשים בסרגל החיפוש כדי למצוא את הדף הזה, בוחרים בתוצאה שבה הכותרת המשנית היא Monitoring.

2. בסרגל הכלים של החלונית ליצירת שאילתות, לוחצים על הלחצן ששמו  PromQL.
3. מזינים ומריצים את השאילתה הבאה:
   

   up{job="consul", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

צפייה במרכזי הבקרה

השילוב של Cloud Monitoring כולל את לוח הבקרה Consul Prometheus Overview. לוחות הבקרה מותקנים באופן אוטומטי כשמגדירים את השילוב. אפשר גם לראות תצוגות מקדימות סטטיות של מרכזי בקרה בלי להתקין את האינטגרציה.

כדי לראות מרכז בקרה שהותקן:

1. במסוף Google Cloud , עוברים לדף  Dashboards:

   עוברים אל מרכזי בקרה.

   אם משתמשים בסרגל החיפוש כדי למצוא את הדף הזה, בוחרים בתוצאה שבה הכותרת המשנית היא Monitoring.

2. לוחצים על הכרטיסייה רשימת מרכזי בקרה.
3. בוחרים בקטגוריה שילובים.
4. לוחצים על השם של מרכז הבקרה, למשל Consul Prometheus Overview.

כדי לראות תצוגה מקדימה סטטית של מרכז הבקרה:

1. נכנסים לדף  Integrations במסוף Google Cloud :

   עוברים אל שילובים

   אם משתמשים בסרגל החיפוש כדי למצוא את הדף הזה, בוחרים בתוצאה שבה הכותרת המשנית היא Monitoring.

2. לוחצים על המסנן Kubernetes Engine של פלטפורמת הפריסה.
3. מאתרים את השילוב של HashiCorp Consul ולוחצים על הצגת פרטים.
4. לוחצים על הכרטיסייה מרכזי בקרה.

פתרון בעיות

מידע על פתרון בעיות בהוספת מדדים זמין במאמר פתרון בעיות שקשורות להוספה בקטע בעיות באיסוף נתונים ממייצאים.