הגדרת אפליקציות C# לדיווח על שגיאות

אפשר לשלוח אירועי שגיאה אל Error Reporting מאפליקציות C# באמצעות סדרת הספריות Google.Cloud.Diagnostics . אפשר להשתמש בספרייה Google.Cloud.Diagnostics כדי ליצור קבוצות שגיאות במקרים הבאים:

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

השירות Error Reporting משולב עם חלק מהשירותים, כמו פונקציות של Cloud Run, ‏ App Engine, ‏ Compute Engine ו-Google Kubernetes Engine. Google Cloud ב-Error Reporting מוצגים אירועי השגיאות שנרשמים ב-Cloud Logging על ידי אפליקציות שפועלות בשירותים האלה. מידע נוסף זמין בקטע הפעלה ב Google Cloud בדף הזה.

אפשר גם לשלוח אירועי שגיאה אל Error Reporting באמצעות Logging. במאמר פורמט של רשומה ביומן לדיווח על אירועי שגיאה מוסבר על הדרישות בנוגע לפורמט הנתונים.

לפני שמתחילים

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

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API .

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API .

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

התקנת ספריית הלקוח

ספריית Google.Cloud.Diagnostics מאפשרת לכם לעקוב אחרי אירועים של שגיאות שדווחו על ידי אפליקציות C# שפועלות כמעט בכל מקום, ולצפות בהם.

1. באפליקציות שמיועדות ל-ASP.NET Core 3 ואילך, צריך להשתמש בספרייה Google.Cloud.Diagnostics.AspNetCore3. אפשר להתקין את הספרייה הזו מ-NuGet.
2. באפליקציות שמטרגטות גרסאות קודמות של ASP.NET Core, צריך להשתמש בספרייה Google.Cloud.Diagnostics.AspNetCore. אפשר להתקין את הספרייה הזו מ-NuGet.
3. באפליקציות שמטרגטות מסגרות שאינן ASP.NET Core, צריך להשתמש בספרייה Google.Cloud.Diagnostics.Common. אפשר להתקין את הספרייה הזו מ-NuGet.

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

הגדרת ספריית הלקוח

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

Google.Cloud.Diagnostics.AspNetCore3 מסמכי תיעוד

Google.Cloud.Diagnostics.AspNetCore מסמכי תיעוד

Google.Cloud.Diagnostics.Common מסמכי תיעוד

הפעלת אפליקציות ב- Google Cloud

כדי ליצור קבוצות שגיאות באמצעות projects.events.report, לחשבון השירות שלכם נדרש התפקיד Error Reporting Writer (roles/errorreporting.writer).

חלק משירותי Google Cloud Google Cloud מעניקים באופן אוטומטי את התפקיד Error Reporting Writer ‏ (roles/errorreporting.writer) לחשבון השירות המתאים. עם זאת, בשביל שירותים מסוימים, צריך להעניק את התפקיד הזה לחשבון השירות המתאים.

פונקציות Cloud Run ו-Cloud Run

לחשבון השירות שמוגדר כברירת מחדל ב-Cloud Run יש את ההרשאות של התפקיד Error Reporting Writer (roles/errorreporting.writer).

אפשר להשתמש בספריית Google.Cloud.Diagnostics בלי לספק פרטי כניסה באופן מפורש.

‫Cloud Run מוגדר לשימוש ב-Error Reporting באופן אוטומטי. חריגים ב-JavaScript שלא טופלו יופיעו ב-Logging ויעובדו על ידי Error Reporting בלי שתצטרכו להשתמש בספרייה Google.Cloud.Diagnostics.

הערה: שירות Error Reporting יוצר באופן אוטומטי אירוע שגיאה כשערך היומן מכיל דוח קריסות ורמת החומרה של ערך היומן לא מוגדרת או מוגדרת לערך ERROR לפחות.

סביבה גמישה של App Engine

ב-App Engine, לחשבון השירות שמוגדר כברירת מחדל מוענק באופן אוטומטי התפקיד 'כתיבה ביומן' (roles/errorreporting.writer).

אפשר להשתמש בספריית Google.Cloud.Diagnostics בלי לספק פרטי כניסה באופן מפורש.

התכונה 'דיווח על שגיאות' מופעלת באופן אוטומטי באפליקציות של סביבת App Engine גמישה. לא נדרשת הגדרה נוספת. הודעות שנכתבות מ-App Engine אל stderr עוברות ניתוח, ואם נמצא שהן מכילות דוח קריסות, הן יוצגו ב-Error Reporting.

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

