שיטות מומלצות לבקשות תמיכה ב-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 on Public Cloud ו-Apigee Edge בענן פרטי, לכן אנחנו זקוקים למידע ספציפי לגבי המוצר הספציפי שבו קיימת הבעיה.

בטבלה הבאה מוצגות כמה דוגמאות לפרטים מלאים בעמודה DOs, ומידע חלקי בעמודה DON'Ts:

פעולות לביצוע לא כדאי
הפריסה של שרת proxy של API OAuth2 נכשלה בארגון שלנו בענן הציבורי ...

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

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

ההתקנה נכשלה והתקבלה השגיאה הבאה ב-Edge Private Cloud גרסה 4.50.00 ...

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

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

פרטי הבעיה

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

בטבלה הבאה מוצגות כמה דוגמאות לפרטים מלאים בעמודה DOs ולפרטים חלקיים בעמודה DON'Ts:

פעולות לביצוע לא כדאי

שרת ה-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 לחותמת התאריך והשעה, כדי לספק את השעה המדויקת שבה זוהתה הבעיה.

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

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

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

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

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

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

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

Setup (הגדרה)

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

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

בטבלה הבאה מוצגות כמה דוגמאות לפרטים מלאים בעמודה DOs ולפרטים חלקיים בעמודה DON'Ts:

פעולות לביצוע לא כדאי

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 גרסה 4.19.06 , אחרי שמוסיפים צמתים נוספים בשער.

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

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

אי אפשר להפעיל את מעבד ההודעות בענן פרטי של Edge גרסה 4.19.06 , אחרי שמוסיפים צמתים נוספים בשער.

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

קבצים נלווים

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

בקטע הזה מתוארים כמה פריטי מידע שנוצרו בתהליך הפיתוח (Artifact) שימושיים לכל המוצרים של 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 לענן פרטי, יכול להיות שנצטרך כמה פריטי מידע שנוצרו בתהליך פיתוח (Artifact) נוספים שיאפשרו אבחון מהיר יותר של בעיות.

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

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

קובצי Dump של ערימה קובצי dump של ערימה (heap dumps) הם תמונת מצב של תהליך הזיכרון ב-Java. האפשרות הזו שימושית אם מוצגות שגיאות של OutOfMemory או ניצול גבוה של הזיכרון ברכיבי Edge מסוימים.
Dump של שרשורים קובץ Dump של שרשור הוא תמונת מצב של כל ה-threads של תהליך Java פעיל.

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

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

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

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

תבנית

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

הבעיה:

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

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

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

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

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

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

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

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

פרטי האבחון:

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

מקרה לדוגמה

בקטע הזה מוצג מקרה לדוגמה של Apigee Cloud (Apigee ב-Google Cloud/Apigee Edge ב-Public Cloud).

הבעיה:

אנחנו רואים מספר גבוה של שגיאות שירות לא זמין 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): הבעיה עדיין נמשכת.

פרטי הגדרת Cloud ב-Apigee:
שמות ארגונים: myorg
שמות Env: 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):

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

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

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

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

מידע על האבחון

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

מקרה לדוגמה

בקטע הזה מוצגת דוגמה לדוגמה של 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:

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

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

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

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

פרטי האבחון:

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

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