אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע
בקטע הזה מוצגת השוואה בין API Monitoring לבין Edge Analytics. שני הכלים, API Monitoring ו-Edge Analytics, מאפשרים לכם לאסוף נתונים מ-API ולהציג אותם, אבל יש להם מטרות שונות:
- המטרה של מעקב אחר API היא לוודא שממשקי ה-API פועלים כמו שצריך. לכן, אתם רוצים לראות את הנתונים העדכניים ביותר שזמינים. הכלי 'מעקב אחר API' מספק נתונים שקרובים מאוד לנתונים בזמן אמת, ומאפשר ליצור התראות שיודיעו לכם אם תתעורר בעיה.
- המטרה של Edge Analytics היא להבין את ההתנהגות של ממשקי ה-API לטווח ארוך, כדי שתוכלו לוודא שהם תומכים בדרישות העסקיות שלכם, או לבצע שינויים אם יש צורך. לכן, לא כל כך חשוב לראות נתונים בזמן אמת. לכן, יש עיכוב קל בנתוני Analytics, אבל בדרך כלל הוא לא עולה על 10 דקות.
שימו לב שנתוני המעקב אחר קריאות ל-API, שקשורים בעיקר לקודי שגיאה ולזמן האחזור, הם קבוצת משנה קטנה של נתוני Analytics.
ההבדלים בין נתוני המעקב אחר API לבין נתוני Analytics
בקטע הזה מפורטים כמה הבדלים קלים בין הנתונים שנאספים על ידי Edge Analytics לבין הנתונים שנאספים על ידי API Monitoring. מכיוון ש-API Monitoring ו-Analytics משתמשים בצינורות נתונים שונים, יכול להיות שתראו הבדלים קלים בין דוחות בהתאמה אישית שנוצרו על ידי Monitoring לבין דוחות שנוצרו על ידי Analytics. לדוגמה, יכול להיות שתראו הבדלים בתוצאות המדווחות של שגיאות שקשורות לפסק זמן – גם פסק זמן של קצה עורפי (קוד סטטוס HTTP 504 בבקשה) וגם פסק זמן של לקוח (קוד סטטוס HTTP 499). יכול להיות שהם יופיעו עם קוד סטטוס 200 בדוחות בהתאמה אישית ב-Analytics, אבל הם יופיעו עם קוד סטטוס 504 או 499 בדוחות בהתאמה אישית של ניטור.API Monitoring
הכלי API Monitoring מספק תובנות בזמן אמת לגבי הביצועים של ממשקי API, ועוזר לכם לאבחן ולפתור בעיות במהירות כדי שממשקי ה-API יפעלו כמצופה.
התכונה 'מעקב אחר API' מאפשרת לכם:
- להגדיל את הזמינות של ה-API ולקצר את הזמן הממוצע לאבחון (MTTD).
- לנקוט פעולות מתאימות על סמך התראות הקשריות לפני שהצרכנים מושפעים.
- כדאי להשתמש בקודי תקלות של Apigee כדי לאבחן בעיות במהירות.
- איתור מהיר של אזורים בעייתיים כדי לאבחן בעיות שקשורות לשגיאות, לביצועים ולזמן האחזור, ולמצוא את המקור שלהן.
Edge API Analytics
Edge API Analytics אוסף ומנתח מידע שזורם דרך ממשקי API. ממשק ה-API של Analytics אוסף מידע כמו:
- מהן המגמות בתנועת הנתונים של ה-API לאורך זמן
- מהן האפליקציות המובילות שלך
- מי הם המפתחים המובילים שלך
- אילו שיטות API הכי פופולריות
- מתי זמן התגובה של ה-API הוא הכי מהיר או הכי איטי
- באילו אזורים גיאוגרפיים מזוהה הכי הרבה תנועה ב-API
נתונים שנאספים על ידי API Analytics
API Analytics אוסף ומנתח מגוון רחב של נתונים שזורמים דרך ממשקי API. לדוגמה, בזמן שה-API שלכם פרוס, מערכת Analytics מתעדת באופן קבוע את מספר ההודעות שהתקבלו, מספר המפתחים, זמני התגובה, השגיאות, מספר האפליקציות שבשימוש, גודל הבקשה ועוד הרבה נתונים אחרים.
כדי לקבל מבוא טוב למדדים וללמוד איך להשתמש בהם, אפשר לקרוא את המאמר שימוש בממשקי API של מדדים למדידת הביצועים של תוכנית API. רשימה מלאה של המדדים זמינה במאמר מאפיינים, מדדים ומסננים ב-Analytics.
איסוף מדדים מותאמים אישית
אפשר גם לאסוף מדדים מותאמים אישית באמצעות מדיניות StatisticsCollector. מדיניות StatisticsCollector יכולה לכתוב מידע מכותרות של בקשות, מ-payloads של XML/JSON, מפרמטרים של שאילתות, מ-URI וממיקומים אחרים בשרת Analytics לצורך ניתוח ויצירת דוחות.
גישה לנתוני Analytics
אחרי שהם נוצרים, אפשר לגשת למדדים שהוגדרו מראש ולמדדים מותאמים אישית באמצעות כלי הוויזואליזציה של Analytics API, כולל מרכז הבקרה, דוחות מותאמים אישית ומפת מיקום גיאוגרפי. מידע נוסף על כלי הוויזואליזציה שזמינים ב-API Analytics אפשר לקרוא במאמר לוחות בקרה של Analytics. מידע נוסף על דוחות בהתאמה אישית זמין במאמר יצירת דוחות בהתאמה אישית.
השוואה בין API Monitoring לבין API Analytics
מפתחי API משתמשים גם ב-API Monitoring וגם ב-API Analytics. אחד ההבדלים העיקריים בין שני המוצרים הוא מנגנון ההתראות שמוטמע ב-API Monitoring. ההתראות מאפשרות לצוות התפעול להגיב לבעיות ב-API בזמן אמת, כדי לוודא שה-API זמין ופועל כמצופה.
תנאי ההתראה מגדירים ספי קוד סטטוס ספציפיים (2xx/4xx/5xx), חביון וקוד שגיאה. אם הספים האלה נחצים, מופעלות התראות חזותיות בממשק המשתמש ונשלחות התראות במגוון ערוצים, כמו אימייל, Slack, PagerDuty או Webhooks. אפשר להגדיר התראות ברמת הסביבה, ברמת ה-API proxy או שירות היעד, או ברמת האזור.
אחרי שהתראה מופעלת, צוות התפעול יכול להשתמש בממשק המשתמש של API Monitoring כדי לחקור את הבעיה ולזהות את שורש הבעיה. אחרי כן תוכלו ליצור דוח בהתאמה אישית שיכלול מידע מוגדר מראש על ההתראה, כמו:
- זמן התגובה הכולל
- זמן תגובה רצוי
- שגיאות בשרת ה-proxy
- שגיאות שקשורות ליעד
- מזהה ייחודי אוניברסלי (UUID) של הבקשה
- הרבה יותר
ה-API Analytics נועד לתעד מגוון רחב של נתונים לשימוש של כמה צוותים. לדוגמה:
- צוות התפעול יכול להשתמש בנתונים מ-Analytics כדי לזהות תקופות של תנועת גולשים גבוהה או נמוכה, וכך להגדיל או להקטין את היקף השירותים בהתאם לשינויים בביקוש.
- צוות השיווק יכול להשתמש בנתונים מ-Analytics כדי לזהות דפוסי שימוש של לקוחות לפי ממשקי API, אפליקציות, לקוחות או נתונים אחרים.
- כל הצוותים יכולים לגשת לנתונים מותאמים אישית שנאספים מבקשה כדי לעקוב אחרי מידע ספציפי כמו ערכי כותרות, פרמטרים של שאילתות או מטען ייעודי (payload) של בקשות.