Couchbase

השילוב עם Couchbase אוסף מדדים של דליים כמו פעולות, שימוש בזיכרון ופריטים שהוצאו. השילוב אוסף מדדים משרת Prometheus שנחשף בצומת. השילוב אוסף גם יומנים כלליים של Couchbase, יומני גישה ל-HTTP ויומנים של העברת נתונים בין מרכזי נתונים (goxdcr).

מידע נוסף על Couchbase זמין במסמכי התיעוד של Couchbase.

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

כדי לאסוף נתוני טלמטריה של Couchbase, צריך להתקין את סוכן התפעול:

  • כדי להשתמש במדדים, צריך להתקין גרסה 2.18.2 ואילך.
  • כדי לראות את היומנים, צריך להתקין את גרסה 2.18.2 ואילך.

השילוב הזה תומך בגרסאות 6.5,‏ 6.6 ו-7.0 של Couchbase.

הגדרת סוכן התפעול ל-Couchbase

פועלים לפי המדריך בנושא הגדרת Ops Agent, מוסיפים את הרכיבים הנדרשים לאיסוף נתוני טלמטריה ממופעי Couchbase ומפעילים מחדש את הסוכן.

הגדרה לדוגמה

הפקודות הבאות יוצרות את ההגדרה לאיסוף ולעיבוד של נתוני טלמטריה עבור Couchbase:

# Configures Ops Agent to collect telemetry from the app. You must restart the agent for the configuration to take effect.

set -e

# Check if the file exists
if [ ! -f /etc/google-cloud-ops-agent/config.yaml ]; then
  # Create the file if it doesn't exist.
  sudo mkdir -p /etc/google-cloud-ops-agent
  sudo touch /etc/google-cloud-ops-agent/config.yaml
fi

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    couchbase:
      type: couchbase
      username: admin 
      password: password 
      # To use the googlesecretmanager provider to replace plaintext passwords, refer to the example below.
      # password: ${googlesecretmanager:projects/<project-id>/secrets/<secret-id>/versions/<version-id>}
      collection_interval: 30s
  service:
    pipelines:
      couchbase:
        receivers:
          - couchbase

logging:
  receivers:
    couchbase_general:
      type: couchbase_general
    couchbase_http_access:
      type: couchbase_http_access
    couchbase_goxdcr:
      type: couchbase_goxdcr
  service:
    pipelines:
      couchbase:
        receivers:
          - couchbase_general
          - couchbase_http_access
          - couchbase_goxdcr

EOF

כדי שהשינויים האלה ייכנסו לתוקף, צריך להפעיל מחדש את Ops Agent:

Linux

  1. כדי להפעיל מחדש את הסוכן, מריצים את הפקודה הבאה במופע: 
    sudo systemctl restart google-cloud-ops-agent
  2. כדי לוודא שהסוכן הופעל מחדש, מריצים את הפקודה הבאה ומוודאים שהרכיבים Metrics Agent ו-Logging Agent הופעלו: 
    sudo systemctl status "google-cloud-ops-agent*"

Windows

  1. מתחברים למופע באמצעות RDP או כלי דומה ומתחברים ל-Windows.
  2. פותחים טרמינל ב-PowerShell עם הרשאות אדמין על ידי לחיצה ימנית על סמל PowerShell ובחירה באפשרות הפעלה כמנהל מערכת.
  3. כדי להפעיל מחדש את הסוכן, מריצים את פקודת PowerShell הבאה: 
    Restart-Service google-cloud-ops-agent -Force
  4. כדי לוודא שהסוכן הופעל מחדש, מריצים את הפקודה הבאה ומוודאים שהרכיבים Metrics Agent ו-Logging Agent הופעלו: 
    Get-Service google-cloud-ops-agent*

מה נרשם ביומן

הערך של logName נגזר ממזהי המקלט שצוינו בהגדרה. אלה השדות המפורטים שבתוך LogEntry:

יומני couchbase_general מכילים את השדות הבאים ב-LogEntry:

