שיטות מומלצות לבקשות תמיכה ב-Google Cloud Apigee

אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info

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

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

תיאור הבעיה

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

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

בחלקים הבאים נרחיב על כך בפירוט.

מוצר

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

בטבלה הבאה מפורטות כמה דוגמאות למידע מלא בעמודה מה כדאי לעשות ומידע חלקי בעמודה מה לא כדאי לעשות:

פעולות שצריך לבצע מה לא לעשות
הפריסה של שרת ה-proxy ל-API‏ OAuth2 נכשלה בארגון שלנו ב-Public Cloud…

הפריסה של שרת proxy ל-API נכשלה

(אנחנו צריכים לדעת באיזה מוצר של Apigee נתקלת בבעיה).

ההתקנה נכשלה עם השגיאה הבאה ב-Edge Private Cloud בגרסה 4.50.00…

ההתקנה נכשלה בהגדרה של Private Cloud שלנו.

(פרטי הגרסה חסרים)

פרטי הבעיה

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

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

פעולות שצריך לבצע מה לא לעשות

שרת ה-proxy החדש edgemicro edgemicro_auth נכשל עם השגיאה הבאה:

{"error":"missing_authorization","error_description":"Missing Authorization header"}

שרת proxy חדש של edgemicro שנוצר היום לא פועל

(שם שרת ה-proxy לא ידוע. לא ברור אם שרת ה-proxy מחזיר שגיאה או תגובה בלתי צפויה).

הלקוחות שלנו מקבלים שגיאות מסוג 500 עם הודעת השגיאה הבאה כשהם שולחים בקשות ל-API proxy:

{"fault":{"faultstring":"Execution of JSReadResponse failed with error: Javascript runtime error: \"TypeError: Cannot read property \"content\" from undefined. (JSReadResponse.js:23)","detail":{"errorcode":"steps.javascript.ScriptExecutionFailed"}}}

הלקוחות שלנו מקבלים שגיאות מסוג 500 כששולחים בקשות ל-API proxy.

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

שעה

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

יכול להיות שמהנדס התמיכה שיטפל בבעיה יהיה באזור זמן שונה משלכם, לכן אמירות יחסיות לגבי זמן יקשו עליו לאבחן את הבעיה. לכן מומלץ להשתמש בפורמט ISO 8601 לחותמת התאריך והשעה כדי לספק את פרטי השעה המדויקים שבהם הבעיה זוהתה.

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

פעולות שצריך לבצע מה לא לעשות
מספר עצום של אירועים של 503s נצפו אתמול בין השעות 2020-11-06 17:30 PDT לבין 2020-11-06 17:35 PDT...

זוהו מספר עצום של 503s אתמול בשעה 17:30 למשך 5 דקות.

(אנחנו נאלצים להשתמש בתאריך המשוער, ולא ברור גם באיזו אזור זמן זוהתה הבעיה).

נצפו זמני אחזור ארוכים בשרתי ה-API proxy הבאים מ-2020-11-09 15:30 IST עד 2020-11-09 18:10 IST ...

בשבוע שעבר נצפו זמני אחזור ארוכים בחלק מהשרתים של API Proxies.

(לא ברור באיזה יום ובמשך כמה זמן הבעיה זוהתה בשבוע האחרון).

הגדרה

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

  • אם אתם משתמשים ב-Apigee Cloud, יכול להיות שיש לכם יותר מארגון אחד, לכן נצטרך לדעת מהו הארגון הספציפי ופרטי פרטים נוספים לגבי הבעיה:
    • שמות הארגון והסביבה
    • השם ומספרי הגרסה של שרת ה-proxy ל-API (לכשלונות בבקשות API)
  • אם אתם משתמשים ב-Private Cloud , יכול להיות שאתם משתמשים באחת מטופולוגיות ההתקנה הרבות הנתמכות. לכן נצטרך לדעת באיזו טופולוגיה אתם משתמשים, כולל פרטים כמו מספר מרכזי הנתונים והצומתים.

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

פעולות שצריך לבצע מה לא לעשות

401 מספר השגיאות ב-Edge Public Cloud גדל מאז 6 בנובמבר 2020 בשעה 09:30 (שעון החוף המזרחי).

פרטי ההגדרה של Edge:

הפרטים של ה-API הכושל הם:
  שמות הארגון: myorg
  שמות הסביבה: test
  שמות ה-proxy ל-API: myproxy
  מספרי הגרסאות: 3

