504 זמן קצוב לתפוגה של Gateway - תם הזמן הקצוב לתפוגה של הנתב

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X.
מידע

תיאור הבעיה

אפליקציית הלקוח מקבלת קוד סטטוס של HTTP‏ 504 עם ההודעה Gateway Timeout בתגובה לקריאות ל-API.

תגובת השגיאה הזו מציינת שהלקוח לא קיבל תגובה בזמן מ-Apigee Edge או משרת הקצה העורפי במהלך הביצוע של קריאה ל-API.

הודעת שגיאה

אפליקציית הלקוח מקבלת את קוד התגובה הבא:

HTTP/1.1 504 Gateway Time-out

כשמתקשרים ל-proxy כזה באמצעות cURL או דפדפן אינטרנט, יכול להיות שתופיע השגיאה הבאה:

<!DOCTYPE html>
<html>
<head>
<title>Error</title>
<style>
    body {
        width: 35em;
        margin: 0 auto;
        font-family: Tahoma, Verdana, Arial, sans-serif;
    }
</style>
</head>
<body>
<h1>An error occurred.</h1>
<p>Sorry, the page you are looking for is currently unavailable.<br/>
Please try again later.</p>
</body>
</html>

מה גורם לפסק זמן?

הנתיב הרגיל של בקשת API דרך פלטפורמת Edge הוא Client > Router > Message Processor > Backend Server, כמו שמוצג באיור הבא:

כל הרכיבים בתהליך של זמן הריצה של Apigee Edge, כולל לקוחות, נתבים, מעבדי בקשות ושרתים בקצה העורפי, מוגדרים עם ערכי זמן קצוב לתפוגה מתאימים כברירת מחדל כדי להבטיח שבקשות ה-API לא יימשכו זמן רב מדי. אם אחד מהרכיבים בתהליך לא מקבל את התגובה מהרכיב במעלה הזרם בפרק הזמן שצוין בהגדרת הזמן הקצוב לתפוגה, הרכיב הספציפי יגיע לזמן קצוב לתפוגה ובדרך כלל יחזיר 504 Gateway Timeoutשגיאה.

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

פסק זמן בנתב

ברירת המחדל של הזמן הקצוב לתפוגה שמוגדר בנתבים ב-Apigee Edge היא 57 שניות. זהו משך הזמן המקסימלי שבו proxy ל-API יכול לפעול מרגע קבלת בקשת ה-API ב-Edge ועד שליחת התגובה בחזרה, כולל התגובה של ה-Backend וכל כללי המדיניות שמופעלים. אפשר לשנות את הגדרת ברירת המחדל של הזמן הקצוב לתפוגה בנתבים או במארחים וירטואליים, כמו שמוסבר במאמר בנושא הגדרת זמן קצוב לתפוגה של קלט/פלט בנתבים.

גורמים אפשריים

ב-Edge, הסיבות האופייניות לשגיאת 504 Gateway Timeout שנגרמת בגלל פסק זמן של הנתב הן:

סיבה תיאור הוראות לפתרון בעיות שרלוונטיות ל
הגדרת זמן קצוב לתפוגה שגויה בנתב המצב הזה קורה אם נתב מוגדר עם תקופת פסק זמן שגויה של קלט/פלט. משתמשים ב-Edge Public Cloud וב-Edge Private Cloud

שלבים נפוצים לאבחון

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

  • מעקב אחר API
  • יומני גישה של NGINX

מעקב אחר API

