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

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

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

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

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

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

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

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

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

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

• בוחרים את הממשק שבו רוצים להשתמש:

  המסוף

  כשמשתמשים במסוף Google Cloud כדי לגשת לשירותים Google Cloud ולממשקי ה-API, לא צריך להגדיר אימות.

  gcloud

  במסוף Google Cloud , מפעילים את Cloud Shell.

  הפעלת Cloud Shell

  בחלק התחתון של Google Cloud המסוף יתחיל סשן של Cloud Shell ותופיע הודעה של שורת הפקודה. Cloud Shell היא סביבת מעטפת שבה ה-CLI של Google Cloud מותקן ומוגדרים ערכים לפרויקט הקיים. הסשן יופעל תוך כמה שניות.

  REST

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

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

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

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

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

המסוף

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

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

   מעבר אל מעקב סינתטי

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

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

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

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

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

   אם יש לכם כמה מסננים, הם יצורפו אוטומטית באמצעות האופרטור הלוגי AND, אלא אם תוסיפו מסנן OR.

בדף 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.

   מגדירים את parent לשם הפרויקט. צריך להשתמש בפורמט הבא:

   projects/PROJECT_ID
   

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

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

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

המסוף

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

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

   מעבר אל מעקב סינתטי

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

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

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

   אם רוצים לראות את פונקציית Cloud Run בדף פרטי הפונקציה שמופיע ב-Cloud 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 הוא המזהה של הבדיקה הסינתטית.

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

   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:

   מעבר אל מעקב סינתטי

   אם משתמשים בשורת החיפוש כדי למצוא את הדף הזה, בוחרים בתוצאה שכותרת המשנה שלה היא 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:

   מעבר אל מעקב סינתטי

   אם משתמשים בשורת החיפוש כדי למצוא את הדף הזה, בוחרים בתוצאה שכותרת המשנה שלה היא 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:

   מעבר אל מעקב סינתטי

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

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

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

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

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

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

6. כדי למחוק את פונקציית Cloud Run, עוברים לדף Function 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 שיוצרות או מפרטות בדיקות סינתטיות.

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

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