ניהול של בדיקות סינתטיות

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

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

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

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

צריך לבצע את הפעולות הבאות Google Cloud בפרויקט שבו מאוחסן הכלי לניטור סינתטי:

• כדי לקבל את ההרשאות שדרושות להצגה ולשינוי של בדיקות סינתטיות באמצעות Google Cloud המסוף, צריך לבקש מהאדמין להקצות לכם את תפקידי ה-IAM הבאים בפרויקט:

  • עריכה של מעקב (roles/monitoring.editor)
  • Cloud Functions Developer (roles/cloudfunctions.developer)

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

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

• ההוראות לשימוש ב-API שבדף הזה מיועדות ל-API Explorer. אבל אפשר גם להשתמש בפקודת curl. ‫APIs Explorer מספק את התחביר של curl.

• Select the tab for how you plan to use the samples on this page:

  Console

  When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.

  gcloud

  In the Google Cloud console, activate Cloud Shell.

  Activate Cloud Shell

  At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  REST

  כדי להשתמש בדוגמאות של API בארכיטקטורת REST שבדף הזה בסביבת פיתוח מקומית, צריך להשתמש בפרטי הכניסה שאתם נותנים ל-CLI של gcloud.

  התקינו את ה-CLI של Google Cloud. אחר כך, אתחלו את ה-CLI של Google Cloud באמצעות הפקודה הבאה:

  gcloud init

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

  מידע נוסף מופיע במאמר אימות לשימוש ב-REST במסמכי האימות של Google Cloud .

רשימת מוניטורים סינתטיים

המסוף

כדי להציג את רשימת הבדיקות הסינתטיות ב Google Cloud פרויקט:

1. במסוף Google Cloud , עוברים לדף  Synthetic monitoring:

   כניסה אל Synthetic monitoring

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

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

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

   כל מסנן מורכב משם ומערך. אפשר להגדיר את הערך כך שיתאים בדיוק לשם של בדיקה סינתטית או שיתאים באופן חלקי. ההתאמות לא תלויות באותיות רישיות (case-sensitive). לדוגמה, כדי להציג ברשימה את כל המוניטורים הסינתטיים שהשם שלהם מכיל את default:

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

   אם יש לכם כמה מסננים, הם מצורפים אוטומטית באמצעות האופרטור הלוגי AND, אלא אם אתם מוסיפים מסנן OR. בדוגמה הקודמת השתמשנו במסנן OR כדי להציג בדיקת זמינות אם השם שלה תואם ל-default או ל-Testing check.

בדף Synthetic monitors מוצגים הנתונים הבאים לגבי כל בדיקה סינתטית:

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

gcloud

כדי להציג את בדיקות זמני הפעילות ואת המוניטורים הסינתטיים, מריצים את הפקודה gcloud monitoring uptime list-configs:

gcloud monitoring uptime list-configs --project=PROJECT_ID

לפני שמריצים את הפקודה הקודמת, מחליפים את מה שכתוב בשדות הבאים:

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

הנתונים שמוחזרים כוללים את:

• השם והשם המוצג.
• בדיקת המזהה.
• משאב במעקב.
• התקופה בין הבדיקות.

אפשר להגדיר את הפקודה Google Cloud CLI כדי לסנן ולמיין את התוצאות.

REST

כדי להציג רשימה של בדיקות סינתטיות ב Google Cloud פרויקט, כולל בדיקות זמני פעילות, צריך לבצע קריאה ל-method‏ projects.uptimeCheckConfigs.list:

1. לוחצים על projects.uptimeCheckConfigs.list.

2. משתמשים ב-APIs Explorer.

   מגדירים את ההורה של השיטה לשם הפרויקט, ומוודאים שמשתמשים בפורמט הבא:

   projects/PROJECT_ID
   

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

בבדיקה סינתטית, התוצאה מכילה שדה עם התווית syntheticMonitor.

הצגת פרטים של בדיקה סינתטית

