סקירה כללית על Analytics API

מוצג המסמך של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info

הנושא הזה מציג את Edge API Analytics.

סרטון: סקירה כללית על שירותי Analytics של Edge API בסרטון קצר.

שיפור ה-API באמצעות ניתוח נתונים

מערכת Edge API Analytics אוספת ומחשבת שפע של מידע שעובר דרך שרתי proxy ל-API. ניתן להציג את הנתונים האלו באמצעות גרפים ותרשימים בממשק המשתמש של Edge. לחלופין, אפשר להוריד את הנתונים הגולמיים עבור ניתוח אופליין באמצעות ממשקי Edge management API.

Analytics יכול לעזור לכם לענות על שאלות נפוצות, למשל:

  • מהן המגמות של תנועת ה-API לאורך זמן?
  • מהן שיטות ה-API הכי פופולריות?
  • מיהם המפתחים המובילים שלי?
  • מתי זמן התגובה של ה-API הוא המהיר ביותר? הכי איטי?
  • איפה אפשר לראות הכי הרבה תנועה מ-API במיקומים גיאוגרפיים?

התשובות לשאלות כאלה יעזרו לך לשפר את ממשקי ה-API, לפתור בעיות ולשפר ההחלטות העסקיות הקשורות לתוכנית ה-API שלכם.

שימוש ב-API Analytics עוזר לכולם להשתפר

באמצעות תהליך מתמשך של איסוף, ניתוח והצגה חזותית של נתונים, Edge API Analytics עוזר צוות ה-API יכול לשפר את ממשקי ה-API שלהם, ולעזור למפתחי אפליקציות לשפר את האפליקציות שלהם:

טקסט_אלטרנטיבי
  • צוות API – צוות ה-API משתמש במערכות פנימיות כדי ליצור ממשקי API מעניינים. צוות ה-API רוצה לדעת את הביצועים של תוכנית ה-API באופן כללי, את הביצועים של כל ממשקי API בנפרד, ואיך לשפר את ממשקי ה-API שלהם.
  • מפתחי אפליקציות – שיתוף נתוני ניתוח עם מפתחי אפליקציות יעזור לכם לקבל אפליקציות טובות יותר. המפתחים האלה מחדשים את השימוש ב-API ומפתחים אפליקציות יצירתיות שיעזרו של הארגון. פלטפורמת Analytics עוזרת למפתחי אפליקציות לדעת את הביצועים של האפליקציות שלהם וכמה הן מניבות ותורמים לשורת הרווח של הארגון. מפתחי אפליקציות רוצים לדעת איך ניתן לשפר את האפליקציות שלהם.
  • צוות תפעול – צוות התפעול רוצה להבין דפוסי תנועה לצפות מתי להוסיף משאבים לקצה העורפי או לבצע שינויים קריטיות אחרים.
  • בעל עסק – בעל העסק רוצה לבדוק איך ההשקעה ב-API משתלמת, ואיפה כדאי להשקיע את כספי ה-API בעתיד.

איזה סוג של נתונים נאספים ומנותחים?

Analytics מסוג Edge API אוסף ומנתח מגוון רחב של נתונים שזורמים דרך שרתי proxy ל-API, כמו:

  • זמן תגובה
  • זמן אחזור של בקשה
  • גודל הבקשה
  • שגיאות ביעד
  • שם המוצר של ה-API
  • כתובת האימייל של המפתח
  • שם האפליקציה
  • רבים אחרים

פירוט מלא של הנתונים שנאספו על ידי API Analytics זמין בכתובת חומר עזר בנושא מדדים, מאפיינים ומסננים ב-Analytics

איך אוספים נתונים מותאמים אישית לניתוח נתונים?

דפדפן Edge אוסף שפע של נתונים. מומלץ גם לאסוף ניתוח נתונים מותאם אישית ספציפי לשרתי ה-proxy, האפליקציות, המוצרים או המפתחים שלך. לדוגמה, ייתכן שתרצו לאסוף ניתוח נתונים מפרמטרים של שאילתות, מכותרות בקשות, מגופי בקשות ותגובות או ממשתנים שאתם מגדירים בממשקי ה-API שלכם.

כדי לאסוף נתוני ניתוח נתונים מותאמים אישית, משתמשים במדיניות של StatisticsCollector. אחרי שחולצים את הנתונים המותאמים אישית, אפשר להשתמש בממשק המשתמש של Analytics או ב-API כדי לבחון את הנתונים. מידע נוסף זמין בקטע ניתוח תוכן הודעות ב-API באמצעות ניתוח נתונים בהתאמה אישית דוגמה מלאה שממחישה איך לאסוף ניתוח נתונים בהתאמה אישית.

ההבדלים בין נתוני Analytics לבין נתוני API Monitoring