כדי לאבחן את השגיאה באמצעות הכלי 'מעקב אחר API':

  1. עוברים לדף Analyze > API Monitoring > Investigate.
  2. מסננים לפי 5xx שגיאות ובוחרים את מסגרת הזמן.
  3. משרטטים את קוד הסטטוס מול הזמן.
  4. כדי לראות פרטים נוספים ויומני רישום של השגיאות, לוחצים על התא הספציפי שבו מוצגות 504 שגיאות, כמו שמוצג בהמשך:

    דוגמה להצגת שגיאות 504

  5. בחלונית השמאלית, לוחצים על הצגת יומנים.

    בחלון Traffic Logs, שימו לב לפרטים הבאים לגבי חלק מהשגיאות מסוג 504:

    • בקשה: כאן מפורטים שיטת הבקשה ומזהה ה-URI ששימשו ליצירת הקריאות
    • זמן התגובה: כאן מוצג הזמן הכולל שחלף מאז הבקשה.

    בדוגמה שלמעלה,

    • הבקשה מפנה אל GET /test-timeout.
    • זמן התגובה הוא 57.001 שניות. המשמעות היא שהזמן הקצוב לתפוגה של הנתב הסתיים לפני שהמעבד של ההודעות הצליח להגיב, כי הערך קרוב מאוד לזמן הקצוב לתפוגה של קלט/פלט שמוגדר בנתב כברירת מחדל, שהוא 57 שניות.

    אפשר גם לקבל את כל היומנים באמצעות API Monitoring GET logs API. לדוגמה, אם תריצו שאילתה ביומנים לגבי org, ‏env, ‏timeRange ו-status, תוכלו להוריד את כל היומנים של טרנזקציות שבהן חלף הזמן הקצוב לתגובה של הלקוח.

    מכיוון שב-API Monitoring מוגדר ה-proxy ל-- (not set) עבור השגיאות האלה 504, אפשר להשתמש ב-API (Logs API) כדי לקבל את ה-proxy המשויך למארח הווירטואלי ולנתיב.

    לדוגמה :

    curl "https://apimonitoring.enterprise.apigee.com/logs/apiproxies?org=ORG&env=ENV&select=https
    
  6. בודקים את זמן התגובה כדי לראות אם יש שגיאות נוספות מסוג 504, ומוודאים שזמן התגובה עקבי (ערך הזמן הקצוב לתפוגה של קלט/פלט שמוגדר בנתב הוא 57 שניות) בכל השגיאות מסוג 504.

יומני גישה של NGINX

כדי לאבחן את השגיאה באמצעות יומני הגישה של NGINX:

  1. בודקים את יומני הגישה של NGINX:
    /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log
  2. מחפשים כדי לראות אם יש 504 שגיאות במהלך תקופה מסוימת (אם הבעיה קרתה בעבר) או אם יש בקשות שעדיין נכשלות עם 504.
  3. הערה לגבי חלק מהשגיאות 504:
    • זמן תגובה
    • ‫URI של בקשה

    בדוגמה הזו, אנחנו רואים את המידע הבא:

    • זמן הבקשה: 57.001 שניות. ההודעה הזו מציינת שהנתב הגיע לפסק זמן אחרי 57.001 שניות.

    • בקשה: GET /test-timeout
    • כינוי של המארח: myorg-test.apigee.net
  4. בודקים אם זמן הבקשה זהה לזמן הקצוב לתפוגה של קלט/פלט שהוגדר בנתב או במארח הווירטואלי. אם כן, המשמעות היא שחלף הזמן הקצוב לתגובה של הנתב לפני שמעבד ההודעות הגיב במהלך התקופה הזו.

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

  5. כדי לקבוע את שרת ה-proxy ל-API שאליו נשלחה הבקשה, משתמשים בנתיב הבסיסי בשדה Request .

הסיבה: הגדרת פסק זמן שגויה בנתב

אבחון

  1. בודקים אם השגיאות 504 נגרמות בגלל שהזמן הקצוב לתפוגה של הנתב הסתיים לפני שמעבד ההודעות הצליח להגיב. כדי לעשות את זה, בודקים אם זמן התגובה ב'מעקב אחר API' או זמן הבקשה בנתב (שני השדות האלה מייצגים את אותו מידע, אבל השמות שלהם שונים) זהה לזמן הקצוב לתפוגה של קלט/פלט שהוגדר בנתב או במארח וירטואלי, ואם השדות מקור השגיאה, שרת proxy של השגיאה וקוד השגיאה מוגדרים לערך - באמצעות 'מעקב אחר API' או יומני גישה של NGINX, כמו שמוסבר ב שלבים נפוצים לאבחון.
  2. בודקים אם ערך הזמן הקצוב לתפוגה של קלט/פלט שהוגדר בנתב או במארח וירטואלי ספציפי הוא נמוך יותר בהשוואה לערך שהוגדר במעבד ההודעות או ב-API Proxy הספציפי.

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

אימות של פסק זמן לקלט/פלט במארחים וירטואליים

ממשק משתמש של Edge

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

  1. מתחברים לממשק המשתמש של Edge.
  2. עוברים אל ניהול > מארחים וירטואליים.
  3. בוחרים סביבה ספציפית שבה נתקלים בבעיית פסק הזמן.
  4. בוחרים את המארח הווירטואלי הספציפי שרוצים לאמת את ערך הזמן הקצוב לתפוגה של קלט/פלט.
  5. בקטע Properties (מאפיינים), רואים את הערך של Proxy Read Timeout (זמן קצוב לתפוגה של קריאת Proxy) בשניות.

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

