502 Bad Gateway – ToBigBody

מוצג המסמך של Apigee Edge.
עוברים אל מסמכי תיעוד של Apigee X. מידע

תיאור הבעיה

אפליקציית הלקוח מקבלת קוד סטטוס HTTP של 502 Bad Gateway עם קוד שגיאה protocol.http.TooBigBody כתגובה לקריאות ל-API.

הודעת שגיאה

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

HTTP/1.1 502 Bad Gateway

בנוסף, יכול להיות שתופיע הודעת השגיאה הבאה:

{
   "fault":{
      "faultstring":"Body buffer overflow",
      "detail":{
         "errorcode":"protocol.http.TooBigBody"
      }
   }
}

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

השגיאה הזו מתקבלת אם גודל המטען הייעודי (Payload) שנשלח על ידי שרת היעד/הקצה העורפי אל Apigee Edge כחלק של תגובת HTTP גדולה מהמגבלה המותרת ב-Apigee Edge.

אלה הסיבות האפשריות לשגיאה:

סיבה	תיאור	הוראות לפתרון בעיות עבור
גודל המטען הייעודי (payload) של התגובה חורג מהמגבלה המותרת	גודל המטען הייעודי (Payload) שנשלח על ידי שרת היעד/הקצה העורפי כחלק מתגובת HTTP ל-Apigee הוא חורגת מהמגבלה המותרת ב-Apigee.	משתמשי Edge בענן הציבורי והפרטי
גודל המטען הייעודי של התשובות חורג מהמגבלה המותרת אחרי שחרור דחיסה	גודל המטען הייעודי (Payload) שנשלח בפורמט דחוס על ידי שרת היעד/שרת הקצה העורפי כחלק מ-HTTP התגובה ל-Apigee חורגת מהמגבלה המותרת כשמבטלים את הדחיסה על ידי Apigee.	משתמשי Edge בענן הציבורי והפרטי

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

יש להשתמש באחד מהכלים או השיטות הבאים כדי לאבחן את השגיאה:

הסיבה: הגודל של המטען הייעודי (payload) של התגובה חורג מהמגבלה המותרת

אבחון

1. קובעים את Fault Code (קוד שגיאה), מקור התקלה וגודל מטען ייעודי (payload) של תגובה עבור. השגיאה שמופיעה באמצעות API Monitoring, כלי מעקב או יומני גישה ל-NGINX, כמו שמוסבר ב שלבי אבחון נפוצים בתרחיש מס' 1.
2. אם הערך של מקור התקלה הוא target, סימן שהתגובה גודל המטען הייעודי (Payload) שנשלח על ידי שרת היעד/הקצה העורפי ל-Apigee גדול מ- המגבלה המותרת ב-Apigee Edge.
3. מאמתים את גודל המטען הייעודי (payload) של התגובה כפי שנקבע משלב 1.
   • אם גודל המטען הייעודי (Payload) > מגבלת הגודל של 10 MB, אז זו הסיבה לשגיאה.
   • אם גודל המטען הייעודי (payload) הוא בגודל של בערך 10MB, יכול להיות שהתשובה המטען הייעודי מועבר בפורמט דחוס. המשך אל הסיבה: גודל המטען הייעודי של התגובה חורג מהמגבלה המותרת אחרי ביטול הדחיסה.
