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

אתם יכולים לשלוח חריגים באפליקציה ואירועי שגיאה אל Error Reporting כדי ש-Error Reporting יוכל לנתח נתוני שגיאות בGoogle Cloud פרויקט שלכם. בהתאם לסביבת המחשוב, לשפת התכנות ולדרישות האימות, אפשר לאסוף נתוני שגיאות בדרכים הבאות:

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

כאשר Error Reporting מנתח רשומות ביומן

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

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

תמיכה ב-VPC Service Controls

שירות VPC Service Controls תומך ב-Error Reporting.

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

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

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

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

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

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

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

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

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

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

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

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