איסוף נתוני שגיאות באמצעות Error Reporting

במסמך הזה מפורטים הסביבות שנתמכות על ידי Error Reporting, ויש בו קישורים למדריכים ספציפיים לשפה למפתחי אפליקציות. מומלץ להשתמש בספריות לקוח ספציפיות לשפה או להסתמך על רשומות יומן שנאספות באופן אוטומטי. עם זאת, אפשר לכתוב נתוני שגיאות באמצעות Cloud Logging API או Error Reporting API. לדוגמה, אם משתמשים ב-Cloud Run, חריגים שנכתבים ב-stderr נשלחים אוטומטית ל-Cloud Logging.

השירות Error Reporting הוא שירות גלובלי שמבוסס על Cloud Logging, והוא יכול לנתח רשומות ביומן אם כל התנאים הבאים מתקיימים:

  • האפשרות Assured Workloads מושבתת. מידע נוסף זמין במאמר סקירה כללית על Assured Workloads.
  • מפתחות הצפנה בניהול הלקוח (CMEK) מושבתים בכל מאגרי היומנים שבהם מאוחסנת רשומת היומן. אי אפשר לאחסן רשומות ביומן בדלי יומנים שמופעל בהם CMEK. במאמר אימות הפעלת המפתח מוסבר איך לקבוע את הגדרת ה-CMEK של קטגוריה ביומן.
  • קטגוריה ביומן עומדת באחד מהתנאים הבאים:
    • קטגוריית היומן מאוחסנת באותו פרויקט שבו נוצרו רשומות היומן.
    • רשומות היומן מנותבות לפרויקט, ואז הפרויקט הזה מאחסן את רשומות היומן בקטגוריית יומנים שבבעלותו.

תמיכה בענן וירטואלי פרטי (VPC)

Error Reporting הוא שירות שנתמך בענן וירטואלי פרטי (VPC).

כדי לצמצם את הסיכון לזליגת נתונים, אפשר להשתמש ב-VPC Service Controls כדי ליצור גבולות גזרה לשירות סביב השירותים שמנוהלים על ידי Google. מידע על VPC Service Controls ועל יצירת פרמטר שירות זמין במסמכי התיעוד של VPC Service Controls.

הגדרת סביבות לדיווח אוטומטי של נתוני שגיאות

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

הוספת קוד לאפליקציות באמצעות ספריות לקוח

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

כתיבת נתוני שגיאות באמצעות API

כדי לדווח על אירועי שגיאה ל Google Cloud פרויקט, מריצים את שיטת Error Reporting API‏ report או את שיטת Cloud Logging API‏ write.

  • אם אתם צריכים אימות שמבוסס על מפתח API, אתם צריכים להשתמש ב-Error Reporting API. כדי לדווח על אירוע שגיאה באמצעות Error Reporting API, מריצים את השיטה report ומעצבים את גוף הבקשה של השיטה כאובייקט ReportedErrorEvent.

    כשמשתמשים ב-Error Reporting API, רשומות ביומן עם הודעות שגיאה בפורמט תקין נוצרות באופן אוטומטי ונכתבות ב-Cloud Logging. רשומות היומן האלה נכתבות ביומן ששם הקובץ שלו מעוצב באופן הבא:logName

    projects/PROJECT_ID/clouderrorreporting.googleapis.com%2Freported_errors

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

    אם אתם מדווחים על אירועי שגיאה באמצעות Error Reporting API, שאר המידע במאמר הזה לא רלוונטי.

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