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