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

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע

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

יצירת דוח בהתאמה אישית על סמך ההקשר

אפשר ליצור במהירות דוחות בהתאמה אישית על סמך ההקשר שלכם, כפי שמסוכם בטבלה הבאה. בדף דוחות בהתאמה אישית, לדוחות בהתאמה אישית שנוצרו באמצעות API Monitoring יש שם ייחודי (כברירת מחדל), כמו שמוצג בטבלה. אפשר לשנות את השם כשעורכים את הדוח בהתאמה אישית.

מאפייני ברירת מחדל ומדדים

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

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

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

בדוח המותאם אישית הבא, מוסיפים את המאפיין המוגדר מראש Gateway Flow ID, שבו Gateway Flow ID מכיל את ה-UUID הייחודי של כל בקשת API שנשלחת אל Edge. שימו לב שהדוח כבר משתמש במאפיין Request URI:

בדוגמה הבאה מוסיפים את המאפיין Client ID לדוח המותאם אישית. המאפיין Client ID מכיל את טוקן הצרכן (מפתח ה-API) של המפתח שמבצע את הקריאה ל-API, בין אם הוא מועבר בבקשה כמפתח API או נכלל באסימון OAuth:

הדוח בהתאמה אישית מכיל מידע על כל הערכים של Client ID. בדוגמה הבאה מוסיפים מסנן כדי ליצור דוח בהתאמה אישית עבור Client ID ספציפי:

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

בדוגמה הבאה, מוסיפים מסנן לדוח מותאם אישית שכולל את מדדי ברירת המחדל ואת המאפיינים של policies.ratelimit.QuotaViolation קוד שגיאה וקודי סטטוס 5xx:

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

דוגמה: שימוש בדוחות בהתאמה אישית כדי לאבחן בעיות בהטמעה

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

לדוגמה, בקשות לשרת ה-proxy של ה-API כוללות כותרות של מזהה המוצר, מזהה המשתמש וגרסת שרת היעד. הבקשה יכולה להיות מהסוג הבא:

curl -H "prodid:123456" -H "userid:98765" -H "targetversion:beta" http://myapi.com/myapi

אחר כך תוכלו להשתמש במידע שבכותרות כדי לאבחן בעיות בזמן ריצה ב-proxy ל-API שלכם.

כדי ליצור דוח בהתאמה אישית עבור הכותרות האלה:

1. מוסיפים את מדיניות StatisticsCollector ל-API כדי לתעד את הערך של הכותרות המותאמות אישית:

   <StatisticsCollector name="publishPurchaseDetails">
     <Statistics>
       <Statistic name="prodid" ref="request.header.prodid" type="integer">0</Statistic>
       <Statistic name="userid" ref="request.header.userid" type="integer">0</Statistic>
       <Statistic name="targetversion" ref="request.header.targetversion" type="string">alpha</Statistic>
     </Statistics>
   </StatisticsCollector>

2. פורסים את ה-proxy וממתינים עד שתהיה אליו גישה.

3. בממשק המשתמש של Edge, לוחצים על Analyze > API Monitoring > Recent כדי לראות אם יש בעיות ב-API. שימו לב שאתם מקבלים שגיאות 4xx ו-5xx עבור ה-proxy‏ myapi:

   

4. בוחרים בשורת ה-proxy של myapi כדי לראות פרטים נוספים בחלונית הימנית של לוח הבקרה 'מהזמן האחרון'.

5. בחלונית הימנית של מרכז הבקרה 'אחרונים', בוחרים באפשרות > הצגה בכלי החקירה כדי לגשת למרכז הבקרה של כלי החקירה:

   

6. מסננים את מרכז הבקרה 'חקירה' לפי ה-proxy myapi ואז מעיינים בקוד הסטטוס בתרשים העליון. שימו לב שמופיעות שגיאות 403 ו-501:

   

7. בממשק המשתמש של Edge, בוחרים באפשרות Analytics > Custom Reports > Reports כדי ליצור דוח בהתאמה אישית שכולל את הערכים של המדדים המותאמים אישית האלה כמאפיין.

8. לוחצים על + דוח בהתאמה אישית כדי ליצור דוח בהתאמה אישית בשם myapi_errors.

9. בוחרים באפשרות Proxy Errors (שגיאות בשרת פרוקסי) בתפריט Metric (מדד) ומגדירים את Aggregate Function (פונקציית צבירה) ל-Sum (סכום). אפשר להוסיף עוד מדדים אם רוצים.

10. בוחרים במאפיין המוגדר מראש קוד סטטוס התגובה, ואז מוסיפים את שלושת הנתונים הסטטיסטיים המותאמים אישית prodid,‏ targetersion ו-userid אל 'מאפיינים':

    

11. מגדירים את המסנן כך שיכלול רק נתונים של proxy ל-API‏ myapi (apiproxy eq 'myapi'):

    

12. שומרים את הדוח.

13. מריצים את הדוח לגבי 24 השעות האחרונות. כשפותחים את הדוח בפעם הראשונה, מוצג תרשים של שגיאות HTTP 403 ו-501:

    

14. בקטע סיכום, לוחצים על 403 או על 510 כדי לראות איזה מוצר יוצר את השגיאות. לדוגמה, בוחרים באפשרות 403:

    

15. לוחצים על מזהה מוצר בקטע סיכום כדי לראות את השגיאות לפי גרסת היעד (אלפא או בטא):

    

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