Management APIs

אפשר גם לאמת את זמן הקצוב לתפוגה של קריאת ה-Proxy באמצעות ממשקי הניהול הבאים:

  1. מריצים את ה-API‏ Get virtual host כדי לקבל את ההגדרה של virtualhost כמו שמוצג בהמשך:

    משתמש בענן ציבורי

    curl -v -X GET https://api.enterprise.apigee.com/v1/organizations/ORGANIZATION_NAME/environments/ENVIRONMENT_NAME/virtualhosts/VIRTUALHOST_NAME -u USERNAME
    

    משתמש בענן פרטי

    curl -v -X GET http://MANAGEMENT_SERVER_HOST:PORT#/v1/organizations/ORGANIZATION_NAME/environments/v/virtualhosts/VIRTUALHOST_NAME -u USERNAME
    

    כאשר:

    ‫ORGANIZATION_NAME הוא שם הארגון

    ‫ENVIRONMENT_NAME הוא שם הסביבה

    ‫VIRTUALHOST_NAME הוא השם של המארח הווירטואלי

  2. בודקים את הערך שהוגדר לנכס proxy_read_timeout

    הגדרה לדוגמה של מארח וירטואלי

    {
      "hostAliases": [
        "api.myCompany,com",
      ],
      "interfaces": [],
      "listenOptions": [],
      "name": "secure",
      "port": "443",
      "retryOptions": [],
      "properties": {
        "property": [
          {
            "name": "proxy_read_timeout",
            "value": "120"
          }
        ]
      },
      "sSLInfo": {
        "ciphers": [],
        "clientAuthEnabled": "false",
        "enabled": "true",
        "ignoreValidationErrors": false,
        "keyAlias": "myCompanyKeyAlias",
        "keyStore": "ref://myCompanyKeystoreref",
        "protocols": []
      },
      "useBuiltInFreeTrialCert": false
    }

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

אימות פסק זמן של קלט/פלט בקובץ router.properties

  1. מתחברים למכונת נתב.
  2. מחפשים את הנכס proxy_read_timeout בספרייה /opt/nginx/conf.d ובודקים אם הערך החדש הוגדר לו באופן הבא:
    grep -ri "proxy_read_timeout" /opt/nginx/conf.d
    
  3. בודקים את הערך שהוגדר למאפיין proxy_read_timeout בקובץ ההגדרות של המארח הווירטואלי הספציפי.

    תוצאה לדוגמה מפקודת grep

    /opt/nginx/conf.d/0-default.conf:proxy_read_timeout 57;
    /opt/nginx/conf.d/0-edge-health.conf:proxy_read_timeout 1s;

    בדוגמת הפלט שלמעלה, אפשר לראות שהמאפיין proxy_read_timeout הוגדר עם הערך החדש 57 ב-0-default.conf, שהוא קובץ ההגדרות של המארח הווירטואלי שמוגדר כברירת מחדל. ההגדרה הזו מציינת שזמן ההמתנה לקלט/פלט מוגדר ל-57 שניות בנתב עבור המארח הווירטואלי שמוגדר כברירת מחדל. אם יש לכם כמה מארחים וירטואליים, תראו את המידע הזה לכל אחד מהם. מקבלים את הערך של proxy_read_timeout עבור המארח הווירטואלי הספציפי שבו השתמשתם כדי לבצע את קריאות ה-API שנכשלו עם שגיאות 504.

אימות של פסק זמן של קלט/פלט ב-API proxy

אפשר לראות את הזמן הקצוב לתפוגה של קלט/פלט במיקומים הבאים:

  • נקודת הקצה של שרת ה-proxy ל-API
  • מדיניות ServiceCallout של proxy ל-API
הצגת הזמן הקצוב לתפוקה/קלט בנקודת הקצה של proxy ל-API
  1. בממשק המשתמש של Edge, בוחרים את ה-proxy ל-API הספציפי שבו רוצים לראות את ערך הזמן הקצוב לתפוגה של קלט/פלט.
  2. בוחרים את נקודת הקצה הספציפית שאותה רוצים לבדוק.
  3. בודקים את המאפיין io.timeout.millis עם ערך מתאים ברכיב <HTTPTargetConnection> בהגדרות TargetEndpoint.

    לדוגמה, הזמן הקצוב לתפוגה של קלט/פלט בקוד הבא מוגדר ל-120 שניות:

    <Properties>
      <Property name="io.timeout.millis">120000</Property>
    </Properties>