שדה סוג תיאור
jsonPayload.level מחרוזת רמת החומרה של רשומת היומן עבור יומן Couchbase
jsonPayload.message מחרוזת הודעה ביומן
jsonPayload.module_name מחרוזת שם המודול שיוצר את הרשומה
jsonPayload.node_name מחרוזת שם הצומת שמוציא את הודעת היומן
jsonPayload.source מחרוזת המקור שממנו הגיע היומן
jsonPayload.type מחרוזת סוג היומן
severity מחרוזת (LogSeverity) רמת רשומת היומן (מתורגמת).

יומני couchbase_http_access מכילים את השדות הבאים ב-LogEntry:

שדה סוג תיאור
httpRequest אובייקט ראה HttpRequest
jsonPayload.host מחרוזת כתובת ה-IP של הלקוח שמפעיל את בקשת ה-HTTP
jsonPayload.level מחרוזת רמת החומרה של רשומת היומן עבור יומן Couchbase
jsonPayload.message מחרוזת הודעה ביומן
jsonPayload.user מחרוזת השם של המשתמש ששולח את בקשת ה-HTTP, אם נעשה שימוש באימות בסיסי.
severity מחרוזת (LogSeverity) רמת רשומת היומן (מתורגמת).

יומני couchbase_goxdcr מכילים את השדות הבאים ב-LogEntry:

שדה סוג תיאור
jsonPayload.level מחרוזת רמת החומרה של רשומת היומן עבור יומן Couchbase
jsonPayload.log_type מחרוזת השם של הרכיב שיוצר את היומן של נתונים שמועברים בין מרכזי נתונים
jsonPayload.message מחרוזת הודעה ביומן
severity מחרוזת (LogSeverity) רמת רשומת היומן (מתורגמת).

הגדרת איסוף מדדים

כדי להטמיע מדדים מ-Couchbase, צריך ליצור מקלט למדדים ש-Couchbase מייצר, ואז ליצור צינור למקלט החדש.

המקלט הזה לא תומך בשימוש בכמה מופעים בהגדרה, למשל כדי לעקוב אחרי כמה נקודות קצה. כל המקרים האלה נרשמים באותה סדרת זמן, ול-Cloud Monitoring אין דרך להבחין ביניהם.

כדי להגדיר נמען למדדים של couchbase, צריך לציין את השדות הבאים:

שדה ברירת מחדל תיאור
collection_interval 60s ערך time.Duration, כמו 30s או 5m.
endpoint localhost:8091 כתובת ה-URL של הצומת למעקב.
password הסיסמה שמשמשת לחיבור לשרת Couchbase.
type הערך חייב להיות couchbase.
username שם המשתמש שמשמש לחיבור לשרת Couchbase.

מה נבדק

בטבלה הבאה מפורטים המדדים שסוכן התפעול אוסף ממופע Couchbase.

סוג המדד 
סוג, סוג
משאבים במעקב		 תוויות
workload.googleapis.com/couchbase.bucket.error.oom.count
CUMULATIVE, INT64
gce_instance 		bucket_name
error_type
workload.googleapis.com/couchbase.bucket.item.count
GAUGE, DOUBLE
gce_instance 		bucket_name
state
workload.googleapis.com/couchbase.bucket.item.ejection.count
CUMULATIVE, INT64
gce_instance 		bucket_name
workload.googleapis.com/couchbase.bucket.memory.high_water_mark.limit
GAUGE, DOUBLE
gce_instance 		bucket_name
workload.googleapis.com/couchbase.bucket.memory.low_water_mark.limit
GAUGE, DOUBLE
gce_instance 		bucket_name
workload.googleapis.com/couchbase.bucket.memory.usage
GAUGE, DOUBLE
gce_instance 		bucket_name
workload.googleapis.com/couchbase.bucket.operation.count
CUMULATIVE, INT64
gce_instance 		bucket_name
op
workload.googleapis.com/couchbase.bucket.vbucket.count
GAUGE, DOUBLE
gce_instance 		bucket_name
state

אימות ההגדרה

בקטע הזה מוסבר איך לוודא שהגדרתם נכון את מקלט Couchbase. יכול להיות שיעברו דקה או שתיים עד שהסוכן של Ops יתחיל לאסוף נתוני טלמטריה.