בקטע הזה מתוארים כמה הבדלים קלים בין נתונים שנאספו על ידי ניתוח של נתוני Edge לעומת מעקב באמצעות API. מאחר ש-API Monitoring ו-Analytics משתמשים בצינורות עיבוד נתונים שונים, יכול להיות שתבחינו בהבדלים קלים בין דוחות בהתאמה אישית שנוצרו על ידי Monitoring לבין דוחות שנוצרו על ידי Analytics. לדוגמה, ייתכן שתראו אי-התאמה בתוצאות המדווחות לגבי שגיאות של זמן קצוב לתפוגה – שני הזמן הקצוב לתפוגה של הקצה העורפי (קוד מצב HTTP 504 בבקשה) וזמן קצוב לתפוגה של לקוח (קוד מצב HTTP 499). הם יכולים להופיע עם קוד הסטטוס 200 בדוחות מותאמים אישית של Analytics. אבל יופיעו עם קוד הסטטוס 504 או 499 בדוחות מותאמים אישית של Monitoring.

מתי נתוני הניתוח שלי זמינים ולמשך כמה זמן?

יש שתי מרווחי זמן שקובעים מתי ולמשך כמה זמן תוכלו להציג את נתוני Analytics:

  • מרווח זמן עיכוב נתונים – לאחר שליחת קריאה לשרת proxy ל-API, היא עשויה להימשך עד 10 דקות עד שהנתונים יהיו נגישים לתצוגה או באמצעות קריאות ל-API לניהול.
  • שמירת נתונים – משך הזמן שבו נתוני ניתוח הנתונים נשמרים על ידי Edge משתנה לפי תוכנית. בהתאם לתוכנית, ייתכן שנתוני ניתוח הנתונים יהיו זמינים עבור 30, 60, 90 או 365 הימים האחרונים.

איך ניגשים לנתוני Analytics

Analytics ב-Edge API מספק כלים להמחשת נתונים שמובְנים בממשק המשתמש של Edge. הכלים האלה כוללים מרכזי בקרה מוגדרים מראש לניתוח נתונים ודוחות בהתאמה אישית שמציגים נתונים בתרשימים ובתרשימים, ומאפשרים לכם להציג פירוט כדי לראות את הנתונים המקובצים לפי מאפיינים שונים (למשל לפי שרת proxy של API, כתובת IP או קוד מצב HTTP).

בנוסף, אפשר להוריד נתוני ניתוח באמצעות Edge Management API. אחרי ההורדה, תוכלו לייבא את הנתונים האלה לכלים שלכם להצגת נתונים או למערכת הניתוח שלכם.

מרכזי הבקרה של Analytics

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

מרכז הבקרה הזה כולל תרשימים של:

  • סה"כ תנועה – המספר הכולל של בקשות API שהתקבלו ב-Edge עבור סביבת API בארגון.
  • הצלחה בתנועה – המספר הכולל של הבקשות שהובילו לתגובה מוצלחת. תגובות לשגיאות לא נספרות.
  • שגיאות תנועה – המספר הכולל של כל בקשות ה-API שנכשלו; כלומר, הבקשה לא תספק תגובה. הספירה כוללת גם שגיאות Proxy (צד Apigee) ושגיאות טירגוט (השירותים לקצה העורפי).
  • TPS ממוצע – המספר הממוצע של בקשות API והתגובות שהתקבלו בשנייה.

מרכזי בקרה נוספים שהוגדרו מראש כוללים:

מידע נוסף על לוחות הבקרה המוגדרים מראש זמין במאמר שימוש בלוחות הבקרה של Analytics.

דוחות מותאמים אישית

דוחות מותאמים אישית מאפשרים לכם להציג פירוט של מדדי API ספציפיים ולראות את הנתונים הספציפיים שאתם רוצים לראות. אפשר ליצור דוח בהתאמה אישית באמצעות כל אחד מנתוני הניתוח המובנים ב-Edge או ניתוח נתונים בהתאמה אישית. נתונים שנאספים במסגרת המדיניות של StatisticsCollector.

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

אפשר גם להגדיר את סוג התרשים שיוצג בדוח בהתאמה אישית כתרשים עמודות או כתרשים קו. בתמונות הבאות מוצגות דוגמאות לתרשימים של עסקאות לשנייה, בקיבוץ לפי שרת proxy ל-API:

  • עמודה – כל שרת proxy של API מיוצג על ידי עמודה שונה:

    תרשים עמודות אנכי בהתאמה אישית

  • שורה – כל שרת proxy של API מיוצג בשורה נפרדת:

    תרשים קו מותאם אישית

מידע נוסף זמין במאמר יצירה וניהול של דוחות בהתאמה אישית.

Analytics API

כדי להוריד ניתוח נתונים, משתמשים ב-Edge management API. לדוגמה, אפשר להשתמש ב-API כדי ליצור כלים משלכם להמחשה חזותית, שתוכלו להטמיע בפורטלים או באפליקציות מותאמות אישית.

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

curl  https://api.enterprise.apigee.com/v1/o/org_name/environments/test/stats/apiproxy?"select=sum(message_count)&timeRange=6/24/2018%2000:00~6/24/2018%2023:59&timeUnit=hour" \
-u email:password

