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

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

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

סרטונים

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

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

מידע על דוחות מותאמים אישית

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

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

  • עמודה - כל שרת proxy של API מיוצג על ידי עמודה שונה:

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

  • שורה - כל API מיוצג בשורה נפרדת:

    תרשים קו בהתאמה אישית

הגדרת מדדים ומאפיינים

metrics שבחרת לדוח המותאם אישית מציינים את הנתונים שאתה מנסה למדוד. בין המדדים הנפוצים:
  • טרנזקציות לשנייה
  • זמן תגובה
  • שגיאות שקשורות למדיניות

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

  • avg: מחזירה את זמן התגובה הממוצע.
  • min: מחזירה את זמן התגובה המינימלי.
  • max: מחזירה את זמן התגובה המקסימלי.
  • sum: מחזירה את הסכום של כל זמן התגובה.

חלק מהמדדים לא תומכים בכל פונקציות הצבירה. במאמרי העזרה בנושא metrics יש טבלה שמציינים את שם המדד ואת הפונקציה (sum, avg, min, max) שנתמכת במדד.

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

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

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

  • עמודה: כל עמודה תואמת לערך שונה של המאפיין.
  • קו: כל שורה בתרשים מייצגת ערך שונה של המאפיין, וציר ה-X מייצג זמן.

יצירת מדדים ומאפיינים מותאמים אישית

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

אופן ההפצה של נתוני ניתוח מותאמים אישית בדוח מותאם אישית תלוי בסוג הנתונים:

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

במדיניות של StatStatsCollector אפשר לראות דוגמאות לאיסוף נתונים בהתאמה אישית.

הגדרת מסננים

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

המסננים משתמשים בתחביר תנאי שמאפשר ליצור מסננים מורכבים באמצעות אופרטורים כמו eq, ne, gt, lt ועוד.

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

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

  • type = עמודה
  • מדד = ממוצע עסקאות לשנייה
  • מאפיין = API Proxy

הדוח בהתאמה אישית מכיל תרשים עמודות עם נתוני המדד 'ממוצע עסקאות לשנייה', שמקובצים לפי המאפיין של שרת ה-proxy של ה-API:

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

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

תיבת פיזור

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

  • type = עמודה
  • מדד = ממוצע עסקאות לשנייה
  • מדד = שגיאות מדיניות
  • מאפיין = API Proxy

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

דוח מותאם אישית שני מדדים

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

  • type = עמודה
  • מדד = ממוצע עסקאות לשנייה
  • מדד = שגיאות מדיניות
  • מאפיין = API Proxy
  • מאפיין = פועל בקשה

התרשים מציג בהתחלה את המדדים המקובצים לפי שרת proxy, המאפיין הראשון שצוין כשיצרת את הדוח בהתאמה אישית:

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

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

הצגת פירוט של שני מאפיינים של דוח מותאם אישית

ככל שמוסיפים יותר ויותר מאפיינים לדוח המותאם אישית, ממשק המשתמש משתנה כדי להציג פירוט של הדוח לפי כל מאפיין.

הצגת כל הדוחות בהתאמה אישית

נכנסים לדף 'דוחות בהתאמה אישית' כמו שמתואר בהמשך.

Edge

כדי לגשת לדף הדוחות בהתאמה אישית באמצעות ממשק המשתמש של Edge:

  1. נכנסים לחשבון בכתובת https://apigee.com/edge.
  2. בוחרים באפשרות ניתוח > דוחות מותאמים אישית > דוחות.

Classic Edge (ענן פרטי)

כדי לגשת לדף הדוחות בהתאמה אישית באמצעות ממשק המשתמש הקלאסי Edge:

  1. נכנסים אל http://ms-ip:9000. ms-ip הוא כתובת ה-IP או שם ה-DNS של הצומת של שרת הניהול.
  2. בוחרים באפשרות Analytics > דוחות.

הדף 'דוחות בהתאמה אישית' מציג את כל הדוחות בהתאמה אישית שנוצרו עבור הארגון שלך, כפי שמוצג באיור הבא:

