שיטות מומלצות לשימוש במערכת התמיכה של Google Cloud Apigee

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

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

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

תיאור הבעיה

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

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

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

מוצר

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

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

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

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

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

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

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

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

פרטי הבעיה

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

בטבלה הבאה מופיעות כמה דוגמאות למידע מלא בעמודה מה כן, ולמידע לא מלא בעמודה מה לא:

DOs מה לא לעשות

שרת ה-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 PDT לבין 2020-11-06 17:35 PDT...

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

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

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

בשבוע שעבר נצפו השהיות גבוהות בחלק משרתי ה-API Proxy.

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

הגדרה

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

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

בטבלה הבאה מופיעות כמה דוגמאות למידע מלא בעמודה מה כן, ולמידע לא מלא בעמודה מה לא:

DOs מה לא לעשות

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

פרטי ההגדרה של 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 עלה.

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

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

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

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

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

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

קבצים נלווים

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

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

פריטי מידע שנוצרו בתהליך הפיתוח (Artifact) משותפים לכל מוצרי 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 for Private Cloud

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

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

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

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

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

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

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

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

תבנית

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

הבעיה:

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

הודעת שגיאה:

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

שעת ההתחלה של הבעיה (בפורמט 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 for Private Cloud.

הבעיה:

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

הודעת שגיאה:

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

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

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

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

<Attach the network topology describing the setup of your Private Cloud including data centers and nodes>

צעדים לשחזור:

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

מידע אבחוני

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

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

בקטע הזה מופיעה דוגמה לשימוש ב-Apigee Edge for Private Cloud.

הבעיה:

במהלך ההתקנה של Apigee Management Server בצומת מספר 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