4. מוודאים שגודל המטען הייעודי (payload) של התגובה הוא אכן > המגבלה של 10 MB מאפשרת לבדוק את את התשובה בפועל באמצעות השלבים הבאים:
   1. אם אין לכם גישה לבקשה שנשלחה בפועל לשרת היעד או לשרת העורפי, עוברים לקטע רזולוציה.
   2. אם יש לכם גישה לבקשה שנשלחה בפועל לשרת היעד או לשרת העורפי, אז מבצעים את השלבים הבאים:
      1. אם את/ה משתמש/ת בענן ציבורי/בענן פרטי, עליך להגיש בקשה ישירות אל שרת הקצה העורפי משרת הקצה העורפי עצמו או מכל מחשב אחר שממנו אתם מורשים לשלוח את הבקשה לשרת הקצה העורפי.
      2. אם אתם משתמשים פרטיים בענן, תוכלו גם לשלוח את הבקשה בשרת העורפי מאחד ממעבדי ההודעות.
      3. מוודאים את גודל המטען הייעודי (Payload) שמועבר בתשובה על ידי בדיקת המקטע כותרת אורך התוכן.
      4. אם גודל המטען הייעודי (Payload) גדול מ- המותר ב-Apigee Edge, אז זו הסיבה בעיה.

   תגובה לדוגמה משרת הקצה העורפי:

   curl -v https://BACKENDSERVER-HOSTNAME/testfile
   

   * About to connect() to 10.14.0.10 port 9000 (#0)
   *   Trying 10.14.0.10...
   * Connected to 10.14.0.10 (10.148.0.10) port 9000 (#0)
   > GET /testfile HTTP/1.1
   > User-Agent: curl/7.29.0
   > Host: 10.14.0.10:9000
   > Accept: */*
   >
   < HTTP/1.1 200 OK
   < Accept-Ranges: bytes
   < Content-Length: 11534336
   < Content-Type: application/octet-stream
   < Last-Modified: Wed, 30 Jun 2021 08:18:02 GMT
   < Date: Wed, 30 Jun 2021 09:22:41 GMT
   <
   ----snipped----
   <Response Body>
   

   בדוגמה שלמעלה, אפשר לראות ש-Content-Length: 11534336 (which is ~11 MB) היא הסיבה לשגיאה הזו כי היא חורגת מ- מוגבלת ב-Apigee Edge.

רזולוציה

אפשר למצוא מידע נוסף בקטע רזולוציה.

הסיבה: גודל המטען הייעודי של התגובה חורג מהמגבלה המותרת אחרי שחרור דחיסה

אם המטען הייעודי של התשובה נשלח בפורמט דחוס ובכותרת התשובה השדה Content-Encoding מוגדר ל-gzip, Apigee מבטל את הדחיסה של התגובה מטען ייעודי (payload). בתהליך ביטול הדחיסה, אם גודל המטען הייעודי (payloade) גדול יותר ב-Apigee מה מגבלה המותרת ב-Apigee Edge., ואז היא מפסיקה עוד פותחים דחיסה ומגיבים באופן מיידי עם 502 Bad Gateway וקוד השגיאה protocol.http.TooBigBody.

אבחון

1. קובעים את קוד השגיאה,Fault Source וגודל המטען הייעודי של התגובה עבור השגיאה שזוהתה באמצעות יומני API Monitoring, Trace Tool או NGINX Access כמו שמוסבר ב- שלבי אבחון נפוצים בתרחיש מס' 2.
2. אם ל-Fault Source יש את הערך target, זה מציין גודל המטען הייעודי (payload) שנשלח על ידי אפליקציית היעד/הקצה העורפי ל-Apigee גדול מ- מגבלה מותרת ב-Apigee Edge.
3. מאמתים את גודל המטען הייעודי (payload) של התגובה כפי שנקבע משלב 1.
   • אם גודל המטען הייעודי (Payload) > מגבלת הגודל של 10MB, אז זו הסיבה לשגיאה.
   • אם גודל המטען הייעודי (Payload) מותר בערך ב-10MB, יכול להיות שהמטען הייעודי (Payload) של התגובה יכול להיות מועבר בפורמט דחוס. במקרה הזה, צריך לבדוק את הגודל הלא דחוס של דחיסת הנתונים מטען ייעודי (payload) של תגובה.
4. אפשר לבדוק אם התגובה מהיעד או מהקצה העורפי נשלחה בפורמט דחוס וגם הגודל הלא דחוס היה גדול מהמגבלה המותרת באמצעות אחת מהאפשרויות הבאות אמצעי תשלום:

   Trace

   באמצעות כלי המעקב:

   1. אם תיעדתם מעקב אחר הבקשה שנכשלה, עיינו בשלבים המפורטים ב Trace וגם
      1. קובעים את הערך של target.received.content.length
      2. לבדוק אם הבקשה מהלקוח מכילה את הכותרת Content-Encoding: gzip
   2. אם הערך של target.received.content.length הוא בערך מ-10MB המותר ואת כותרת התגובה Content-Encoding: gzip , והכותרת היא את הסיבה לשגיאה.

   הבקשה בפועל

   באמצעות הבקשה בפועל:

   1. אם אין לכם גישה לבקשה שנשלחה בפועל לשרת היעד או לשרת העורפי, עוברים לקטע רזולוציה.
   2. אם יש לכם גישה לבקשה שנשלחה בפועל לשרת היעד או לשרת העורפי, אז מבצעים את השלבים הבאים:
      1. אימות גודל המטען הייעודי (Payload) שמועבר בתשובה יחד עם הפרמטר הכותרת Content-Encoding נשלחה בתשובה.
      2. אם כותרת התגובה Content-Encoding מוגדרת לערך gzip והגודל הלא דחוס של המטען הייעודי (Payload) גדול מ- מותר להשתמש ב-Apigee Edge, אז זו הסיבה שגיאה זו.

         תגובה לדוגמה שהתקבלה משרת הקצה העורפי:

         curl -v https://BACKENDSERVER-HOSTNAME/testzippedfile.gz
         

         * About to connect() to 10.1.0.10 port 9000 (#0)
         *   Trying 10.1.0.10...
         * Connected to 10.1.0.10 (10.1.0.10) port 9000 (#0)
         > GET /testzippedfile.gz HTTP/1.1
         > User-Agent: curl/7.29.0
         > Host: 10.1.0.10:9000
         > Accept: */*
         >
         < HTTP/1.1 200 OK
         < Accept-Ranges: bytes
         < Content-Encoding: gzip
         < Content-Type: application/x-gzip
         < Last-Modified: Wed, 30 Jun 2021 08:18:02 GMT
         < Testheader: test
         < Date: Wed, 07 Jul 2021 10:14:16 GMT
         < Transfer-Encoding: chunked
         <
         ----snipped----
         <Response Body>
         

         במקרה שלמעלה, הכותרת Content-Encoding: gzip נשלחת ו גודל הקובץ testzippedfile.gz בתגובה קטן מ- אבל הגודל של הקובץ הלא דחוס testzippedfile היה כ-15MB.

   יומני מעבד ההודעות

   באמצעות יומני מעבד ההודעות:

   1. אם אתם משתמשים ב-Private Cloud, תוכלו להשתמש ביומנים של מעבד ההודעות כדי: לדעת את המידע העיקרי לגבי שגיאות HTTP 502.

   2. בדיקת היומנים של מעבד ההודעות

      /opt/apigee/var/log/edge-message-processor/logs/system.log

   3. אפשר לחפש אם יש שגיאות 502 בטווח זמן ספציפי (אם הבעיה אירעה בעבר) או אם יש בקשות שעדיין לא נענו 502 אפשר להשתמש במחרוזות החיפוש הבאות:

      grep -ri "chunkCount"
      

      grep -ri "BadGateway: Body buffer overflow"
      

   4. יופיעו שורות מ-system.log דומות לאלה שמוצגות למטה (TotalRead ו-chunkCount עשויים להשתנות במקרה שלך):

      2021-07-07 09:40:47,012  NIOThread@7 ERROR HTTP.SERVICE -
      TrackingInputChannel.checkMessageBodyTooLarge() : Message is too large.
      TotalRead 10489856 chunkCount 2571
      
      2021-07-07 09:40:47,012  NIOThread@7 ERROR HTTP.CLIENT -
      HTTPClient$Context.onInputException() :
      ClientInputChannel(ClientChannel[Connected:
      Remote:10.148.0.10:9000 Local:10.148.0.9:42240]@9155
      useCount=1 bytesRead=0 bytesWritten=182 age=23ms  lastIO=0ms
      isOpen=true).onExceptionRead exception: {}
      com.apigee.errors.http.server.BadGateway: Body buffer overflow
      
      2021-07-07 09:40:47,012  NIOThread@7 ERROR
      ADAPTORS.HTTP.FLOW - AbstractResponseListener.onException() :
      AbstractResponseListener.onError(HTTPResponse@77cbd7c4,
      Body buffer overflow)
      

   5. בתהליך הסרת הדחיסה, ברגע שמעבד ההודעות קובע סך הבייטים שנקראו הוא > בגודל 10MB, היא עוצרת ומדפיסה את השורה הבאה:

      Message is too large. TotalRead 10489856 chunkCount 2571

      הוא רומז שגודל המטען הייעודי של התגובה גדול מ-10MB וב-Apigee גורמת לשגיאה כשהגודל מתחיל לחרוג מהמגבלה של 10MB עם קוד שגיאה כמו protocol.http.TooBigBody

רזולוציה

מגבלות

Apigee מצפה שאפליקציית הלקוח ושרת הקצה העורפי לא ישלחו גדלים של מטען ייעודי (payload) שגדולים מ- המגבלה המותרת לפי תיעוד של Request/response size ב- מגבלות ב-Apigee Edge.

1. אם אתם משתמשים בענן הציבורי, המגבלה המקסימלית של בקשות ותגובה גודל המטען הייעודי (Payload) מתועד עבור Request/response size ב- מגבלות ב-Apigee Edge.
2. אם אתם משתמשים בענן פרטי , יכול להיות ששיניתם את ערך ברירת המחדל המקסימלי מגבלת גודל המטען הייעודי (payload) של הבקשות והתשובות (למרות שלא מומלץ לעשות זאת). כדי לקבוע את מגבלת הגודל המקסימלי של מטען ייעודי (payload) של בקשות, צריך לפעול לפי ההוראות הבאות: איך בודקים את המגבלה הנוכחית

איך בודקים את המגבלה הנוכחית?

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

1. במעבד הודעות, מחפשים את המאפיין. HTTPResponse.body.buffer.limit בספרייה /opt/apigee/edge-message- processor/conf ולבדוק איזה ערך הוגדר באופן הבא:

   grep -ri "HTTPResponse.body.buffer.limit" /opt/apigee/edge-message-processor/conf
   

2. התוצאה לדוגמה מהפקודה שלמעלה היא:

   /opt/apigee/edge-message-processor/conf/http.properties:HTTPResponse.body.buffer.limit=10m
   

3. בפלט לדוגמה שלמעלה, שימו לב שהמאפיין HTTPResponse.body.buffer.limit הוגדר עם הערך 10m ב- http.properties.

   מציינת שהמגבלה של גודל המטען הייעודי (payload) של הבקשה מוגדרת ב-Apigee נפח הענן הפרטי הוא 10MB.

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

חובה לאסוף פרטי אבחון

אוספים את פרטי האבחון הבאים ופונים לתמיכה של Apigee Edge:

אם אתם משתמשים ב-Public Cloud, עליכם לספק את הפרטים הבאים:

• שם הארגון
• שם הסביבה
• שם ה-API של ה-Proxy
• צריך להשלים את פקודת ה-curl שמשמשת לשחזור השגיאה 502
• קובץ מעקב אחר בקשות ה-API
• פלט מלא של התשובה משרת היעד/שרת הקצה העורפי יחד עם גודל המטען הייעודי (Payload)

אם אתם משתמשים בענן פרטי, עליכם לספק את הפרטים הבאים:

• הודעת שגיאה מלאה שנצפתה בבקשות שנכשלו
• שם הארגון
• שם הסביבה
• חבילת API Proxy
• קובץ מעקב לבקשות ה-API שנכשלו
• צריך להשלים את פקודת ה-curl שמשמשת לשחזור השגיאה 502
• פלט מלא של התשובה משרת היעד/שרת הקצה העורפי יחד עם גודל המטען הייעודי (Payload)

• יומני גישה ל-NGINX /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log

  איפה: ORG, ENV ו-PORT# מוחלפים ב: והערכים בפועל.

• יומני מערכת של מעבד ההודעות /opt/apigee/var/log/edge-message-processor/logs/system.log