מרכז הבקרה של דוחות בהתאמה אישית

כפי שמודגש באיור, דף הדוחות המותאמים אישית מאפשר לך:

היכרות עם מרכז הבקרה של דוח מותאם אישית

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

מרכז הבקרה של דוחות בהתאמה אישית

מרכז השליטה של דוח מותאם אישית מאפשר לך:

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

  • כדי לנתח מדד, לוחצים על הסמל בשורת הטבלה של המדד המשויך. הצגת חריגות והשוואה שלהן לתקופה קודמת או למדדים אחרים.
  • כדי להפעיל דוח בהתאמה אישית, לוחצים על טווח הזמן ומגדירים אותו.
  • מורידים את הדוח בהתאמה אישית כקובץ CSV. השם של הקובץ הוא: metric.csv. לדוגמה: Average_of_total_response_time.csv
  • עורכים את הדוח בהתאמה אישית.

הכרת מרכז הבקרה של ניתוח המדדים

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

ניתוח המדד

בתרשימים האלה מוצגים הפרטים הבאים:

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

    • הממוצע הנע של המדד שמוצג כקו. עבור נקודה נתונה על הקו, הערך של הממוצע הנע מחושב כממוצע של ערך המדד באותה נקודת זמן, ושל ערכי המדד בשתי הנקודות הקודמות על הגרף.
    • האזור הכחול של התרשים מגדיר את הערך המקסימלי ואת הממוצע הממוצע של ערכי המינימום עבור הערך. המקסימום הממוצע הוא 1.2 * (ממוצע נע), והממוצע הממוצע הוא 0.8 * (ממוצע נע).

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

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

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

אחרי שמוסיפים את הדוח בהתאמה אישית, צריך run אותו באופן סינכרוני או אסינכרוני.

כדי להוסיף דוח בהתאמה אישית:

  1. נכנסים לדף 'דוחות בהתאמה אישית'.
  2. לוחצים על + דוח בהתאמה אישית.
  3. בקטע Basic (בסיסי), מזינים את הפרטים הבאים:
    שדה תיאור
    שם הדוח שם הדוח.
    תיאור הדוח תיאור הדוח.
    סוג התרשים בחירת סגנון התרשים שישמש להצגת הנתונים בהתאמה אישית של ניתוח הנתונים.
    • עמודה: ציר ה-X מייצג קבוצות שהוקצו לפי מאפיינים.
    • קו: ציר ה-X מייצג זמן.
  4. בקטע 'מדדים':
    1. לוחצים על הסמל לצד מדדים.
    2. בוחרים את המדד שרוצים לנתח.
    3. בוחרים פונקציית צבירה כדי להציג את הערכים 'סיכום', 'ממוצע', 'מינימום' או 'מקס'.
    4. לוחצים על שמירה.
    5. לוחצים על הסמל כדי להוסיף עוד מדדים.
  5. בקטע מאפיינים, לוחצים על ובוחרים מאפיין, כמו "שרת proxy", כדי להגביל את מערך הנתונים שמשמש ליצירת הדוחות. אפשר להוסיף מאפיינים כדי להגביל עוד יותר את הנתונים.
  6. בקטע Filters, תוכלו לצמצם עוד יותר את הנתונים שמוצגים על ידי הוספת מסננים להגדרת הדוח. לדוגמה, אפשר להוסיף מסנן שמחריג נתונים עבור שרת proxy של ממשק ה-API של מזג האוויר או עבור המפתח jane@example.com.

    1. לוחצים על ובוחרים את שם הישות שלפיה רוצים לסנן, אופרטור כמו = או !=, וערך.
    2. לוחצים על הוספה כדי לשמור את המסנן.
    3. לוחצים על כדי להוסיף עוד מסננים, ובוחרים מחבר AND או OR.
  7. כדי להגביל את המשתמשים שיכולים לגשת לדוח בהתאמה אישית, עורכים את התפקידים בהתאמה אישית שמוגדרים עבור הדוח.

    1. כדי לערוך את ההגדרות של התפקיד בהתאמה אישית, לוחצים על .
    2. בוחרים את התפקיד המותאם אישית הנדרש כדי לגשת לדוח ואת רמת הגישה (הצגה, עריכה, מחיקה).
    3. לוחצים על הוספה.
    4. כדי לערוך תפקידים נוספים, יש ללחוץ על הסמל .
  8. כדי לשמור את הדוח, לוחצים על Save (שמירה).

