יצירת כלי לבדיקת קישורים שבורים

המסוף

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

Terraform

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

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

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

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

   gcloud auth application-default login

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

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

למידע נוסף, ראו הגדרת ADC לסביבת פיתוח מקומית במאמרי העזרה בנושא אימות Google Cloud .

REST

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

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

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

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

המסוף

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

1. מוודאים שהפעלתם את ממשקי ה-API הנדרשים, שהפרויקט מכיל חשבון שירות שמוגדר כברירת מחדל ב-Compute Engine, ושהחשבון הזה קיבל את התפקיד 'עריכה' (roles/editor). מידע נוסף זמין במאמר לפני שמתחילים.

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

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

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

3. בסרגל הכלים של מסוף Google Cloud , בוחרים את Google Cloud הפרויקט. בהגדרות של מרכז האפליקציות, בוחרים את הפרויקט המארח או את פרויקט הניהול של מרכז האפליקציות.
4. לוחצים על יצירת בדיקה סינתטית.
5. בוחרים בתבנית Broken link checker (בדיקת קישורים מנותקים).
6. מזינים שם לניטור הסינתטי.

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

8. מגדירים את ה-URI ואת הרכיבים לבדיקה:

   1. לוחצים על Origin URI ומזינים URI שרוצים לבדוק. הערך שאתם מזינים צריך להיות נקודת קצה מסוג HTTP או HTTPS. לדוגמה, אפשר להזין https://mywebsite.example.com.

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

   3. אופציונלי: בשדה HTML element selector (סלקטור של רכיבי HTML), מזינים את רכיבי ה-HTML שרוצים להתאים, כרשימה מופרדת בפסיקים. הערך שאתם מזינים מומר למחרוזת ואז מועבר לשיטה Document: querySelectorAll().

      כברירת מחדל, הערך של השדה הזה הוא a, שמתאים לעוגנים. אפשר להזין ערכים כמו a, img כשרוצים להתאים גם עוגנים וגם תמונות.

   4. אופציונלי: בשדה HTML attributes to follow (מאפייני HTML להוספה), מזינים את מאפייני ה-HTML שרוצים להתאים. הערכים המופרדים בפסיקים שאתם מזינים מועברים בנפרד לשיטה getAttribute().

      כברירת מחדל, השדה הזה מוגדר ל-href, שמציין את ה-URI של הקישור. אפשר להזין כמה מאפיינים. לדוגמה, אפשר להזין href, src. בדוגמה הזו, הקוד מחפש את המאפיין href ואז מחפש את המאפיין src.

   5. אופציונלי: הגדרת המתנה לבחירת רכיב, הגדרת זמן קצוב לתפוגה לכל URI, הגדרת ניסיונות חוזרים והגדרת קודי סטטוס צפויים:

      1. לוחצים על הצגת אפשרויות נוספות.

      2. כדי להגדיר את הכלי לבדיקת קישורים שבורים כך שימתין להופעה של סלקטור ספציפי ב-URI לפני שיתבצע גירוד של קישורים, מזינים את הסלקטורים ב-CSS בשדה Wait for element selector (המתנה לסלקטור של רכיב). הערך שאתם מזינים מומר למחרוזת ואז מועבר לשיטה page.waitForSelector().

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

      3. עדכון הסדר שבו הקישורים נבחרים לבדיקה.

      4. הגדרת ניסיונות חוזרים.

         כברירת מחדל, נשלחת בקשה אחת לכל קישור. אם הבקשה הראשונית נכשלת מסיבה כלשהי – למשל, אם פסק הזמן של הפקודה חלף או אם קוד הסטטוס של HTTP הוא לא 200 – הקישור מסומן כנכשל.

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

      5. מגדירים זמן קצוב לתפוגה שחל על כל URI. כברירת מחדל, הערך הזה מוגדר ל-30 שניות.

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

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

   gcm-PROJECT_ID-synthetics-LOCATION
   

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

   • ‫PROJECT_ID: מזהה הפרויקט ב- Google Cloud .
   • ‫LOCATION: המיקום של הקטגוריה שלכם ב-Cloud Storage.

   יש לכם אפשרות להשתמש בקטגוריה קיימת של Cloud Storage.

