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

אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info

כאן נסביר על Edge API Analytics.

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

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

מערכת 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 בעתיד.

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

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

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

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

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

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

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

הבדלים בין נתוני Analytics לבין נתוני מעקב ה-API

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

יש שתי מרווחי זמן שקובעים מתי ואם אפשר לצפות בנתוני Analytics:

• מרווח הזמן של עיכוב הנתונים – אחרי שמבצעים קריאה לשרת proxy של API, יכול להיות שיחלפו עד 10 דקות עד שהנתונים יהיו זמינים להצגה או דרך קריאות ל-API לניהול.
• שמירת נתונים – משך הזמן שבו נתוני Analytics נשמרים תלוי בחבילת המינוי שלכם:
  • רגיל: 30 יום
  • Enterprise: 3 חודשים
  • Enterprise Plus: 14 חודשים
  למידע נוסף, ראו המחירון של Apigee API Management.

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

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

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

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

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

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

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

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

• ביצועי מטמון
• התעניינות מצד מפתחים
• שימוש במכשיר
• ניתוח קודי שגיאה
• GeoMap
• ניתוח זמן אחזור
• יעדי ביצועים
• הרכב התנועה

מידע נוסף על מרכזי הבקרה המוגדרים מראש זמין במאמר שימוש במרכזי הבקרה של 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 שלכם. פורטלים למפתחים שמבוססים על Drupal כוללים דף אופציונלי בשם ביצועי אפליקציות, שנועד לתת למפתחי האפליקציות גישה למדדים חשובים של האפליקציות שלהם. בדף הזה מופיע מידע למפתחים על:

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

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

• Drupal 7: הצגת ניתוח נתונים של שימוש באפליקציה
• Drupal 8: מעקב אחרי אפליקציות
• פורטל משולב: לא זמין

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

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

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

מה המשמעות של ניתוח נתונים מלא? לדוגמה, אפשר ליצור שרת proxy ל-API, ו-Edge יאסוף נתוני ניתוח לגבי השרת הזה. אבל מה לגבי מדדים של המפתח או האפליקציה שהפעילו את שרת ה-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 לבין מעקב אחר API

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

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

במאמר השוואה בין מעקב API לבין Edge API Analytics תוכלו לקרוא השוואה מפורטת יותר בין השירותים האלה.

מידע נוסף

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