סקירה כללית על Telemetry (OTLP) API

במאמר הזה מוסבר על Telemetry (OTLP) API, שמטמיע את פרוטוקול OpenTelemetry. ה-API הזה מיועד לשימוש באפליקציות שמוטמעות באמצעות אחת מערכות OpenTelemetry SDK או באמצעות OpenTelemetry Collector.

‫OpenTelemetry הוא פרויקט בקוד פתוח שנתמך על ידי Google CloudGoogle. מהנדסים של Google Google Cloudעובדים על הפרויקט כדי להבטיח תמיכה בהטמעה ובהמחשה חזותית של נתוני הטלמטריה שלכם.

מידע נוסף על ה-API הזה זמין במאמרי העזרה הבאים:

מידע על מכסות שמשויכות ל-API זמין במאמר מגבלות של Telemetry API.

שיטות מומלצות

כשמגדירים את האפליקציות לשליחת נתוני מעקב אלGoogle Cloud הפרויקט, מומלץ להשתמש בכלי לייצוא שכותב נתונים בפורמט OTLP אל Collector, ששולח את נתוני המעקב אל Telemetry API. בכלי לאיסוף נתונים, מציינים רק את כתובת ה-URL הבסיסית:

exporters:
  otlphttp:
    encoding: proto
    endpoint: https://telemetry.googleapis.com

‫OpenTelemetry מזהה את סוג הנתונים ומצרף באופן אוטומטי את /v1/traces,‏ /v1/metrics או /v1/logs לפי הצורך. מידע נוסף אפשר למצוא במאמר בנושא OTLP/HTTP Request.

דוגמאות לייצוא נתוני מעקב או מדדים ל-Telemetry API מופיעות במסמכים הבאים:

אם אתם לא יכולים להשתמש ב-Collector, אתם יכולים להשתמש בספריית OpenTelemetry שמכילה רכיב OTLP exporter בתוך התהליך כדי לשלוח נתוני טלמטריה אל Telemetry API. במאמר ייצוא נתוני מעקב לנקודת הקצה של OTLP מוסבר איך לייצא נתוני מעקב ישירות.

אימות

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

דוגמה לאימות כשמשתמשים בייצוא ישיר של נתוני מעקב מופיעה במאמר בנושא הגדרת אימות. בדוגמה הזו מוסבר איך להגדיר את כלי הייצוא באמצעות Google Cloud Application Default Credentials ‏ (ADC) ולהוסיף לאפליקציה ספריית אימות של Google שספציפית לשפה.

כדי לשלוח נתוני טלמטריה לפרויקט Google Cloud באמצעות Telemetry API, צריך גם:

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

  • מקצים למשתמש או לחשבון השירות שבו האפליקציה משתמשת את התפקידים הבאים בניהול הזהויות והרשאות הגישה (IAM):

    • התפקיד Service Usage Consumer (roles/serviceusage.serviceUsageConsumer) בפרויקט של מכסת השימוש.
    • התפקיד Cloud Telemetry Writer‏ (roles/telemetry.writer) בפרויקט. התפקיד הזה מאפשר לאפליקציה לכתוב נתונים של יומנים, מדדים ומעקב.

תמיכה ב-VPC Service Controls

שירות Telemetry API, ששם השירות שלו הוא telemetry.googleapis.com, הוא שירות שנתמך על ידי VPC Service Controls. הגבלות של VPC Service Controls שיוצרים עבור שירות Telemetry API חלות רק על השירות הזה. ההגבלות האלה לא חלות על שירותים אחרים, כולל שירותים כמו cloudtrace.googleapis.com, שיכולים גם לקלוט נתוני מעקב.

למידע נוסף, קראו את המאמרים הבאים:

נקודות קצה של שירותים

נקודת קצה של שירות היא כתובת URL בסיסית שמציינת את כתובת הרשת של שירות API. ‫Telemetry API תומך בנקודת קצה גלובלית ובנקודות קצה אזוריות:

  • נקודת קצה גלובלית: telemetry.googleapis.com. בנקודת הקצה הזו, אחרי ש-Google Cloud Observability משלים בהצלחה את כל שלבי האימות, הוא שולח את הנתונים לשירות קצה עורפי לצורך אחסון.

  • נקודות קצה אזוריות: telemetry.REGION.rep.googleapis.com, כאשר REGION הוא אזור נתמך. בנקודות הקצה האלה, אחרי ש-Google Cloud Observability משלים בהצלחה את כל שלבי האימות, הוא שולח את הנתונים לשירות קצה עורפי. השירות הזה שומר את הנתונים או משליך אותם:

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

    רשימה של נקודות קצה אזוריות נתמכות מופיעה במאמרי העזרה של ה-API.

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