סקירה כללית על ממשקי API

בדף הזה מובאת סקירה כללית קצרה על Observability API ועל Telemetry (OTLP) API.

מידע על Observability API

ה-Observability API מאפשר לכם:

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

    • מיקום אחסון שמוגדר כברירת מחדל לקטגוריות חדשות של נתונים שניתן לצפות בהם.
    • לכל מיקום, מפתח ברירת מחדל של Cloud Key Management Service. המפתח הזה משמש להצפנה של קטגוריות חדשות של נתונים שניתן לצפות בהם.

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

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

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

  • יוצרים קישור למערך נתונים, שמאפשר ל-BigQuery לקבל גישת קריאה למערך הנתונים. במאמר בנושא ניהול אחסון מוסבר איך ליצור מערך נתונים מקושר.

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

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

  • נקודת קצה גלובלית: observability.googleapis.com.

    אתם יכולים להשתמש בנקודת הקצה הגלובלית של השירות כדי לבצע כל פעולה שנתמכת על ידי Observability API. בנוסף, עבור נקודת הקצה הזו, הפקודה list observability buckets מאפשרת להחליף את שדה המיקום בפרמטר הנתיב בתו כללי (-).

  • נקודות קצה אזוריות: observability.REGION.rep.googleapis.com, כאשר REGION הוא אזור נתמך. רשימה של נקודות קצה מופיעה במאמר נקודת קצה אזורית של שירות.

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

הפניית API

מידע על Telemetry API

‫Telemetry (OTLP) API הוא הטמעה של פרוטוקול OpenTelemetry OTLP. ממשק ה-API של Telemetry מספק תאימות ותמיכה במערכת האקולוגית של OpenTelemetry בקוד פתוח:

  • יומנים: Telemetry API מאפשר לכם להטמיע רשומות יומן בפורמט OTLP בפרויקט. מידע נוסף זמין במאמר כתיבת יומני OTLP ל-Telemetry API.

  • מדדים: Telemetry API מאפשר לכם להטמיע מדדים בפורמט OTLP ב-Cloud Monitoring באמצעות כלי הייצוא otlphttp ו-OpenTelemetry Collector או OpenTelemetry SDK. מידע נוסף זמין במאמר סקירה כללית על הטמעת מדדים ב-OTLP.

  • עקבות: Telemetry API מאפשר לשלוח נתוני עקבות בפורמט OTLP לפרויקט. בנוסף, מגבלות המעקב של Telemetry API הן לרוב נדיבות יותר מהמגבלות של Cloud Trace API.

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

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

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

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

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

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

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

הפניית API

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