הצגת פסק זמן של קלט/פלט במדיניות ServiceCallout של proxy ל-API
  1. בממשק המשתמש של Edge, בוחרים את ה-proxy ל-API הספציפי שבו רוצים לראות את ערך הזמן הקצוב לתפוגה של קלט/פלט חדש למדיניות ServiceCallout.
  2. בוחרים את מדיניות ServiceCallout הספציפית שרוצים לבדוק.
  3. אפשר לראות את הרכיב <Timeout> עם ערך מתאים בהגדרה של <ServiceCallout>.

    לדוגמה, פסק הזמן של קלט/פלט בקוד הבא יהיה 120 שניות:

    <Timeout>120000</Timeout>

אימות של פסק זמן לקלט/פלט במעבדי ההודעות

  1. מתחברים למכונה של מעבד ההודעות.
  2. מחפשים את המאפיין HTTPTransport.io.timeout.millis בספרייה /opt/apigee/edge-message-processor/conf באמצעות הפקודה הבאה:

    grep -ri "HTTPTransport.io.timeout.millis" /opt/apigee/edge-message-processor/conf
    

    פלט לדוגמה

    /opt/apigee/edge-message-processor/conf/http.properties:HTTPTransport.io.timeout.millis=55000
  3. בדוגמת הפלט שלמעלה, אפשר לראות שהמאפיין HTTPTransport.io.timeout.millis הוגדר עם הערך 55000 ב-http.properties. המשמעות היא שפסק הזמן של קלט/פלט הוגדר בהצלחה ל-55 שניות במעבד ההודעות.

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

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

זמן קצוב לתפוגה בנתב (בשניות) הזמן הקצוב לתפוגה של מארח וירטואלי (בשניות) הזמן הקצוב לתפוגה במעבד ההודעות (בשניות) זמן קצוב לתפוגה ב-proxy ל-API (בשניות)
57 - 55 120

במשפט הזה,

  • ערך ברירת המחדל של 57 שניות מוגדר בנתב.
  • ערך הזמן הקצוב לתפוגה לא מוגדר במארח הווירטואלי הספציפי. כלומר, המערכת תשתמש בערך ברירת המחדל של 57 שניות שמוגדר בנתב עצמו.
  • במעבד ההודעות, מוגדר ערך ברירת מחדל של 55 שניות.
  • עם זאת, ב-API Proxy הספציפי, מוגדר ערך של 120 שניות.

שימו לב: ערך הזמן הקצוב לתפוגה הגבוה יותר מוגדר רק ב-proxy ל-API, אבל הנתב עדיין מוגדר עם 57 שניות. לכן, הנתב מגיע לפסק זמן אחרי 57 שניות, בזמן שמעבד ההודעות או ה-backend עדיין מעבדים את הבקשה. כתוצאה מכך, הנתב מגיב עם שגיאת 504 Gateway Timeout לאפליקציית הלקוח.

רזולוציה

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

  1. כדי להבין אילו ערכי זמן קצוב לתפוגה צריך להגדיר ברכיבים שונים שמעורבים בתהליך של בקשת API דרך Apigee Edge, אפשר לעיין במאמר בנושא שיטות מומלצות להגדרת זמן קצוב לתפוגה של קלט/פלט.
  2. בדוגמה שלמעלה, אם קבעתם שצריך להגדיר ערך זמן קצוב לתפוגה גבוה יותר כי שרת הבק-אנד דורש זמן ארוך יותר, והגדלתם את ערך זמן קצוב לתפוגה של מעבד הבקשות ל-120 שניות, אז הגדירו ערך זמן קצוב לתפוגה גבוה יותר. לדוגמה: 123 seconds בנתב. כדי למנוע השפעה על כל ה-API Proxy בגלל ערך הזמן הקצוב לתפוגה החדש, צריך להגדיר את הערך של 123 seconds רק במארח הווירטואלי הספציפי שבו נעשה שימוש ב-API Proxy הספציפי.
  3. פועלים לפי ההוראות במאמר הגדרת פסק זמן לקלט/פלט בנתבים כדי להגדיר את פסק הזמן במארח הוירטואלי.