הפעלת דוח בהתאמה אישית

Edge Analytics מאפשר להריץ דוח באופן סינכרוני או אסינכרוני.

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

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

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

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

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

כדי להריץ דוח בהתאמה אישית לטווח זמן ספציפי:

  1. נכנסים לדף 'דוחות בהתאמה אישית'.
  2. בוחרים את הדוח שרוצים להריץ. כברירת מחדל, בדוח מוצגים נתונים מהשעה הקודמת.
  3. כדי להריץ את הדוח עבור טווח זמן אחר:

    1. לוחצים באזור טווח הזמן בחלק העליון של הדוח כדי לפתוח את החלון הקופץ בחירת זמן לדוח מותאם אישית.
    2. בוחרים באחת מהאפשרויות הבאות:
      • טווח זמן מוגדר מראש, למשל השעה האחרונה, אתמול או 7 הימים האחרונים.
      • טווח מותאם אישית: בוחרים תאריך ושעה בשדה מאת/אל, או משתמשים ביומן כדי לבחור תאריכי התחלה וסיום. לוחצים על UTC כדי להשתמש בתיאום זמן אוניברסלי (UTC).

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

      • שלח משימה כדי להריץ את הדוח באופן אסינכרוני כמשימת רקע. תופיע תיבת הדו-שיח הבאה:

        שליחה אסינכרונית

        לוחצים על הצגת הסטטוס בתיבת הדו-שיח כדי להציג את הסטטוס של משימת הדוח בהתאמה אישית.

הצגת משימות של דוח מותאם אישית אסינכרוני

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

  • לוחצים על הצגת הסטטוס בתיבת הדו-שיח 'דוח נשלח כמשימת רקע'.
  • בסרגל הניווט הימני, בוחרים באפשרות ניתוח > דוחות מותאמים אישית > דיווח על משימות.

הדף 'דוח משרות' מוצג, כמו באיור הבא:

דיווח על משרות

הדף 'דוח משרות' מאפשר לכם:

  • הצגת כל תוצאות המשימות של דוח מותאם אישית אסינכרוני שנשלחו ב-7 הימים האחרונים.

  • בוחרים את הסביבה שעבורה רוצים להציג משימות של דוחות בהתאמה אישית.

  • כדי להציג את הדוח בהתאמה אישית, צריך לוודא שהסטטוס שלו הושלם. לאחר מכן מעבירים את העכבר מעל השורה שתואמת לדוח. יופיעו הסמל להצגת הדוח והסמל הורדת הדוח. כדי להציג את הדוח, צריך לבחור את להצגת הדוח.

  • כדי להוריד את הדוח בהתאמה אישית, לוחצים על הורדת הדוח.

    ניתן להוריד את הדוח המלא כקובץ ZIP בשם OfflineQueryResult-xxx.zip שמכיל את קובצי ה-CSV.

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

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

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

  1. נכנסים לדף 'דוחות בהתאמה אישית'.
  2. מעבירים את העכבר מעל שם הדוח שרוצים לערוך. סמלי העריכה והמחיקה של מופיעים בצד שמאל של הדף.
  3. לוחצים על סמל העריכה.
  4. עריכת הפרטים של הדוח בהתאמה אישית.
  5. לוחצים על שמירה.

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

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

כדי למחוק דוח בהתאמה אישית:

  1. נכנסים לדף 'דוחות בהתאמה אישית'.
  2. מעבירים את העכבר מעל שם הדוח שרוצים לערוך. סמלי העריכה והמחיקה של מופיעים בצד שמאל של הדף.
  3. כדי למחוק את הדוח, לוחצים על סמל המחיקה.