המסוף

כדי להציג את הפרטים של בדיקה סינתטית בפרויקט Google Cloud , פועלים לפי השלבים הבאים:

1. במסוף Google Cloud , עוברים לדף  Synthetic monitoring:

   כניסה אל Synthetic monitoring

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

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

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

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

gcloud

כדי להציג את הפרטים של בדיקת זמינות או של בדיקה סינתטית, מריצים את הפקודה gcloud monitoring uptime describe:

gcloud monitoring uptime describe CHECK_ID --project=PROJECT_ID

לפני שמריצים את הפקודה הקודמת, מחליפים את מה שכתוב בשדות הבאים:

• ‫PROJECT_ID: מזהה הפרויקט. בהגדרות של מרכז האפליקציות, בוחרים את פרויקט המארח או את פרויקט הניהול של מרכז האפליקציות.
• ‫CHECK_ID: המזהה של בדיקת הזמינות או של המוניטור הסינתטי. כדי למצוא את המזהה, מריצים את הפקודה gcloud monitoring uptime list-configs ובודקים את השדה name. מידע נוסף זמין במאמר בנושא איתור המזהה הייחודי של כלי מעקב סינתטי.

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

• השם והשם המוצג.
• בדיקת המזהה.
• משאב במעקב.
• התקופה בין הבדיקות.

REST

כדי להציג את הפרטים של בדיקת זמינות סינתטית ספציפית בפרויקט Google Cloud , צריך לבצע קריאה לשיטה projects.uptimeCheckConfigs.get:

1. לוחצים על projects.uptimeCheckConfigs.get.

2. משתמשים ב-APIs Explorer.

   מגדירים את ההורה של השיטה למזהה של המוניטור הסינתטי, ומוודאים שמשתמשים בפורמט הבא:

   projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
   

   בביטוי הקודם:

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

   לדוגמה, הערך של שדה האב יכול להיות:

   projects/my-project/uptimeCheckConfigs/10863117100295372627
   

   כדי למצוא את הערך של CHECK_ID, אפשר להפעיל את השיטה projects.uptimeCheckConfigs.list. כדי לצמצם את מספר התוצאות שמוחזרות, צריך לכלול מסנן. לדוגמה, מוסיפים את המסנן displayName="MySyntheticMonitor".

עריכה של בדיקה סינתטית או פונקציית Cloud Run

המסוף

הערה: אם רוצים רק לשנות את פונקציית Cloud Run, אפשר להשתמש בדף Function details או בדף Synthetic monitor details. בשני המקרים, צריך לבחור באפשרות העריכה, לבצע את השינויים ואז לפרוס את פונקציית Cloud Run ששונתה.

כדי לערוך בדיקה סינתטית או את פונקציית Cloud Run שלה באמצעות הדף פרטי בדיקה סינתטית:

1. במסוף Google Cloud , עוברים לדף  Synthetic monitoring:

   כניסה אל Synthetic monitoring

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

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

4. אופציונלי: כדי לערוך את פונקציית Cloud Run, לוחצים על עריכת הפונקציה, מבצעים את השינויים הרצויים ואז לוחצים על החלת הפונקציה.

   עבור בודקי קישורים מנותקים, כדי לשנות את ה-URI של המקור או את האפשרויות שמגדירות אילו קישורים ייבדקו, צריך לערוך את פונקציית Cloud Run ואז לעדכן את האובייקט options בקובץ index.js. מידע על השדות והתחביר של האובייקט הזה זמין במאמר broken-links-ok/index.js.

5. כדי לשמור את השינויים, לוחצים על שמירה. אחרת, לוחצים על ביטול.

gcloud

כדי לשנות בדיקת זמינות או בדיקה סינתטית, מריצים את הפקודה gcloud monitoring uptime update:

gcloud monitoring uptime update CHECK_ID OPTIONAL_FLAGS --project=PROJECT_ID

