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

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X.
מידע

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

איך אפשר לגשת לנתוני הניתוח?

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

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

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

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

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

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

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

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

דוחות בהתאמה אישית

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

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

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

alt_text

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

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

למידע נוסף:

כמו כן, אתם יכולים לשתף את ניתוח הנתונים עם המפתחים שלכם על ידי:

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

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

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

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

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

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

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

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

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

מידע נוסף