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