שגיאה:

{"fault":{"faultstring":"Failed to resolve API Key variable request.header.X-APP-API_KEY","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

401 מספר השגיאות עלה.

(היא לא מספקת מידע על המוצר שבו נעשה שימוש, על המועד שבו נצפתה הבעיה או על פרטי ההגדרה).

אי אפשר להפעיל את Message Processor ב-Edge Private Cloud בגרסה 4.19.06, אחרי הוספת צמתים נוספים של שער.

יומני אבחון:
צירפתי את היומנים של Message Processor.

טופולוגיית הרשת:
צורף הקובץ network-topology.png שמכיל את הצמתים הנוספים.

אי אפשר להפעיל את Message Processor ב-Edge Private Cloud בגרסה 4.19.06, אחרי הוספת צמתים נוספים של שער.

(יומני Message Processor והטופולוגיה של הרשת חסרים).

קבצים נלווים

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

בקטע הזה מתוארים כמה ארטיפקטים שימושיים לכל מוצרי Apigee:

ארטיפקטים נפוצים לכל מוצרי Apigee

הארטיפקטים הבאים שימושיים לכל מוצרי Apigee: Apigee Edge בענן הציבורי ו-Apigee Edge בענן הפרטי:

פריט מידע שנוצר בתהליך פיתוח (Artifact) תיאור
פלט של כלי המעקב הפלט של כלי המעקב מכיל מידע מפורט על בקשות ה-API שעוברות דרך מוצרי Apigee. האפשרות הזו שימושית בכל שגיאת זמן ריצה, כמו 4XX, ‏ 5XX ובעיות זמן אחזור.
צילומי מסך צילומי מסך עוזרים להעביר את ההקשר של ההתנהגות או השגיאה בפועל שנצפו. הוא שימושי במקרים של שגיאות או בעיות שנצפו, למשל בממשק המשתמש או ב-Analytics.
HAR (Http ARchive) קובץ HAR הוא קובץ שתועד על ידי כלים של סשנים ב-HTTP לצורך ניפוי באגים של בעיות שקשורות לממשק המשתמש. אפשר לצלם את המסך באמצעות דפדפנים כמו Chrome,‏ Firefox או Internet Explorer.
tcpdumps הכלי tcpdump מתעד חבילות TCP/IP שהועברו או התקבלו ברשת. האפשרות הזו שימושית לבעיות שקשורות לרשת, כמו כשלים בחיבוק יד של TLS, שגיאות 502 ובעיות זמן אחזור וכו'.

ארטיפקטים נוספים ל-Apigee Edge לענן פרטי

לגבי Apigee Edge for Private Cloud, יכול להיות שנצטרך כמה ארטיפקטים נוספים שיעזרו לנו לאבחן בעיות מהר יותר.

פריט מידע שנוצר בתהליך פיתוח (Artifact) תיאור
הטופולוגיה של הרשת תרשים הטופולוגיה של התקנת Edge שמתאר את ההגדרה של הענן הפרטי, כולל כל מרכזי הנתונים, הצמתים והרכיבים שמותקנים בכל צומת.
יומני אבחון של רכיבי Edge יומני האבחון שקשורים לרכיב הספציפי של Apigee Edge, כמו Message Processor, ‏ Router או Cassandra.
קובץ תצורה של התקנה קובץ התצורה ללא הצגת הודעות שמשמשים להתקנה או לשדרוג של Apigee Edge.

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

תמונות מצב של אשכול Dumps של ערימה הם תמונת מצב של תהליך הזיכרון ב-Java. האפשרות הזו שימושית אם יש שימוש גבוה בזיכרון או שגיאות OutOfMemory במרכיבים מסוימים של Edge.
דיווחים על שרשור גרסת dump של שרשור היא תמונת מצב של כל השרשורים בתהליך Java שפועל.

האפשרות הזו שימושית אם רואים עומס או שימוש גבוה ב-CPU ברכיבי Edge מסוימים.

תבניות לבקשות תמיכה ומקרים לדוגמה

בקטע הזה מפורטות תבניות לבקשות תמיכה ותרחישי בקשות לדוגמה למוצרים שונים, על סמך השיטות המומלצות שמפורטות במסמך הזה:

Apigee Edge בענן הציבורי

תבנית

בקטע הזה מוצגת תבנית לדוגמה ל-Apigee Edge בענן הציבורי.

הבעיה:

<יש לספק תיאור מפורט של הבעיה או ההתנהגות שנצפתה אצלך. יש לכלול את שם המוצר והגרסה שלו במקרים הרלוונטיים.>

הודעת השגיאה:

<Include the complete error message observed (if any)>

שעת ההתחלה של הבעיה (בפורמט ISO 8601):

שעת סיום הבעיה (בפורמט ISO 8601):

פרטי ההגדרה של Apigee:
  שמות הארגונים:
  שמות הסביבות:
  שמות ה-proxy ל-API:
  מספרי הגרסאות:

השלבים לשחזור:

<יש לציין את השלבים לשחזור הבעיה, אם אפשר>

מידע אבחוני:

<List of files attached>

בקשת תמיכה לדוגמה

בקטע הזה מוצגת דוגמה ל-Apigee Cloud (Apigee ב-Google Cloud או Apigee Edge בענן הציבורי).

הבעיה:

אנחנו מזהים מספר גבוה של שגיאות 503 Service Unavailable בארגון שלנו ב-Public Cloud. יש לך אפשרות לבדוק את הבעיה ולפתור אותה או לייעץ לנו איך לפתור אותה?

הודעת השגיאה:

{"fault":{"faultstring":"The Service is temporarily available", "detail":{"errorcode":"messaging.adaptors.http.flow.ServiceUnavailable"}}}

שעת ההתחלה של הבעיה (בפורמט ISO 8601): 04 באוקטובר 2020 בשעה 06:30 (שעון IST)

שעת סיום הבעיה (בפורמט ISO 8601): הבעיה עדיין נמשכת.

פרטי ההגדרה של Apigee Cloud:
  שמות הארגון: myorg
  שמות הסביבה: dev
  שמות ה-proxy ל-API: myproxy
  מספרי הגרסאות: 3

השלבים לשחזור:

כדי לשחזר את הבעיה, מריצים את הפקודה הבאה ב-curl:

curl -X GET 'https://myorg-dev.apigee.net/v1/myproxy'

מידע אבחוני:

הפלט של כלי המעקב (trace-503.xml)

Apigee Edge לענן פרטי

תבנית

בקטע הזה מוצגת תבנית לדוגמה ל-Apigee Edge for Private Cloud.

הבעיה:

<יש לספק תיאור מפורט של הבעיה או ההתנהגות שנצפתה אצלך. יש לכלול את שם המוצר והגרסה שלו במקרים הרלוונטיים.>

הודעת השגיאה:

<Include the complete error message observed (if any)>

שעת ההתחלה של הבעיה (בפורמט ISO 8601):

שעת סיום הבעיה (בפורמט ISO 8601):

פרטי ההגדרה של Edge Private Cloud:

<צירוף של טופולוגיית הרשת שמתארת את ההגדרה של הענן הפרטי, כולל מרכזי נתונים וצמתים>

השלבים לשחזור:

<יש לציין את השלבים לשחזור הבעיה, אם אפשר>

מידע אבחוני

<List of files attached>

בקשת תמיכה לדוגמה

בקטע הזה מוצגת דוגמה לשימוש ב-Apigee Edge לענן פרטי.

הבעיה:

במהלך ההתקנה של שרת הניהול של Apigee בצומת מס' 10, כחלק מ-Edge Private Cloud 4.19.06 ב-Linux RHEL 7.6, נתקלנו בשגיאה הבאה.

הודעת השגיאה:

<snipped as the output is too long>
Checking for management-server uuid ................................................
Unable to get uuid for management-server.
Error: setup.sh: /opt/apigee/apigee-service/bin/apigee-service exited with unexpected status 1

שעת התחלת הבעיה (בפורמט ISO 8601): הבעיה מתרחשת בכל פעם שאנחנו מתקינים

שעת סיום הבעיה (בפורמט ISO 8601): לא רלוונטי

פרטי ההגדרה של Edge Private Cloud:

צורף הקובץ network-topology.png

השלבים לשחזור:

זו הפקודה שהובילה לשגיאה שלמעלה:

/opt/apigee/apigee-setup/bin/setup.sh -p ms -f /app/NonProdConfig.txt

מידע אבחוני:

צירפתי את הקבצים הבאים:

  • output.txt שמכיל את הפלט המלא של הפקודה שלמעלה, כולל הודעת השגיאה
  • יומני שרת הניהול ו-
  • קובץ תצורה NonProdConfig.txt