הפונקציה הזו מחזירה:

  • סכום הבקשות (מספר ההודעות) לכל שרת proxy ל-API
  • לפרק זמן של 24 שעות
  • חלוקה לקבוצות לפי שעה

פרמטר השאילתה timeRange מציין את תקופת הזמן בטופס:

?timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM

חשוב לשים לב ל%20 לפני HH:MM. הפרמטר timeRange מחייב תו רווח בקידוד כתובת URL לפני HH:MM, או תו +, כמו: MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM

מידע נוסף זמין במאמר שימוש בממשקי ה-API למדדים למדידת הביצועים של תוכנית ה-API.

ייצוא ניתוח נתונים ל-Google Cloud

אפשר להשתמש ב-Edge management API כדי לייצא את כל ניתוח הנתונים עבור יום שלם מ-Edge למאגר נתונים משלכם, כמו Google Cloud Storage או BigQuery. לאחר מכן תוכלו לנצל את היכולות החזקות של שאילתות ולמידת מכונה שמוצעות על ידי Google Cloud BigQuery ו-TensorFlow כדי לבצע ניתוח נתונים משלכם.

מידע נוסף זמין במאמר ייצוא נתונים מ-Analytics.

איך אפשר לשתף נתונים עם מפתחי אפליקציות?

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

טקסט_אלטרנטיבי

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

  • שגיאות: אילו שגיאות API מוצגות באפליקציה שלי?
  • ביצועים: האם ה-API איטי כרגע? אילו methods של API הן בדרך כלל איטיות או איטי כרגע?
  • זמינות: האם ה-API נמצא במגמת עלייה או ירידה כרגע?
  • מכסה: האם ל-API יש מכסה? וכמפתחי אפליקציות, במסגרת המכסה?

מידע נוסף זמין במאמרים הבאים:

בנוסף, אתם יכולים לשתף את ניתוח הנתונים עם המפתחים שלכם באמצעות:

איך יוצרים ניתוח נתונים מלא?

מה המשמעות של ניתוח נתונים מלא? לדוגמה, אפשר ליצור שרת proxy ל-API ו-Edge לאסוף ניתוח נתונים על שרת ה-proxy הזה. אבל מה לגבי מדדים עבור המפתח או האפליקציה שנקראו את ה-Proxy ל-API? אם Edge לא יודע מי ביצע קריאה ל-API, אין לו אפשרות לאסוף את הנתונים האלה.

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

  1. ליצור מוצר אחד או יותר של API, שהוא קיבוץ של שרתי proxy ל-API יחד עם תוכנית שירות. למידע נוסף, ראו ניהול מוצרי API.
  2. לרישום מפתחי אפליקציות באמצעות Edge. ראו רישום מפתחי אפליקציות
  3. לרשום אפליקציות וליצור מפתחות API למפתחים. ראו רישום אפליקציות וניהול מפתחות API
  4. מוסיפים מדיניות אבטחה לשרתי proxy ל-API שמאמתים מפתחות API או אסימוני אבטחה. כדאי לעיין בנושאים הבאים:אימות המדיניות בנושא מפתח API, מדיניות OAuthV2 ואימות מדיניות JWT.
  5. אם אתם משתמשים ב-Edge Microgateway, חשוב לוודא שהפעלתם את הפלאגין של Analytics (אפשרות זו מופעלת כברירת מחדל). אם הפלאגין לניתוח נתונים מושבת, Edge Microgateway לא ישלח נתוני ניתוח נתונים אל Edge analytics.

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

השוואה בין API Analytics ל-API Monitoring

אפשר להשתמש ב-Edge API Monitoring ו-API Analytics. API Monitoring בוחן את נתוני הניתוח כדי לספק תובנות לפי הקשר בזמן אמת ביצועי ה-API, מאפשרים לאבחן בעיות במהירות ולנהל פעולות מתקנות כדי לשמור על ההמשכיות העסקית. API Monitoring מיועד לאיתור מהיר של נקודות בעייתיות בממשקי ה-API ובקצוות העורפיים. ניתוח הנתונים של ה-API נועד לתעד מגוון רחב של נתוני ניתוח לשימוש של כמה צוותים שונים, אבל בדרך כלל הנתונים משמשים לניתוח בתרחישים שאינם בזמן אמת.

אחד ההבדלים העיקריים בין API Monitoring לבין API Analytics הוא מנגנון ההתראות שנוצר ל-API Monitoring. בהתראות, מציינים ערך סף של קוד סטטוס HTTP‏ (2xx/4xx/5xx), זמן אחזור או קוד שגיאה, וכשהערך חורג מהסף, נשלחת התראה לצוות התפעול. באמצעות ההתראות אפשר יישלחו דרך מגוון ערוצים, כמו אימיילים, Slack, זימונית או webhooks, שמאפשרים לכם להגיב לבעיות באופן מיידי.

למידע נוסף, ראו השוואה בין מעקב API ל-Edge API Analytics להשוואה מפורטת יותר בין השירותים האלה.

מידע נוסף