רישום יומני גישה של Apigee

הדף הזה מתייחס ל-Apigee, אבל לא ל-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

לקוחות עם מינוי ל-Apigee ולקוחות שמשלמים לפי שימוש יכולים להפעיל יומני גישה של תעבורת נתונים נכנסת ב-Cloud Logging לכל מופע של Apigee בארגון שלהם. אחרי שמפעילים את התכונה הזו, אפשר לראות את רישומי היומן שנוצרו על ידי שערים של תעבורת נתונים נכנסת (ingress) בתשתית Apigee, כמו מאזן עומסים של אפליקציות (ALB) חיצוני או שער Anthos, כדי לעזור בפתרון בעיות בקריאות ל-API של Apigee.

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

בנושא הזה מוסבר איך לקוחות Apigee יכולים להפעיל ולהשתמש ביומני גישה של תעבורת נתונים נכנסת (ingress) ב-Cloud Logging עבור מופעי Apigee בארגון שלהם.

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

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

  • תפקידים: אדמין ארגוני ב-Apigee‏ (roles/apigee.admin)
  • הרשאות:
    • apigee.instances.create
    • apigee.instances.update

בדיקת התפקידים

  1. נכנסים לדף IAM במסוף Google Cloud .

    כניסה לדף IAM
  2. בוחרים את הפרויקט.

  3. בעמודה Principal, מחפשים את השורה עם כתובת האימייל שלכם.

    אם כתובת האימייל לא מופיעה בעמודה הזאת, אין לכם אף תפקיד.

  4. בעמודה Role בשורה עם כתובת האימייל שלכם, בודקים אם רשימת התפקידים כוללת את התפקידים הנדרשים.

מתן התפקידים

  1. נכנסים לדף IAM במסוף Google Cloud .

    כניסה לדף IAM
  2. בוחרים את הפרויקט.
  3. לוחצים על Grant access.
  4. מזינים את כתובת האימייל שלכם בשדה New principals.
  5. בוחרים תפקיד מהרשימה Select a role.
  6. כדי להקצות תפקידים נוספים, לוחצים על Add another role ומוסיפים כל תפקיד נוסף.
  7. לוחצים על Save.

הפעלת רישום ביומן של גישה ל-ingress במופעי Apigee

אתם יכולים להפעיל את האפשרות 'רישום ביומן של גישה נכנסת ל-Cloud Logging' כשאתם יוצרים או עורכים מופע של Apigee באמצעות ממשק המשתמש של Apigee או ה-API.

כדי להפעיל את התכונה כשיוצרים או מעדכנים מופע של Apigee, פועלים לפי ההוראות במאמר ניהול מופעים כדי להתחיל ליצור או לערוך מופע.

ממשק המשתמש של Apigee

בקטע Logging בדף Create an instance או Edit instance:

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

    אם רוצים לכלול את כל היומנים, בלי קשר לקוד התגובה של HTTP, בוחרים באפשרות None (all HTTP responses).

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

    status_code > XX && status code <= YY

    לדוגמה:

    status_code >= 500 && status_code < 504

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

Apigee API

כדי לעדכן מופע קיים באמצעות Apigee API, משתמשים בפקודה הבאה: 

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME/instances/INSTANCE_NAME?updateMask=access_logging_config.enabled,access_logging_config.filter" \
    -X PATCH -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' -H 'Content-Type: application/json' \
    -d '{
      "name": "INSTANCE_NAME",
      "accessLoggingConfig":
        {
          "enabled": "true",
          "filter": "status_code >= 0 && status_code < 600 "
        }
      }'

כאשר:

  • ‫ORG_NAME הוא השם של הארגון שלכם ב-Apigee.
  • ‫INSTANCE_NAME הוא שם מופע Apigee שרוצים לערוך.

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

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

צפייה ביומני הגישה של תעבורת הכניסה

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