כדי לוודא שיומני Couchbase נשלחים אל Cloud Logging, מבצעים את הפעולות הבאות:

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

    כניסה אל Logs Explorer

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

  2. מזינים את השאילתה הבאה בעורך ולוחצים על Run query: 
    resource.type="gce_instance"
(log_id("couchbase_general") OR log_id("couchbase_http_access") OR log_id("couchbase_goxdcr"))

כדי לוודא שהמדדים של Couchbase נשלחים ל-Cloud Monitoring, מבצעים את הפעולות הבאות:

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

    כניסה אל Metrics Explorer

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

  2. בסרגל הכלים של החלונית ליצירת שאילתות, לוחצים על הלחצן ששמו  PromQL.
  3. מזינים את השאילתה הבאה בעורך ולוחצים על Run query: 
    {"workload.googleapis.com/couchbase.bucket.memory.usage", monitored_resource="gce_instance"}

צפייה בלוח הבקרה

כדי לראות את המדדים של Couchbase, צריך להגדיר תרשים או לוח בקרה. השילוב של Couchbase כולל לוח בקרה אחד או יותר. כל מרכזי הבקרה מותקנים אוטומטית אחרי שמגדירים את השילוב וסוכן Ops מתחיל לאסוף נתונים של מדדים.

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

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

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

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

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

  2. לוחצים על הכרטיסייה רשימת לוחות הבקרה ואז בוחרים בקטגוריה שילובים.
  3. לוחצים על השם של מרכז הבקרה שרוצים להציג.

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

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

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

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

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

  2. לוחצים על המסנן Compute Engine של פלטפורמת הפריסה.
  3. מחפשים את הערך של Couchbase ולוחצים על הצגת פרטים.
  4. לוחצים על הכרטיסייה מרכזי בקרה כדי לראות תצוגה מקדימה סטטית. אם מרכז הבקרה מותקן, אפשר לעבור אליו בלחיצה על View dashboard (הצגת מרכז הבקרה).

מידע נוסף על לוחות בקרה ב-Cloud Monitoring זמין במאמר בנושא לוחות בקרה וטבלאות.

מידע נוסף על השימוש בדף Integrations (שילובים) זמין במאמר ניהול שילובים.

התקנה של כללי מדיניות התראות

מדיניות התראות מורה ל-Cloud Monitoring לשלוח לכם התראה כשמתרחשים תנאים מסוימים. השילוב של Couchbase כולל מדיניות התראות אחת או יותר שתוכלו להשתמש בהן. אפשר לראות ולהתקין את מדיניות ההתראות הזו בדף שילובים ב-Monitoring.

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

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

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

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

  2. מאתרים את הערך של Couchbase ולוחצים על הצגת פרטים.
  3. לוחצים על הכרטיסייה התראות. בכרטיסייה הזו מופיעים תיאורים של מדיניות ההתראות הזמינה וממשק להתקנתן.
  4. התקנה של כללי מדיניות התראות. כדי שמדיניות ההתראות תדע לאן לשלוח התראות על הפעלה של התראה, היא צריכה לקבל מכם מידע להתקנה. כדי להתקין מדיניות התראות:
    1. ברשימת מדיניות ההתראות הזמינה, בוחרים את אלה שרוצים להתקין.

    2. בקטע הגדרת התראות, בוחרים ערוץ התראות אחד או יותר. יש לכם אפשרות להשבית את השימוש בערוצי התראות, אבל אם תעשו את זה, מדיניות ההתראות שלכם תופעל בשקט. אפשר לבדוק את הסטטוס שלהם בדף 'מעקב', אבל לא תקבלו התראות.

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

    3. לוחצים על יצירת מדיניות.

למידע נוסף על מדיניות התראות ב-Cloud Monitoring, אפשר לעיין במאמר מבוא להתראות.

מידע נוסף על השימוש בדף Integrations (שילובים) זמין במאמר ניהול שילובים.

המאמרים הבאים

בסרטון Install the Ops Agent to troubleshoot third-party applications מוסבר איך להשתמש ב-Ansible כדי להתקין את סוכן תפעול, להגדיר אפליקציית צד שלישי ולהתקין לוח בקרה לדוגמה.