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

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

כרגע מוצג תיעוד של 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 version 4.50.00 ...

ההתקנה נכשלה בהגדרה של הענן הפרטי שלנו.

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

פרטי הבעיה

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

בטבלה הבאה מוצגות כמה דוגמאות עם מידע מלא בעמודה משימות לביצוע. ומידע חלקי בעמודה לא לביצוע:

משימות לא לעשות

שרת ה-Proxy החדש מסוג edgemicro edgemicro_auth נכשל עם השגיאה הבאה:

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

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

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

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

{"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 בזמן שליחת בקשות לשרת proxy ל-API.

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

שעה

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

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

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

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

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

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

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

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

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

הגדרה

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

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

בטבלה הבאה מוצגות כמה דוגמאות עם מידע מלא בעמודה משימות לביצוע. ומידע חלקי בעמודה לא לביצוע:

משימות לא לעשות

401 יש עלייה במספר השגיאות ב-Edge Public Cloud מאז 2020-11-06 09:30 CST.

פרטים על הגדרת קצה:

אלו הפרטים לגבי ה-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 שגיאות.

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

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

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

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

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

(יומני מעבד ההודעות והטופולוגיה של הרשת חסרים).

קבצים נלווים

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

בקטע הזה מתוארים כמה פריטי מידע שנוצרו בתהליך פיתוח (Artifact) שיכולים לעזור לכל מוצרי Apigee:

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

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

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

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

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

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

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

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

האפשרות הזו שימושית אם יש עומסי מעבד (CPU) או עומסים גבוהים ברכיבים מסוימים של Edge.

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

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

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

תבנית

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

הבעיה:

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

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

<יש לכלול את הודעת השגיאה המלאה שזוהתה (אם יש)>

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

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

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

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

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

פרטי אבחון:

<רשימת הקבצים המצורפים>

מקרה לדוגמה

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

הבעיה:

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

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

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

שעת ההתחלה של הבעיה (בפורמט ISO 8601): 2020-10-04 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 לענן פרטי.

הבעיה:

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

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

<יש לכלול את הודעת השגיאה המלאה שזוהתה (אם יש)>

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

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

פרטי הגדרה של ענן פרטי:

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

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

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

פרטי אבחון

<רשימת הקבצים המצורפים>

מקרה לדוגמה

הקטע הזה מציג מקרה לדוגמה של 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): לא רלוונטי

פרטי הגדרה של ענן פרטי:

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

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

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

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

פרטי אבחון:

מצורפים הקבצים הבאים:

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