כדי להציג רשומות ביומן ב-Logs Explorer:

  1. במסוף Google Cloud , בוחרים באפשרות Logging > Logs Explorer.

    כניסה לדף Logs Explorer

  2. מוודאים שהפרויקט Google Cloud שלכם נבחר.
  3. בכרטיסייה Query, מזינים את שם היומן בשדה של עורך השאילתות Query באחת מהשיטות הבאות:
    • כדי להשתמש בתיבת הבחירה שם היומן:
      1. לוחצים על תיבת הסימון שם היומן כדי לפתוח את החלונית שם היומן.
      2. מזינים ingress_instance בתיבה Select log names (בחירת שמות של יומנים).
      3. לוחצים על אישור.
      4. שם היומן מופיע בשדה העריכה Query.
    • בשדה של עורך השאילתות, מזינים ישירות את שם היומן:

      logName="projects/ORG_NAME/logs/apigee.googleapis.com/ingress_instance"

  4. יוצרים את שאר השאילתה בשדה העריכה שאילתה. היומנים יופיעו ברשימה Query results.
  5. כדי לראות פרטים נוספים, לוחצים על רשומה ביומן.

פתרון בעיות באמצעות יומני גישה של Ingress

אחרי שמפעילים את התכונה והיומנים זמינים בכלי Logs Explorer, אפשר להשתמש במספר תכונות של Cloud Logging כדי לקבל עזרה בפתרון בעיות, כולל:

  • יצירת שאילתות באמצעות שפת השאילתות של Cloud Logging

    כדי לאחזר ולנתח יומנים באמצעות Logs Explorer, צריך לכתוב שאילתות בשדה של עורך השאילתות ולבחור באפשרויות של תפריטי המסננים שמופיעים עם רשומות היומן. מידע נוסף על יצירת שאילתות וניתוח נתונים ב-Logs Explorer זמין במאמר יצירה ושמירה של שאילתות באמצעות שפת השאילתות של Cloud Logging.

  • הפעלת מדדים והתראות שמבוססים על יומנים

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

    אפשר ליצור כללי מדיניות התראות שמבוססים על יומנים בכלי Logs Explorer. מידע נוסף והוראות מפורטות זמינים במאמר יצירת מדיניות התראות מבוססת-יומן באמצעות Logs Explorer.

  • סינון לפי קודי מצב HTTP

    אתם יכולים לצמצם את השאילתות ב-Logs Explorer כדי לסנן לפי קודי סטטוס של HTTP, גם אם לא בחרתם לסנן את יומני הגישה של התעבורה הנכנסת לפי קוד סטטוס של HTTP כשמפעילים את התכונה. כדי להוסיף את המסנן הזה לשאילתה, צריך להשתמש בפורמט הבא:

    status_code > XX && status code <= YY

    לדוגמה:

    status_code >= 500 && status_code < 504

  • סינון לפי קודי סטטוס של Ingress

    בנוסף לסינון לפי קודי מצב HTTP, אפשר ליצור שאילתה לסינון לפי ingress status_code 0. הקוד הזה מציין לרוב בעיה ברשת או בקישוריות שמונעת מהלקוח לקבל תגובה מהשרת.

הסבר מפורט על כל הפונקציות שזמינות ב-Logs Explorer מופיע במאמר צפייה ביומנים באמצעות Logs Explorer.

השבתת התכונה

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

אפשר לערוך את המופע כדי להשבית את התכונה באמצעות ממשק המשתמש של Apigee או ה-API.

ממשק המשתמש של Apigee

כדי להשבית את התכונה באמצעות ממשק המשתמש של Apigee:

  1. במסוף Google Cloud , נכנסים לדף Management > instances.

    כניסה לדף Instances

  2. לוחצים על המופע שרוצים לערוך.
  3. בדף פרטי האירוע, לוחצים על עריכה.
  4. בדף Edit Instance, לוחצים על המתג Enable logging כדי להשבית את התכונה.
  5. לוחצים על Save.

Apigee API

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

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME/instances/INSTANCE_NAME?updateMask=access_logging_config.enabled,access_logging_config.filter" \
    -X PATCH -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' -H 'Content-Type: application/json' \
    -d '{
      "name": "INSTANCE_NAME",
      "accessLoggingConfig":
        {
            "enabled": "false"
        }
        }'

כאשר:

  • ‫ORG_NAME הוא השם של הארגון שלכם ב-Apigee.
  • ‫INSTANCE_NAME הוא שם מופע Apigee שרוצים לערוך.