שימוש ב-Telemetry API

במסמך הזה מוסבר איך להגדיר את סוכן תפעול לשימוש ב-Telemetry (OTLP) API,‏ telemetry.googleapis.com. ‫Telemetry API הוא הטמעה של פרוטוקול השורה של OpenTelemetry בקוד פתוח. כשמפעילים את התכונה הזו, סוכן תפעול שולח יומנים ומדדים לפרויקט Google Cloud באמצעות Telemetry API ולא באמצעות Cloud Monitoring API ו-Cloud Logging API הקנייניים.

אם אתם משתמשים ב-Telemetry API ב-Ops Agent ויש לכם תרשימים או מדיניות התראות שמשמשים למעקב אחרי השימוש ב-API, אתם צריכים לעדכן את הארטיפקטים האלה כדי לעקוב אחרי נקודת הקצה telemetry.googleapis.com ולא אחרי נקודות הקצה monitoring.googleapis.com או logging.googleapis.com.

לפני שמתחילים

כדי להשתמש ב-Telemetry API:

  1. מפעילים את Telemetry API בפרויקט ב- Google Cloud , אם הוא עדיין לא מופעל. כדי להפעיל את ה-API, מריצים את הפקודה הבאה:

    gcloud services enable telemetry.googleapis.com

  2. אם ערכי ברירת המחדל לא מספיקים, אפשר לשנות את המכסות של Telemetry API. ל-Telemetry API יש מכסות נפרדות מאלה של Cloud Monitoring API ו-Cloud Logging API. מידע על המכסות והמגבלות של Telemetry API זמין במקורות הבאים:

    יכול להיות שתצטרכו לשנות את המכסות האלה כדי להתאים אותן לנפח נתוני הטלמטריה שאתם מטמיעים.

הגדרת סוכן תפעול לשימוש ב-Telemetry API

במהלך תקופת התצוגה המקדימה, השימוש ב-Telemetry API על ידי סוכן התפעול נשלט על ידי משתנה סביבה, EXPERIMENTAL_FEATURES. כדי לאסוף נתוני טלמטריה באמצעות Ops Agent ו-Telemetry API, צריך לבצע את הפעולות הבאות, כפי שמתואר בקטעים הבאים:

  1. מתקינים גרסה של סוכן התפעול שתומכת ב-Telemetry API.
  2. מגדירים את משתנה הסביבה EXPERIMENTAL_FEATURES.
  3. מפעילים מחדש את סוכן התפעול כדי שהשינוי ייכנס לתוקף.

משתמשים בגרסה 2.66.0 של סוכן תפעול ומעלה

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

הגדרת משתנה הסביבה

כדי לתת ל-סוכן תפעול גישה ל-Telemetry API, מגדירים את משתנה הסביבה EXPERIMENTAL_FEATURES לערך otlp_exporter, כמו שמוצג בכרטיסיות הבאות:

Linux

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

for service in \
        google-cloud-ops-agent \
        google-cloud-ops-agent-fluent-bit \
        google-cloud-ops-agent-opentelemetry-collector \
        ; do
        sudo mkdir -p "/etc/systemd/system/${service}.service.d"
        echo -e '[Service]\nEnvironment="EXPERIMENTAL_FEATURES=otlp_exporter"' | sudo tee "/etc/systemd/system/${service}.service.d/otlp_exporter.conf"
done
sudo systemctl daemon-reload

Windows

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

  1. מתחברים למופע באמצעות RDP או כלי דומה ומתחברים ל-Windows.
  2. פותחים טרמינל ב-PowerShell עם הרשאות אדמין על ידי לחיצה ימנית על סמל PowerShell ובחירה באפשרות הפעלה כמנהל מערכת.
  3. מגדירים את משתנה הסביבה EXPERIMENTAL_FEATURES על ידי הרצת פקודת PowerShell הבאה: 
    setx EXPERIMENTAL_FEATURES "otlp_exporter" /M

הפעלה מחדש של סוכן התפעול

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*

הגדרת סוכן תפעול כך שלא ישתמש ב-Telemetry API

כדי להפסיק את איסוף הטלמטריה על ידי סוכן תפעול באמצעות Telemetry API, ולחדש את איסוף הטלמטריה באמצעות Cloud Monitoring API ו-Cloud Logging API, צריך לבצע את הפעולות הבאות:

  1. מבטלים את ההגדרה של משתנה הסביבה EXPERIMENTAL_FEATURES.

    Linux

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

    sudo find /etc/systemd/system -name otlp_exporter.conf | sudo xargs rm
sudo systemctl daemon-reload

    Windows

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

    1. מתחברים למופע באמצעות RDP או כלי דומה ומתחברים ל-Windows.
    2. פותחים טרמינל ב-PowerShell עם הרשאות אדמין על ידי לחיצה ימנית על סמל PowerShell ובחירה באפשרות הפעלה כמנהל מערכת.
    3. כדי להסיר את משתנה הסביבה EXPERIMENTAL_FEATURES, מריצים את פקודת PowerShell הבאה: 
      REG delete "HKLM\SYSTEM\CurrentControlSet\Control\Session Manager\Environment" /F /V EXPERIMENTAL_FEATURES

  2. מפעילים מחדש את סוכן התפעול כדי שהשינוי ייכנס לתוקף.

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