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

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

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

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

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

ההקשר של דוח בהתאמה אישית	מוסכמת ברירת המחדל למתן שמות לדוח בהתאמה אישית
מרכז הבקרה מהתקופה האחרונה	API Monitoring Recent Generated
מרכז הבקרה לציר הזמן	API Monitoring Timeline Generated
לבדיקת מרכז הבקרה	API Monitoring Investigate Generated
תנאי להתראה	API Monitoring Generated: alert-name

המאפיינים והמדדים שמוגדרים כברירת מחדל

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

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

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

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

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

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

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

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

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

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

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

1. מוסיפים את המדיניותStatStatsCollector ל-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. כדי להציג בעיות ב-API, לוחצים על ניתוח > API Monitoring > לאחרונה בממשק המשתמש של Edge. לתשומת ליבך: מתקבלות שגיאות 4xx ו-5xx לגבי שרת ה-proxy של myapi:

   

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

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

   

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

   

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

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

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

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

    

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

    

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

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

    

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

    

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

    

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