לפני שמריצים את הפקודה הקודמת, מחליפים את מה שכתוב בשדות הבאים:

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

• ‫CHECK_ID: המזהה של בדיקת הזמינות או של המוניטור הסינתטי. כדי למצוא את המזהה, מריצים את הפקודה gcloud monitoring uptime list-configs ובודקים את השדה name. מידע נוסף זמין במאמר איך מוצאים את המזהה הייחודי של בדיקת זמינות.

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

  • נקודה
  • השם המוצג
  • זמן קצוב לתפוגה
  • תוויות משתמש

לדוגמה, כדי להגדיר את התקופה של בדיקה סינתטית ל-10 דקות, מריצים את הפקודה הבאה:

gcloud monitoring uptime update CHECK_ID --period=10 --project=PROJECT_ID

REST

מדיניות התראות ופונקציות לא נכללות בבדיקה סינתטית, ולכן אי אפשר לערוך אותן באמצעות התהליך שמתואר בקטע הזה:

• כדי לשנות מדיניות התראות, משתמשים במסוף Google Cloud או קוראים לשיטה alertPolicies.patch. מידע נוסף זמין במאמר ניהול מדיניות התראות באמצעות API.

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

כדי לערוך בדיקה סינתטית, קוראים לשיטה projects.uptimeCheckConfigs.patch:

1. לוחצים על projects.uptimeCheckConfigs.patch.

2. משתמשים ב-APIs Explorer.

   1. מגדירים את ההורה של השיטה למזהה של המוניטור הסינתטי. המזהה הוא בפורמט הבא:

      projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
      

      בביטוי הקודם:

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

      כדי למצוא את הערך של CHECK_ID, אפשר להפעיל את השיטה projects.uptimeCheckConfigs.list. כדי לצמצם את מספר התוצאות שמוחזרות, צריך לכלול מסנן. לדוגמה, מוסיפים את המסנן displayName="MySyntheticMonitor".

   2. מגדירים את פרמטר השאילתה של השיטה, updateMask, כדי לזהות אילו שדות באובייקט משתנים. לדוגמה, כדי לעדכן את הערך של הפרמטר displayName, פרמטר השאילתה יהיה:

      updateMask=displayName
      

העתקה של מעקב סינתטי

המסוף

כדי להעתיק בדיקה סינתטית בפרויקט Google Cloud :

1. במסוף Google Cloud , עוברים לדף  Synthetic monitoring:

   כניסה אל Synthetic monitoring

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

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

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

   תיבת הדו-שיח Copy Synthetic Check (העתקת בדיקה סינתטית) נפתחת עם שדות שמולאו מראש, כולל עותק של פונקציית Cloud Run.

4. לוחצים על יצירת פונקציה, מעדכנים את הפונקציה לפי הצורך ואז לוחצים על החלת הפונקציה.

5. כדי לשמור את השינויים, לוחצים על יצירה. אחרת, לוחצים על ביטול.

   כשלוחצים על יצירה, פונקציית Cloud Run נוצרת ונפרסת, ואז נוצרת הבדיקה הסינתטית.

gcloud

אין שיטה ב-Google Cloud CLI שמאפשרת להעתיק בדיקה סינתטית.

REST

אין שיטת API שמאפשרת להעתיק בדיקה סינתטית. עם זאת, אפשר ליצור עותק באמצעות השלבים הבאים:

1. מבצעים קריאה ל-method‏ projects.uptimeCheckConfigs.get ושומרים את התגובה. מידע נוסף זמין במאמר בנושא הצגת הפרטים של בדיקה סינתטית.
2. עורכים את התשובה.
3. מבצעים קריאה ל-method‏ projects.uptimeCheckConfigs.create ומעבירים ל-method את התשובה הערוכה.

מחיקת מעקב סינתטי

המסוף

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

כדי למחוק בדיקה סינתטית ומדיניות התראות שמשויכת אליה:

