הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.
לעיון במסמכי התיעוד של
Apigee Edge
במסמך הזה מוצג Apigee API Analytics, שמאפשר ניטור תפעולי מעמיק של מקרים ספציפיים של שער Apigee. הוא מספק נתונים מפורטים לבדיקת בעיות ברמת ה-proxy בסביבה יחידה. באמצעות Apigee API Analytics, אפשר לגשת לדוחות מפורטים, כולל מדדי יעד וניתוח למפתחים.
שיפור ה-API באמצעות ניתוח נתונים
Apigee API Analytics אוסף ומחשב כמות גדולה של מידע שזורם דרך שרתי proxy ל-API. אפשר להציג את הנתונים האלה באמצעות גרפים ותרשימים בממשק המשתמש של Apigee, או להוריד את הנתונים הגולמיים לניתוח אופליין באמצעות ממשקי ה-API של Apigee.
בעזרת ניתוח הנתונים תוכלו לקבל תשובות לשאלות נפוצות, כמו:
- מהי המגמה של התנועה ב-API לאורך זמן?
- אילו שיטות API הכי פופולריות?
- מי הם המפתחים המובילים שלי?
- מתי זמני התגובה של ה-API הכי מהירים? הכי איטי?
- מבחינה גיאוגרפית, מאיפה מגיעה הכי הרבה תנועה ל-API?
- כמה הכנסות נוצרו מהעסקאות?
אתם יכולים לנתח נתונים של שם מארח ספציפי או של סביבה שלמה.
התשובות לשאלות כאלה עוזרות לכם לשפר את ממשקי ה-API, לפתור בעיות ולקבל החלטות עסקיות טובות יותר שקשורות לתוכנית ה-API שלכם.
ניתוח נתוני API עוזר לכולם להשתפר
בעזרת תהליך מתמשך של איסוף, ניתוח והצגה חזותית של נתונים, Apigee API Analytics עוזר לצוות ה-API לשפר את ממשקי ה-API שלו ולמפתחי האפליקציות לשפר את האפליקציות שלהם:
- צוות ה-API – צוות ה-API משתמש במערכות פנימיות כדי ליצור ממשקי API מעניינים. צוות ה-API רוצה לדעת מה מצב תוכנית ה-API באופן כללי, מה מצב ממשקי ה-API השונים ואיך אפשר לשפר אותם.
- מפתחי אפליקציות – שיתוף נתוני ניתוח עם מפתחי אפליקציות מאפשר לכם לקבל אפליקציות טובות יותר. המפתחים האלה מחדשים באמצעות ה-API שלכם ויוצרים אפליקציות יצירתיות שעוזרות להגדיל את ההכנסות של הארגון. נתוני הניתוח עוזרים למפתחי האפליקציות להבין את הביצועים של האפליקציות שלהם ואת התרומה שלהן לשורה התחתונה של הארגון. מפתחי האפליקציות רוצים לדעת איך לשפר את האפליקציות שלהם.
- צוות התפעול – צוות התפעול רוצה להבין את דפוסי התנועה ולצפות מתי צריך להוסיף משאבי קצה עורפי או לבצע שינויים קריטיים אחרים.
- בעל העסק – בעל העסק רוצה לראות אם ההשקעה שלו ב-API משתלמת, ואיפה כדאי להשקיע ב-API בעתיד.
איך מתחילים להשתמש ב-Apigee API Analytics?
סוג הארגון של Apigee שבו אתם משתמשים יקבע את השלבים שנדרשים כדי להתחיל להשתמש ב-Apigee API Analytics. אם אתם לא בטוחים אם אתם משתמשים בארגון Apigee עם מינוי או עם תשלום לפי שימוש, פנו לאדמין של ארגון Apigee שלכם.
מידע על שימוש ב-Apigee API Analytics עם Apigee Hybrid זמין במאמר דרישות Apigee Hybrid.
שימוש ב-Apigee API Analytics בארגון עם מינוי
אם יש לכם מינוי ל-Apigee, הגישה ל-Apigee API Analytics כלולה בהרשאות המינוי ומופעלת אוטומטית בכל אחד מהסביבות של Apigee.
אתם יכולים לגשת לנתוני הניתוח של הארגון של המינוי באמצעות ממשק המשתמש של Apigee במסוף Cloud או Apigee API. פרטים נוספים זמינים במאמר איך ניגשים לנתוני הניתוח.
שימוש ב-Apigee API Analytics בארגון עם תשלום לפי שימוש
אם אתם לקוחות של תוכנית Pay-as-you-go, אתם צריכים להפעיל את Apigee API Analytics כתוסף בתשלום כדי להתחיל להשתמש בנתוני הניתוח. למידע נוסף על הפעלת התוסף Apigee API Analytics בסביבות הביניים או בסביבות המקיפות של Apigee, אפשר לעיין במאמר בנושא ניהול התוסף Apigee API Analytics.
אחרי שמפעילים את התוסף Apigee API Analytics בסביבות שלכם, אפשר לגשת לנתוני הניתוח ולנהל את התוסף Apigee API Analytics באמצעות ממשק המשתמש של Apigee במסוף Cloud או באמצעות Apigee API. מידע נוסף זמין במאמר איך ניגשים לנתוני הניתוח. נתוני Analytics וניהול תוספים לא זמינים בממשק המשתמש הקלאסי של Apigee בארגונים עם תשלום לפי שימוש.
אילו סוגי נתונים נאספים ומנותחים?
Apigee API Analytics אוסף ומנתח מגוון רחב של נתונים שזורמים דרך שרתי proxy של API, כמו:
- מועד התשובה
- זמן האחזור של הבקשה
- גודל הבקשה
- שגיאות שקשורות ליעד
- שם מוצר ה-API
- כתובת האימייל של המפתח או מזהה קבוצת האפליקציות
- שם האפליקציה
- הכנסות מעסקאות
רשימה מלאה של הנתונים שנאספים על ידי API Analytics זמינה במאמר הפניה למדדים, למאפיינים ולמסננים של Analytics.
איך אוספים נתוני ניתוח בהתאמה אישית?
Apigee אוסף באופן מובנה כמות גדולה של נתונים. אולי תרצו גם לאסוף נתוני ניתוח בהתאמה אישית שספציפיים לשרתי ה-proxy של ה-API, לאפליקציות, למוצרים או למפתחים שלכם. לדוגמה, יכול להיות שתרצו לאסוף נתונים אנליטיים מפרמטרים של שאילתות, מכותרות של בקשות, מגופי בקשות ותגובות או ממשתנים שאתם מגדירים בממשקי ה-API.
אתם יכולים לאסוף נתוני ניתוח בהתאמה אישית באמצעות המדיניות DataCapture, ואז להשתמש בממשק המשתמש או ב-API של Analytics כדי לבדוק את הנתונים שנאספו.
מתי הנתונים של ניתוח הביצועים זמינים וכמה זמן הם נשמרים?
יש שני מרווחי זמן שקובעים מתי וכמה זמן אפשר לצפות בנתוני Analytics:
- מרווח הזמן של עיכוב הנתונים – אחרי שמתבצעת קריאה ל-proxy ל-API, יכול לעבור עד 10 דקות עד שהנתונים יהיו זמינים להצגה או דרך קריאות ל-API.
- זמינות של נתוני Analytics – תקופת השמירה של נתוני Analytics היא 14 חודשים.
שמירת נתונים ב-Analytics כשמשתמשים בתוסף Apigee API Analytics
אם יש לכם ארגון עם תשלום לפי שימוש, אתם יכולים להפעיל את התוסף Apigee API Analytics ברמת הסביבה. אחרי שמפעילים את התוסף בסביבה מסוימת, נתוני הניתוח של הסביבה נשמרים למשך 14 חודשים. אפשר לגשת לנתוני ניתוח היסטוריים של הסביבה מהדף API Metrics במסוף, כל עוד התוסף מופעל.
אם משביתים את התוסף Apigee API Analytics בסביבה בארגון עם תשלום לפי שימוש, נתוני הניתוח של הסביבה נמחקים אחרי 30 יום. אם מפעילים מחדש את התוסף באותה סביבה תוך 30 יום מההשבתה, אפשר לקבל שוב גישה לנתוני הניתוח של הסביבה למשך תקופת השמירה של 14 חודשים. אם מפעילים מחדש את התוסף בסביבה אחרי 30 יום, לא מתבצע שחזור של הנתונים.
אם אתם רוצים לשמור נתונים של Analytics לגבי סביבה כלשהי בארגון עם תשלום לפי שימוש מעבר לתקופת השמירה של 14 חודשים, מומלץ לייצא את הנתונים ולשמור אותם במיקום אחר. כדאי גם לייצא את נתוני Analytics לפני שמשביתים את התוסף Apigee API Analytics, או במהלך 30 הימים שלאחר ההשבתה. מידע נוסף זמין במאמר בנושא ייצוא נתונים מ-Analytics.
איפה נתוני הניתוח שלי מאוחסנים ומעובדים?
המיקום שבו נתוני הניתוח מאוחסנים ומעובדים נקבע לפי האזור של Analytics, שציינתם כשביצעתם את ההתקנה של Apigee:
- אם אתם לקוחות של מינוי והתקנתם את Apigee באמצעות אשף ההקצאה של Apigee, ציינתם את אזור הניתוח שלכם ב שלב 3: הגדרת אירוח והצפנה באשף ההקצאה, כשבחרתם את אזור הניתוח.
- אם אתם לקוחות עם תשלום לפי שימוש והתקנתם את Apigee באמצעות מסוףGoogle Cloud , ציינתם את האזור של Analytics ב שלב 3: הגדרת אירוח והצפנה באשף ההקצאה, כשבחרתם את האזור של Analytics.
-
אם התקנתם את Apigee משורת הפקודה כלקוחות במינוי או בשיטת התשלום 'משלמים לפי השימוש', ציינתם את אזור הניתוח כשהגדרתם את משתנה הסביבה
ANALYTICS_REGION, כפי שמתואר במאמרים הבאים:- עם VPC peering: שלב 1: הגדרת משתני סביבה
- ללא VPC peering: שלב 1: הגדרת משתני סביבה
-
אם התקנתם את Apigee באמצעות
אפשרות ההתקנה בלחיצה אחת, נתוני הניתוח מאוחסנים באזור
us-west1. אי אפשר לשנות את מיקום ברירת המחדל.
הנתונים ב-Analytics נשמרים ומעובדים באופן הבא:
- במקרה של אזורי ניתוח שלא נמצאים בארה"ב או באיחוד האירופי, נתוני הניתוח מאוחסנים ומעובדים באזור הניתוח.
- במקרה של אזורי ניתוח נתונים בארה"ב או באיחוד האירופי, הנתונים מאוחסנים באזור רב-אזורי בארה"ב או באיחוד האירופי, בהתאמה, כדי להבטיח זמינות גבוהה יותר.
איך ניגשים לנתוני הניתוח?
Apigee API Analytics מספק כלי ויזואליזציה של נתונים שמוטמעים בממשק המשתמש של Apigee. הכלים האלה כוללים לוחות בקרה מוגדרים מראש לניתוח נתונים ודוחות בהתאמה אישית שמציגים נתונים בתרשימים ובגרפים, ומאפשרים לכם להציג נתונים שמקובצים לפי מאפיינים שונים (למשל לפי proxy ל-API, כתובת IP או קוד סטטוס של HTTP).
אפשר גם להוריד נתוני ניתוח באמצעות Apigee API. אחרי ההורדה, תוכלו לייבא את הנתונים האלה לכלי משלכם להצגת נתונים בתצוגה חזותית או למערכת ניתוח.
מרכזי בקרה של Analytics
ממשק המשתמש של Apigee כולל קבוצה של מרכזי בקרה מוגדרים מראש שבהם אפשר לראות נתונים של ניתוח.
Apigee במסוף Cloud
כדי לפתוח את לוחות הבקרה של Analytics (בארגונים עם תשלום לפי שימוש או מינוי):
במסוף Google Cloud , נכנסים לדף Apigee > Analytics > API metrics.
בתמונה הבאה מוצג לוח הבקרה API Proxy Performance:
בוחרים מבין הכרטיסיות הבאות כדי לראות את מרכזי הבקרה:
מידע נוסף זמין במאמר שימוש בלוחות הבקרה של ניתוח הנתונים.
דוחות מותאמים אישית
דוחות בהתאמה אישית מאפשרים לכם להתעמק במדדים ספציפיים של ה-API ולראות את הנתונים המדויקים שאתם רוצים לראות. אתם יכולים ליצור דוח בהתאמה אישית באמצעות כל נתוני הניתוח שמוטמעים ב-Apigee.
כשיוצרים דוח בהתאמה אישית, בוחרים את הנתונים שרוצים לראות (מדדים), מקבצים את הנתונים בדרכים משמעותיות (מאפיינים) ואם רוצים, מגבילים את הנתונים שמוחזרים על סמך מאפיינים ספציפיים של הנתונים (סינון).
אפשר גם להגדיר את סוג התרשים שיוצג בדוח המותאם אישית כתרשים עמודות או כתרשים קו. בתמונות הבאות מוצגות דוגמאות לתרשימים של עסקאות בשנייה שמקובצות לפי proxy ל-API:
עמודה – כל proxy ל-API מיוצג על ידי עמודה אחרת:
קו – כל proxy ל-API מיוצג על ידי קו אחר:
מידע נוסף מופיע במאמר בנושא יצירה וניהול של דוחות בהתאמה אישית.
Analytics API
משתמשים ב-Apigee API כדי להוריד נתוני ניתוח. לדוגמה, אפשר להשתמש ב-API כדי ליצור כלי ויזואליזציה משלכם שאפשר להטמיע בפורטלים או באפליקציות בהתאמה אישית.
הנה דוגמה לקריאה ל-API כדי לאחזר נתוני ניתוח של שרתי proxy של API:
curl "https://apigee.googleapis.com/v1/organizations/myorg/environments/test/stats/apiproxy?select=sum(message_count)&timeRange=6/24/2022%2000:00~6/25/2022%2023:59&timeUnit=hour" \ -H "Authorization: Bearer $TOKEN"
הפונקציה הזו מחזירה:
- סכום הבקשות (מספר ההודעות) לכל 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.
מידע נוסף זמין במאמר שימוש ב-Metrics API.
ייצוא נתוני ניתוח ל-Google Cloud Platform
אתם יכולים להשתמש ב-Apigee API כדי לייצא את כל נתוני הניתוח של יום שלם מ-Apigee למאגר נתונים משלכם, כמו Google Cloud Storage או BigQuery. לאחר מכן תוכלו להשתמש ביכולות החזקות של שאילתות ולמידת מכונה שמוצעות על ידי Google Cloud BigQuery ו-TensorFlow כדי לבצע ניתוח נתונים משלכם.
מידע נוסף זמין במאמר ייצוא נתונים מ-Analytics.
איך משתפים נתונים עם מפתחי אפליקציות?
אם אתם רואים במפתחי אפליקציות את הלקוחות שלכם, אתם רוצים לוודא שיש להם את הכלים והמידע שזמינים להם כדי להפיק את המרב מה-API שלכם.
מפתחי אפליקציות לא מתעניינים רק באיכות האפליקציות שלהם, אלא גם בממשקי ה-API שלכם. פורטל המפתחים שמבוסס על Drupal כולל דף אופציונלי בשם App Performance (ביצועי האפליקציה), שנועד לתת למפתחי אפליקציות גישה למדדים חשובים לגבי האפליקציות שלהם. בדף הזה מפתחים יכולים למצוא מידע על:
- שגיאות: אילו שגיאות API מוצגות באפליקציה שלי?
- ביצועים: האם ה-API איטי? אילו methods של API בדרך כלל איטיים או איטיים כרגע?
- זמינות: האם ממשק ה-API פועל או לא?
- מכסה: האם ל-API יש מכסה? ואם אני מפתח אפליקציות, איך אני יכול לדעת מה מצב השימוש שלי ביחס למכסה?
מידע נוסף זמין במאמר Monitor apps בתיעוד של Drupal 8.
בנוסף, אתם יכולים לשתף את ניתוח הנתונים עם המפתחים שלכם באופן הבא:
- יצירת דוחות בהתאמה אישית ושיתוף שלהם עם מפתחי האפליקציות. מידע נוסף מופיע במאמר בנושא יצירה וניהול של דוחות בהתאמה אישית.
- שימוש בממשקי ה-API של המדדים כדי לתעד נתונים לאורך תקופה ארוכה יותר ולשתף אותם עם מפתחי אפליקציות אופליין. מידע נוסף זמין במאמר בנושא שימוש בממשקי ה-API של המדדים.
איך אפשר ליצור נתוני ניתוח מלאים?
מה הכוונה בניתוח נתונים מלא? לדוגמה, אתם יכולים ליצור proxy ל-API ומערכת Apigee תאסוף נתוחי נתונים לגבי ה-proxy הזה. אבל מה לגבי מדדים של המפתח או האפליקציה ששלחו קריאה ל-proxy ל-API? אם מערכת Apigee לא יודעת מי ביצע קריאה ל-API, היא לא יכולה לאסוף את הנתונים האלה.
כדי ש-Apigee יוכל לזהות אילו מפתחים ואילו אפליקציות למפתחים קוראים ל-API proxies שלכם, צריך לבצע כמה שלבים. הנה רשימה של השלבים האלה עם קישורים למידע מפורט יותר:
- יוצרים מוצר API אחד או יותר, שהוא קבוצה של שרתי proxy ל-API עם תוכנית שירות. מידע נוסף זמין במאמר בנושא ניהול מוצרי API.
- רישום מפתחי אפליקציות ב-Apigee. מידע נוסף זמין במאמר בנושא רישום של מפתחי אפליקציות.
- רישום אפליקציות וניהול מפתחות API עבור המפתחים. הרשמה של אפליקציות וניהול של מפתחות API
- מוסיפים מדיניות אבטחה לשרתי ה-API הפרוקסי כדי לאמת מפתחות API ו/או אסימוני אבטחה. אפשר לעיין בנושאים הבאים: מדיניות VerifyAPIKey, מדיניות OAuthV2 ומדיניות VerifyJWT.
המדריכים הבאים מפרטים את השלבים הנדרשים כדי לראות ניתוח נתונים למפתחים ולאפליקציות: אבטחת API באמצעות דרישה של מפתחות API ואבטחת API באמצעות OAuth.
DRZ ועמידה בדרישות FedRAMP
Apigee API Analytics תואם למיקום נתונים (DRZ) עבור נתונים באחסון. מידע נוסף זמין במאמר שליטה על המיקום של הנתונים ב-Apigee.
הדרישות ל-Apigee Hybrid
בקטע הזה מפורט מידע חשוב למשתמשי Apigee hybrid.
דרישות כלליות
כדי להשתמש ב-Apigee API Analytics עם Apigee Hybrid:
- צריך להגדיר את חשבון השירות
apigee-udca. ראו יצירת שינויים בהגדרות. - מוודאים שהשעונים בכל הצמתים של הכלי לסנכרון מסונכרנים ומוגדרים לפי שעון UTC.
תמיכה במיקום הנתונים
אם יצרתם ארגון חדש ב-Apigee hybrid v1.13.1 עם מיקום נתונים מופעל, אתם צריכים לפעול לפי השלבים במאמר שימוש במיקום נתונים ב-Apigee hybrid.
בגרסה היברידית 1.14 ואילך, צינור הנתונים החדש הוא ברירת המחדל לכל הארגונים ההיברידיים, ללא קשר להפעלה או להשבתה של שמירת נתונים.