שימוש ב-Telemetry API

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

אם אתם משתמשים ב-Telemetry API ב-Ops Agent ויש לכם תרשימים או מדיניות התראות שמנטרים את השימוש ב-API, אתם צריכים לעדכן את הארטיפקטים האלה כדי לנטר את נקודת הקצה telemetry.googleapis.com ולא את נקודות הקצה monitoring.googleapis.com, logging.googleapis.com או cloudtrace.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 זמין במקורות הבאים:

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

  3. אם אתם אוספים נתוני מעקב, צריך להעניק לחשבון השירות שבו משתמש סוכן התפעול את התפקיד Cloud Telemetry Traces Writer (roles/telemetry.tracesWriter). התפקיד הזה מספק את ההרשאות שנדרשות לכתיבת עקבות.

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

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

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

שימוש בגרסה 2.71.0 של סוכן תפעול ואילך

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

הגדרת אפשרות ההגדרה

נותנים ל-Ops Agent גישה ל-Telemetry API על ידי הגדרת אפשרות התצורה otlp_exporter ל-true בקובץ config.yaml של הסוכן:

global:
   otlp_exporter: true

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

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

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

  1. מסירים את האפשרות otlp_exporter מהקובץ config.yaml. אפשר גם להגדיר את האפשרות false.

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

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