1. במסוף Google Cloud , עוברים לדף  Synthetic monitoring:

   כניסה אל Synthetic monitoring

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

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

3. מאתרים את הבדיקה הסינתטית שרוצים למחוק ולוחצים על השם שלה.

4. אופציונלי: אם רוצים למחוק את פונקציית Cloud Run, בוחרים בכרטיסייה Code ואז לוחצים על שם הפונקציה. הדף פרטי הפונקציות ייפתח בחלון חדש.

5. בדף פרטים של בדיקה סינתטית, לוחצים על מחיקה ומשלימים את הפעולות בתיבת הדו-שיח.

   הסרתם את המוניטור הסינתטי.

6. כדי למחוק את פונקציית Cloud Run, עוברים לדף Functions details, לוחצים על Delete וממלאים את תיבת הדו-שיח.

gcloud

הערה: אי אפשר למחוק בדיקת זמינות או בדיקה סינתטית באמצעות Google Cloud CLI או Cloud Monitoring API אם יש מדיניות התראות שמשויכת לבדיקת הזמינות או לבדיקה הסינתטית. קודם צריך למחוק את כללי מדיניות ההתראות. מחיקה של בדיקה סינתטית לא מוחקת את פונקציית Cloud Run.

כדי למחוק בדיקת זמינות או בדיקה סינתטית, מריצים את הפקודה gcloud monitoring uptime delete:

gcloud monitoring uptime delete CHECK_ID  --project=PROJECT_ID

לפני שמריצים את הפקודה הקודמת, מחליפים את מה שכתוב בשדות הבאים:

• ‫PROJECT_ID: מזהה הפרויקט. בהגדרות של מרכז האפליקציות, בוחרים את פרויקט המארח או את פרויקט הניהול של מרכז האפליקציות.
• ‫CHECK_ID: המזהה של בדיקת הזמינות או של המוניטור הסינתטי. כדי למצוא את המזהה, מריצים את הפקודה gcloud monitoring uptime list-configs ובודקים את השדה name. מידע נוסף זמין במאמר בנושא איתור המזהה הייחודי של כלי מעקב סינתטי.

REST

הערה: אי אפשר למחוק בדיקת זמינות או בדיקה סינתטית באמצעות Google Cloud CLI או Cloud Monitoring API אם יש מדיניות התראות שמשויכת לבדיקת הזמינות או לבדיקה הסינתטית. קודם צריך למחוק את כללי מדיניות ההתראות. מחיקה של בדיקה סינתטית לא מוחקת את פונקציית Cloud Run.

כדי למחוק בדיקה סינתטית ומדיניות התראות משויכת, קוראים ל-method‏ projects.uptimeCheckConfigs.delete:

1. לוחצים על projects.uptimeCheckConfigs.delete.

2. משתמשים ב-APIs Explorer.

   מגדירים את ההורה של השיטה למזהה של המוניטור הסינתטי, ומוודאים שמשתמשים בפורמט הבא:

   projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
   

   בביטוי הקודם:

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

   כדי למצוא את הערך של CHECK_ID, אפשר להפעיל את השיטה projects.uptimeCheckConfigs.list. כדי לצמצם את מספר התוצאות שמוחזרות, צריך לכלול מסנן. לדוגמה, מוסיפים את המסנן displayName="MySyntheticMonitor".

איך מוצאים את המזהה הייחודי של בדיקה סינתטית

כשיוצרים בדיקה סינתטית, המערכת של Monitoring מקצה לה מזהה. המזהה הזה מוטמע בשם המשאב של המוניטור הסינטטי, והוא מופיע בפורמט הבא:

projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

ה-CHECK_ID נכלל בתגובה של שיטות Google Cloud CLI ו-Cloud Monitoring API שיוצרות או מציגות רשימה של בדיקות סינתטיות.

המאמרים הבאים

• יצירת מעקב סינתטי
• עיון בתוצאות של מעקב סינתטי