10. בודקים את ההגדרה ומוודאים שהיא נכונה ומלאה, ואז יוצרים את פונקציית Cloud Run:

    1. לוחצים על Create Function (יצירת פונקציה).

       הערכים בשדות הגדרת ה-URI מועתקים לאובייקט options בקובץ index.js כשלוחצים על יצירת פונקציה. אחרי שלוחצים על Create Function (יצירת פונקציה), כדי לשנות את ההגדרה, עורכים את האובייקט options.

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

    3. בקטע Runtime, build, connections and security settings (הגדרות של זמן ריצה, build, חיבורים ואבטחה):

       • בכרטיסייה Connections, מוודאים שהאפשרות Allow all traffic מסומנת.

       • בודקים את הגדרות ברירת המחדל ומעדכנים אותן לפי הצורך.

       • בשדה Runtime service account בוחרים חשבון שירות.

    4. לוחצים על החלת הפונקציה.

11. מגדירים את מדיניות ההתראות:

    1. אופציונלי: מעדכנים את השם של מדיניות ההתראות ואת משך הכישלון לפני שליחת ההתראות.

    2. מוסיפים את ערוצי ההתראות.

12. לוחצים על יצירה.

    פונקציית Cloud Run שהגדרתם נבנית ונפרסת כדור שני, והמוניטור הסינתטי נוצר.

Terraform

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

בודקי קישורים שבורים משתמשים בתבנית broken-links-ok. ההגדרה של הכלי לבדיקת קישורים שבורים מצוינת על ידי האובייקט options של הקובץ index.js.

כשמגדירים את המבנה options.screenshot_options, הכלי לבדיקת קישורים שבורים אוסף צילומי מסך ושומר אותם בקטגוריה של Cloud Storage. אם השדה screenshot_options.storage_location לא מוגדר או שהערך שלו הוא מחרוזת ריקה, Monitoring יוצר קטגוריה של Cloud Storage וצילומי המסך נשמרים בקטגוריה הזו. ב-Monitoring משתמשים במוסכמה הבאה כדי לתת שם לקטגוריה של Cloud Storage:

gcm-PROJECT_ID-synthetics-LOCATION

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

• ‫PROJECT_ID: מזהה הפרויקט ב- Google Cloud .
• ‫LOCATION: המיקום של הקטגוריה שלכם ב-Cloud Storage.

REST

תהליך היצירה של כלי לבדיקת קישורים שבורים באמצעות Cloud Monitoring API זהה לתהליך היצירה של כל כלי אחר למעקב סינתטי. מידע על שימוש ב-Cloud Monitoring API כדי ליצור בדיקה סינתטית זמין במאמר יצירת בדיקה סינתטית. צריך לבחור בכרטיסייה REST.

בודקי קישורים שבורים משתמשים בתבנית broken-links-ok. ההגדרה של הכלי לבדיקת קישורים שבורים מצוינת על ידי האובייקט options של הקובץ index.js.

כשמגדירים את המבנה options.screenshot_options, הכלי לבדיקת קישורים שבורים אוסף צילומי מסך ושומר אותם בקטגוריה של Cloud Storage. אם השדה screenshot_options.storage_location לא מוגדר או שהערך שלו הוא מחרוזת ריקה, Monitoring יוצר קטגוריה של Cloud Storage וצילומי המסך נשמרים בקטגוריה הזו. ב-Monitoring משתמשים במוסכמה הבאה כדי לתת שם לקטגוריה של Cloud Storage:

gcm-PROJECT_ID-synthetics-LOCATION

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

• ‫PROJECT_ID: מזהה הפרויקט ב- Google Cloud .
• ‫LOCATION: המיקום של הקטגוריה שלכם ב-Cloud Storage.