Google Kubernetes Engine

כדי להשתמש ב-Error Reporting עם Google Kubernetes Engine, צריך לבצע את הפעולות הבאות:

1. מוודאים שלחשבון השירות שבו ישתמש הקונטיינר הוקצה התפקיד 'כתיבה ב-Error Reporting' (roles/errorreporting.writer).

   אתם יכולים להשתמש בחשבון השירות שמוגדר כברירת מחדל ב-Compute Engine או בחשבון שירות מותאם אישית.

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

2. יוצרים את האשכול ומעניקים לאשכול את cloud-platform היקף הגישה.

   לדוגמה, בפקודת היצירה הבאה מצוינים היקף הגישה cloud-platform וחשבון שירות:

   gcloud container clusters create CLUSTER_NAME --service-account  SERVICE_ACCT_NAME --scopes=cloud-platform
   

הערה: אחרי שיוצרים אשכול, אי אפשר לשנות את חשבון השירות שלו.

Compute Engine

כדי להשתמש ב-Error Reporting עם מכונות וירטואליות ב-Compute Engine, צריך לבצע את הפעולות הבאות:

1. מוודאים שלחשבון השירות שבו המכונה הווירטואלית משתמשת הוקצה התפקיד 'כותב דוחות שגיאות' (roles/errorreporting.writer).

   אתם יכולים להשתמש בחשבון השירות שמוגדר כברירת מחדל ב-Compute Engine או בחשבון שירות מותאם אישית.

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

2. נכנסים לדף VM instances במסוף Google Cloud :

   כניסה לדף VM instances

   אם משתמשים בסרגל החיפוש כדי למצוא את הדף הזה, בוחרים את התוצאה שבה כותרת המשנה היא Compute Engine.

3. בוחרים את מופע ה-VM שרוצים להעניק לו את cloud-platform היקף הגישה.

4. לוחצים על עצירה ואז על עריכה.

5. בקטע Identity and API access בוחרים חשבון שירות עם התפקיד Error Reporting Writer (roles/errorreporting.writer).

6. בקטע Access scopes בוחרים באפשרות Allow full access to all Cloud APIs ושומרים את השינויים.

7. לוחצים על התחלה/המשך.

דוגמה

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

Google.Cloud.Diagnostics.AspNetCore3 מסמכי תיעוד

Google.Cloud.Diagnostics.AspNetCore מסמכי תיעוד

Google.Cloud.Diagnostics.Common מסמכי תיעוד

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

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

כדי להשתמש בסביבת פיתוח מקומית בדוגמאות של .NET שבדף הזה, מתקינים ומפעילים את ה-CLI של gcloud, ואז מגדירים את Application Default Credentials באמצעות פרטי הכניסה של המשתמש.

1. התקינו את ה-CLI של Google Cloud.

2. אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

3. אם אתם משתמשים במעטפת מקומית, אתם צריכים ליצור פרטי כניסה לאימות מקומי עבור חשבון המשתמש:

   gcloud auth application-default login

   אם אתם משתמשים ב-Cloud Shell, אין צורך לבצע את הפעולה הזו.

   הערה: אם ב-CLI של gcloud מופיעה אזהרה שלחשבון אין את ההרשאה serviceusage.services.use, יכול להיות שחלק מהפקודות וחלק מספריות הלקוח ב-CLI של gcloud לא יפעלו. תוכלו לבקש מאדמין להקצות לכם את תפקיד ה-IAM של צרכן השימוש בשירות (roles/serviceusage.serviceUsageConsumer)‏, ולאחר מכן להריץ את הפקודה הבאה:

   gcloud auth application-default set-quota-project PROJECT_ID

   אם מוחזרת שגיאת אימות ואתם משתמשים בספק זהויות חיצוני (IdP), ודאו ש נכנסתם ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

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

מפתחות API נתמכים גם על ידי projects.events.report method. אם אתם רוצים להשתמש במפתחות API לצורך אימות, לא צריך להגדיר קובץ מקומי של Application Default Credentials. מידע נוסף זמין במאמר בנושא יצירת מפתח API במסמכי האימות של Google Cloud .

הצגת קבוצות של שגיאות

נכנסים לדף Error Reporting במסוף Google Cloud :

עבור אל Error Reporting

אפשר גם להשתמש בסרגל החיפוש כדי למצוא את הדף הזה.

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