הפניה למדדים, למאפיינים ולמסננים ב-Analytics

הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

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

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

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

מדדים

בהמשך מפורטים מדדי ה-API שאפשר לאחזר בדוחות בהתאמה אישית ובקריאות ל-Apigee API.

מדד	השם לשימוש ב-Apigee API	פונקציות	תיאור
ממוצע העסקאות לשנייה	tps	ללא	מספר העסקאות הממוצע, כלומר בקשות של שרתי proxy ל-API, בכל שנייה. שימו לב: אם יש לכם מספר נמוך יחסית של עסקאות במהלך תקופת הזמן, יכול להיות שהמספר הממוצע של עסקאות לשנייה יופיע כאפס בדוחות בהתאמה אישית בממשק המשתמש אם המספר קטן משני מקומות אחרי הנקודה העשרונית. תחביר API: tps
מציאה במטמון (cache hit)	cache_hit	סכום	מספר הבקשות המוצלחות ל-API שמשתמשות ב-ResponseCache במקום בתגובה משירות היעד. תחביר API: sum(cache_hit)
מספר הרכיבים במטמון L1	ax_cache_l1_count	ממוצע, מינימום, מקסימום	מספר הרכיבים במטמון L1 (בזיכרון) לכל עסקה במהלך תקופת זמן נתונה. לדוגמה, אם בוחרים max לתקופה של יום, ובמהלך אותו יום המספר הכי גבוה של רכיבים במטמון הוא 12 לעסקה ספציפית, אז הערך יהיה 12. לדוגמה, אם יש שלוש עסקאות בטווח הזמן שאתם שולחים לגביו שאילתה, ומספרים המטמון שלהן הם 5, 6 ו-7, הממוצע הוא 6.avg מטמון L1 הוא מטמון בזיכרון, בניגוד למטמון מסד נתונים L2, כפי שמתואר במאמר פרטים על המטמון. תחביר API: avg(ax_cache_l1_count)
שגיאות שקשורות למדיניות	policy_error	סכום	המספר הכולל של שגיאות שקשורות למדיניות בטווח הזמן שצוין. שגיאות שקשורות למדיניות מתרחשות בדרך כלל כחלק מהעיצוב. לדוגמה, מדיניות VerifyApiKey מחזירה שגיאה כשמפתח API לא תקין מועבר בבקשה, ומדיניות SpikeArrest מחזירה שגיאה אם מספר הקריאות ל-API חורג מהמגבלה שמוגדרת במדיניות. לכן, המדד הזה שימושי למציאת נקודות בעייתיות פוטנציאליות בממשקי ה-API. לדוגמה, יכול להיות שבעזרת מדדים של policy_error שמקובצים לפי מאפיין developer_app, תגלו שתוקף של מפתח API או של טוקן OAuth פג עבור אפליקציה מסוימת. לחלופין, יכול להיות שתגלו שפרוקסי ספציפי של API מחזיר הרבה SpikeArrest שגיאות מדיניות, ותבינו שמגבלת העלייה החדה של הפרוקסי לא לוקחת בחשבון את העלייה בתנועה בתקופת החגים. שגיאת מדיניות נרשמת ביומן של ניתוח הנתונים רק אם השגיאה גורמת לכשל ב-proxy ל-API. לדוגמה, אם המאפיין continueOnError של מדיניות מוגדר לערך true, ה-proxy ל-API ממשיך לעבד בקשה גם אם המדיניות נכשלת. במקרה כזה, שגיאת מדיניות לא נרשמת ביומן של ניתוח הנתונים. המאפיין 'שם המדיניות בשגיאה' (ax_execution_fault_policy_name) שימושי לקיבוץ שגיאות מדיניות לפי שם המדיניות. כשל ביעד (למשל 404 או 503) לא נחשב ככשל במדיניות. הן נחשבות ככשלים בשרתי proxy ל-API (is_error). תחביר API: sum(policy_error)
שגיאות בשרת ה-proxy	is_error	סכום	המספר הכולל של הפעמים שבהן שרתי proxy של API נכשלו בטווח הזמן שצוין. שגיאה בשרת proxy יכולה להתרחש כשמדיניות נכשלת או כשמתרחשת שגיאת זמן ריצה, כמו 404 או 503 משירות היעד. המאפיין Proxy ‏ (apiproxy) שימושי לקיבוץ של כשלים ב-proxy ל-API לפי proxy. תחביר API: sum(is_error)
זמן האחזור של עיבוד הבקשה	request_processing_latency	ממוצע, מינימום, מקסימום	משך הזמן (ממוצע, מינימלי או מקסימלי), באלפיות השנייה, שנדרש ל-Apigee לעיבוד בקשות נכנסות. הזמן מתחיל כשהבקשה מגיעה ל-Apigee ומסתיים כש-Apigee מעביר את הבקשה לשירות היעד. באמצעות מאפיינים שונים, אפשר לבדוק את זמן האחזור של עיבוד הבקשות לפי שרת proxy ל-API, לפי אפליקציה של מפתח, לפי אזור וכן הלאה. תחביר API: max(request_processing_latency)
גודל הבקשה	request_size	סכום, ממוצע, מינימום, מקסימום	גודל המטען הייעודי (payload) של הבקשה שהתקבל על ידי Apigee, בבייטים. תחביר API: avg(request_size)
מטמון התשובות הופעל	ax_cache_executed	סכום	המספר הכולל של הפעמים שבהן בוצעה מדיניות ResponseCache במהלך תקופת הזמן שצוינה. מכיוון שמדיניות ResponseCache מצורפת לשני מקומות ב-proxy ל-API (פעם אחת בבקשה ופעם אחת בתגובה), היא בדרך כלל מופעלת פעמיים בקריאה ל-API. מטמון GET ומטמון PUT נספרים כל אחד כהפעלה אחת. עם זאת, הביצוע של מטמון התגובות הוא 0 אם הערך של הרכיב <SkipCacheLookup> במדיניות הוא true (בבקשה), ו-0 אם הערך של הרכיב <SkipCachePopulation> במדיניות הוא true (בתגובה). בכלי לניפוי באגים, אפשר ללחוץ על הסמל ResponseCache בקריאה ל-API שהופעלה ולראות את responsecache.executed משתנה הזרימה כדי לבדוק אם בוצעה הפעלה של מטמון (ערך של 1). תחביר API: sum(ax_cache_executed)
זמן האחזור של עיבוד התגובה	response_processing_latency	ממוצע, מינימום, מקסימום	משך הזמן (ממוצע, מינימלי או מקסימלי), במילישניות, שלוקח ל-Apigee לעבד תגובות של API. המדידה מתחילה כש-proxy ל-API מקבל את התגובה של שירות היעד ומסתיימת כש-Apigee מעביר את התגובה למתקשר המקורי. באמצעות מאפיינים שונים, אפשר לבחון את זמן האחזור של עיבוד התגובה לפי שרת proxy של API, אזור וכו'. תחביר API: min(response_processing_latency)
גודל התשובה	response_size	סכום, ממוצע, מינימום, מקסימום	גודל מטען הייעודי (payload) של התגובה שהוחזר ללקוח, בבייטים. תחביר API: max(response_size)
שגיאות שקשורות ליעד	target_error	סכום	המספר הכולל של תגובות שגיאה משירות היעד. אלה שגיאות בשירות היעד שלא נגרמו על ידי Apigee. תחביר API: sum(target_error)
זמן תגובה רצוי	target_response_time	סכום, ממוצע, מינימום, מקסימום	משך הזמן (סכום, ממוצע, מינימום או מקסימום), באלפיות השנייה, שחלף עד שהשרת של היעד הגיב לקריאה. המדד הזה מראה את הביצועים של שרתי היעד. הזמן מתחיל כש-Apigee מעביר בקשה לשירות היעד ומסתיים כש-Apigee מקבל את התגובה. שימו לב שאם קריאה ל-API מחזירה תגובה מהמטמון (לדוגמה, באמצעות המדיניות ResponseCache), הקריאה אף פעם לא תגיע לשירות היעד, ולא יירשמו מדדים של זמן התגובה של היעד. תחביר API: avg(target_response_time)
זמן התגובה הכולל	total_response_time	סכום, ממוצע, מינימום, מקסימום	משך הזמן (סכום, ממוצע, מינימום או מקסימום), במילישניות, מרגע ש-Apigee מקבל בקשה מלקוח ועד ש-Apigee שולח את התגובה בחזרה ללקוח. הזמן כולל תקורה של הרשת (כמו הזמן שלוקח למאזני עומסים ולנתבים לבצע את העבודה שלהם), חביון של עיבוד בקשות, חביון של עיבוד תגובות וזמן תגובה של היעד (אם התגובה מוגשת משירות היעד במקום מהמטמון). באמצעות מאפיינים שונים, אפשר לבחון את זמן האחזור של העיבוד לפי proxy ל-API, אפליקציה למפתחים, אזור וכו'. תחביר API: avg(total_response_time)
תעבורת נתונים	message_count	סכום	המספר הכולל של קריאות ל-API שעובדו על ידי Apigee בתקופת הזמן שצוינה. אפשר להשתמש במאפיינים כדי לקבץ את נתוני התנועה באופן שהכי משמעותי לכם. תחביר API: sum(message_count)
מונטיזציה
עמלות	fees	סכום, ממוצע, מינימום, מקסימום	סכום העמלה. תחביר API: sum(fees)
חלקם של המפתחים בהכנסות	x_apigee_mintng_dev_share	סכום, ממוצע, מינימום, מקסימום	החלק של מפתח האפליקציה או של קבוצת האפליקציות בהכנסות מעסקה. מערכת Apigee מחשבת את החלק היחסי רק אם הפעלתם את האפשרות לחלוקת הכנסות בתוכנית התמחור שלכם. הנתח מחושב לפי הנוסחה הבאה: x_apigee_mintng_dev_share = revShareGrossPrice * (share percentage) הערך של אחוז השיתוף מאוחזר מתוכנית התמחור שלכם. תחביר API: sum(x_apigee_mintng_dev_share)
מחיר המונטיזציה	x_apigee_mintng_price	סכום, ממוצע, מינימום, מקסימום	ההכנסה הכוללת מעסקה. ההכנסה מעסקה מוגדרת לערך של revShareGrossPrice משתנה המונטיזציה שתועד במדיניות DataCapture. תחביר API: sum(x_apigee_mintng_price)
מכפיל מחיר של API	x_apigee_mintng_price_multiplier	סכום, ממוצע, מינימום, מקסימום	הפקטור (המכפיל) שבו מכפילים את העלות לכל עסקה. העלות לכל עסקה מצוינת בתמחור של עמלות מבוססות-צריכה בתוכנית התמחור. תחביר API: avg(x_apigee_mintng_price_multiplier)
שיעורי מונטיזציה	x_apigee_mintng_rate	סכום, ממוצע, מינימום, מקסימום	התעריף שחויב על עסקה. התעריף שמוצג על עסקה מחושב לפי הנוסחה הבאה: x_apigee_mintng_rate = (consumption-based pricing rate) * perUnitPriceMultiplier value הערך של שיעור התמחור לפי צריכה מאוחזר מתוכנית התמחור שלכם, והערך perUnitPriceMultiplier מוכפל רק אם המשתנה נרשם על ידי מדיניות DataCapture. תחביר API: sum(x_apigee_mintng_rate)

מידות

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

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

מאפיין	השם לשימוש ב-Apigee API	תיאור
טוקן גישה	access_token	אסימון גישה ל-OAuth של משתמש הקצה באפליקציה.
מוצר API	api_product	השם של מוצר ה-API שמכיל את שרתי ה-proxy ל-API שאליהם מתבצעת הקריאה. כדי לקבל את המאפיין הזה, אפליקציות למפתחים שמבצעות את הקריאות צריכות להיות משויכות למוצר API אחד או יותר שמכיל את שרתי ה-proxy של ה-API, ושרתי ה-proxy שמתבצעת אליהם הקריאה צריכים לבדוק אם מפתח API או טוקן OAuth נשלחו עם הקריאה ל-API. המפתח או הטוקן משויכים למוצר API. מידע נוסף זמין במאמר בנושא יצירת נתוני ניתוח מלאים. אם הקריטריונים שלמעלה לא מתקיימים, יופיע הערך (not set). אפשר לקרוא גם את המאמר מה המשמעות של ערך הישות '(not set)' ב-Analytics? במסגרת מדד העמלות, זהו מוצר ה-API שמתאים לתוכנית התמחור שעליה חלה עמלת ההגדרה או עמלה חוזרת. הערך ריק עבור טעינה מראש.
שם האפליקציה בקבוצת האפליקציות	app_group_app	שם האפליקציה שמתקשרים אליה כשהיא חלק מ-AppGroup. מידע על AppGroup זמין במאמר שימוש ב-AppGroup לארגון הבעלות על אפליקציות.
שם קבוצת האפליקציות	app_group_name	שם קבוצת האפליקציות שמכילה את האפליקציות שמתבצעת אליהן קריאה, אם רלוונטי. מידע על AppGroups זמין במאמר בנושא שימוש ב-AppGroups לארגון הבעלות על אפליקציות.
מפתח מטמון	ax_cache_key	מפתח שמכיל את הערך ResponseCache שאליו הייתה גישה. מידע נוסף על אופן בניית המפתח למטמון התגובות זמין במאמר בנושא מדיניות ResponseCache. בכלי לניפוי באגים, כשבוחרים מדיניות ResponseCache שקוראת מהמטמון או כותבת למטמון, אפשר לראות את הערך הזה בresponsecache.cachekey משתנה של זרימת הנתונים.
שם המטמון	ax_cache_name	שם המטמון שמכיל את המפתחות או הערכים שמשמשים את מדיניות ResponseCache, עם הקידומת orgName__envName__. לדוגמה, אם הארגון הוא myorgf, הסביבה היא test ושם המטמון הוא myCache, אז ax_cache_name הוא foo__test__myCache. בכלי לניפוי באגים, כשבוחרים מדיניות ResponseCache, אפשר לראות את הערך הזה בresponsecache.cachename משתנה של זרימת הנתונים.
מקור המטמון	ax_cache_source	רמת המטמון (L1 בזיכרון או מסד נתונים L2) שממנה אוחזר ResponseCache. במאפיין הזה מוצג גם הערך CACHE_MISS אם התגובה נמסרה מהיעד במקום מהמטמון (והתגובה במטמון רעננה עם תגובת היעד), או אם מפתח המטמון בבקשה לא תקין. גודל מפתחות המטמון מוגבל ל-2KB. בכלי לניפוי באגים, כשבוחרים במדיניות ResponseCache, אפשר לראות את הערך הזה בresponsecache.cachesource משתנה הזרימה. מידע נוסף על רמות מטמון זמין במאמר Cache internals.
מזהה לקוח	client_id	טוקן צרכן (מפתח API) של אפליקציית המפתח שמבצעת את הקריאות ל-API, בין אם הוא מועבר בבקשה כמפתחות API או כלול באסימוני OAuth. כדי לקבל את המאפיין הזה, צריך להגדיר את השרתים הפרוקסי שמקבלים קריאות כך שיבדקו אם יש מפתח API או אסימון OAuth תקפים. אפליקציות למפתחים מקבלות מפתחות API, שאפשר להשתמש בהם כדי ליצור אסימוני OAuth, כשהאפליקציות רשומות ב-Apigee. מידע נוסף זמין במאמר בנושא יצירת נתוני ניתוח מלאים. אם הקריטריונים שלמעלה לא מתקיימים, יופיע הערך (not set). אפשר לעיין גם במאמר מה המשמעות של ערך הישות '(not set)' ב-Analytics?
אפליקציה למפתחים	developer_app	אפליקציה למפתחים שרשומה ב-Apigee ושולחת קריאות ל-API. כדי לקבל את המאפיין הזה, צריך לשייך את האפליקציות למוצר API אחד או יותר שמכיל את שרתי ה-proxy של ה-API שאליהם מתבצעת הקריאה. בנוסף, שרתי ה-proxy צריכים לבדוק אם מפתח API או טוקן OAuth נשלחים עם הקריאה ל-API. המפתח או האסימון מזהים את אפליקציית המפתח. מידע נוסף זמין במאמר איך יוצרים נתוני ניתוח מלאים? אם הקריטריונים שלמעלה לא מתקיימים, יופיע הערך (not set). אפשר לעיין גם במאמר מה המשמעות של ערך הישות '(not set)' ב-Analytics?
כתובת האימייל של המפתח	developer_email	כתובת האימייל של מפתחי האפליקציות או של קבוצות האפליקציות שרשומות ב-Apigee, שהאפליקציה שלהם שלחה את הקריאות ל-API. כדי לקבל את המאפיין הזה, מפתחי אפליקציות או קבוצות אפליקציות צריכים לשייך אפליקציות למוצרי API אחד או יותר שמכילים את שרתי ה-proxy של ה-API שאליהם מתבצעת הקריאה. שרתי ה-proxy צריכים לבדוק אם מפתח API או אסימון OAuth נשלחים עם קריאה ל-API. המפתח או האסימון מזהים את אפליקציית המפתח. מידע נוסף זמין במאמר איך יוצרים נתוני ניתוח מלאים? אם הקריטריונים שלמעלה לא מתקיימים, יופיע הערך (not set). אפשר לעיין גם במאמר מה המשמעות של ערך הישות '(not set)' ב-Analytics? במסגרת מדד העמלות, זהו מפתח האפליקציה או קבוצת האפליקציות שמחויבים בעמלת הגדרה, בעמלות חוזרות או בטעינת יתרה בתשלום מראש.
מזהה המפתח	developer	מזהה מפתח ייחודי שנוצר על ידי Apigee בפורמט org_name@@@unique_id. בקבוצות אפליקציות, הערך של unique_id הוא שם קבוצת האפליקציות. כדי לקבל את המאפיין הזה, מפתחי אפליקציות וקבוצות אפליקציות צריכים לשייך אפליקציות למוצרי API אחד או יותר שמכילים את שרתי ה-proxy של ה-API שאליהם מתבצעות הקריאות. שרתי ה-proxy צריכים לבדוק אם נשלח מפתח API או אסימון OAuth עם הקריאות ל-API. המפתח או האסימון מזהים את מפתח האפליקציה או את קבוצת האפליקציות. מידע נוסף זמין במאמר איך יוצרים נתוני ניתוח מלאים? אם הקריטריונים שלמעלה לא מתקיימים, יופיע הערך (not set). אפשר גם לעיין במאמר מה המשמעות של ערך הישות של Analytics‏ (not set)?
סביבה	environment	סביבת Apigee שבה נפרסים שרתי ה-proxy של ה-API. לדוגמה, test או prod.
קוד תקלה בשגיאה	ax_edge_execution_fault_code	קוד התקלה של השגיאה. לדוגמה: messaging.adaptors.http.flow.GatewayTimeout
שם רצף הפעולות בשגיאה	ax_execution_fault   _flow_name	תהליך בשם מסוים ב-proxy ל-API שגרם לשגיאה. לדוגמה, PreFlow,‏ PostFlow או השם של זרימת נתונים מותנית שיצרתם. שימו לב: השם המלא שצריך להשתמש בו ב-Apigee API הוא ax_execution_fault_flow_name, בלי מעבר שורה. אם לא היו שגיאות, יופיע הערך (not set).
Flow Resource	flow_resource	לשימוש ב-Apigee בלבד. אם אתם רוצים לדעת איך משתמשים במאפיין 'זרימת משאבים' ב-Analytics, אתם יכולים לעיין במאמר איך משתמשים במאפיין 'זרימת משאבים' ב-Analytics.
מצב זרימה במקרה של שגיאה	ax_execution_fault   _flow_state	שם מצבי הזרימה של proxy ל-API שגרמו לשגיאות, כמו PROXY_REQ_FLOW או TARGET_RESP_FLOW. שימו לב: השם המלא שצריך להשתמש בו ב-Apigee API הוא ax_execution_fault_flow_state, בלי מעבר שורה.
מזהה תהליך של שער	gateway_flow_id	כשקריאות ל-API עוברות דרך Apigee, כל קריאה מקבלת מזהה משלה של זרימת שער. דוגמה: rrt329ea-12575-114653952-1. מזהה זרימת השער שימושי להבחנה בין מדדים במצבים של TPS גבוה, שבהם מאפיינים אחרים כמו ארגון, סביבה וחותמת זמן זהים בכל השיחות.
ארגון	organization	ארגון Apigee שבו נפרסו שרתי ה-proxy של ה-API.
שם המדיניות שגרמה לשגיאה	ax_execution_fault   _policy_name	שם המדיניות שגרמה לשגיאה ולכישלון הקריאה ל-API. שימו לב: השם המלא שצריך להשתמש בו ב-Apigee API הוא ax_execution_fault_policy_name, בלי מעבר שורה. אם מדיניות מסוימת מחזירה שגיאה, אבל מאפיין הבסיס של המדיניות continueOnError מוגדר לערך true, התהליך של proxy ל-API ממשיך ללא כשל, והכשל של המדיניות לא נספר במאפיין הזה.
בשם אחרים	apiproxy	שם המכונה (לא השם המוצג) של proxy ל-API.
נתיב בסיס של שרת proxy	proxy_basepath	BasePath שהוגדר ב-ProxyEndpoint של ה-proxy ל-API. נתיב הבסיס לא כולל את החלק של הדומיין והיציאה בכתובת ה-URL של ה-proxy ל-API. לדוגמה, אם כתובת ה-URL הבסיסית של ה-proxy ל-API היא https://apigeedocs-test.apigee.net/releasenotes/, נתיב הבסיס הוא /releasenotes. הערך מאוחסן גם בproxy.basepath משתנה של זרימת העבודה.
סוג פריסת שרת proxy	proxy_deployment_type	סוג שרת ה-proxy ל-API עבור שרתי proxy שנפרסו. אם מציינים סוג של שרת proxy, התוצאות יוגבלו לסוג הזה של שרת proxy. הערכים האפשריים הם STANDARD,‏ EXTENSIBLE או לא מוגדר.
סיומת נתיב שרת Proxy	proxy_pathsuffix	נתיב המשאב נוסף לנתיב הבסיס של proxy ל-API. לדוגמה, אם כתובת ה-URL הבסיסית של שרת proxy של API היא https://apigeedocs-test.apigee.net/hello/, ומתבצעת קריאה ל-https://apigeedocs-test.apigee.net/hello/json, אז pathsuffix הוא /json. אם לא משתמשים ב-pathsuffix, הערך ריק. הערך מאוחסן גם בproxy.pathsuffix משתנה של זרימת העבודה.
גרסה של שרת proxy	apiproxy_revision	מספר הגרסה של ה-proxy ל-API שטיפל בקריאות ל-API. לא בהכרח מדובר בגרסה האחרונה של ה-proxy ל-API. אם ל-proxy ל-API יש 10 גרסאות, יכול להיות שהגרסה השמינית פרוסה כרגע. בנוסף, יכול להיות של-API יש כמה גרסאות פרוסות, כל עוד לגרסאות יש נתיבי בסיס שונים, כפי שמתואר במאמר בנושא פריסת proxies.
כתובת IP של לקוח שנפתרה	ax_resolved_client_ip	כתובת ה-IP של הלקוח שממנו נשלחה ההודעה. הערך הזה נגזר באמצעות ברירת המחדל של רזולוציית כתובת ה-IP של הלקוח (שמשתמשת רק בכותרת X-Forwarded-For) או באמצעות האלגוריתם שהוגדר ברזולוציית כתובת ה-IP של הלקוח שהוגדרה (שיכולה לפתור את כתובת ה-IP מכל כותרת). שימו לב: כשמשתמשים במוצרי ניתוב כמו Akamai כדי לתעד את כתובות ה-IP האמיתיות של לקוחות, כתובת ה-IP של הלקוח מועברת אל Apigee בכותרת ה-HTTP ‏True-Client-IP, שמשמשת להגדרת מאפיין ax_true_client_ip. בהתנהגות ברירת המחדל, הערך של המאפיין ax_resolved_client_ip מחושב מהערכים במאפיין x_forwarded_for_ip באופן הבא: מגדירים את ax_resolved_client_ip לכתובת ה-IP הראשונה שאינה מקומית ב-x_forwarded_for_ip. אם x_forwarded_for_ip מכיל רק כתובות IP מקומיות, צריך להגדיר את ax_resolved_client_ip לכתובת ה-IP המקומית האחרונה ב-x_forwarded_for_ip. אם x_forwarded_for_ip הוא null, מגדירים את ax_resolved_client_ip לערך (not set).
קוד סטטוס התגובה	response_status_code	קוד סטטוס של תגובת HTTP שמועבר מ-Apigee ללקוח, כמו 200,‏ 404,‏ 503 וכן הלאה. ב-Apigee, אפשר להחליף את קוד הסטטוס של התגובה מהיעד באמצעות כללי מדיניות כמו AssignMessage policy ו-RaiseFault policy. לכן, יכול להיות שהמאפיין הזה יהיה שונה מהמאפיין Target Response Code (target_response_code).
מארח וירטואלי	virtual_host	השם של המארח הווירטואלי שאליו בוצעה קריאה ל-API. מידע נוסף זמין במאמר מידע על סביבות וקבוצות סביבות.
Inbound/Client
כתובת ה-IP של הלקוח	client_ip	כתובת ה-IP של המערכת שפוגעת בנתב, כמו הלקוח המקורי (proxy_client_ip) או מאזן עומסים. אם יש כמה כתובות IP בכותרת X-Forwarded-For, זו כתובת ה-IP האחרונה שמופיעה.
קטגוריית מכשיר	ax_ua_device_category	סוג המכשיר שממנו בוצעה הקריאה ל-API, למשל Tablet או Smartphone.
משפחת מערכות ההפעלה	ax_ua_os_family	שם המשפחה של מערכת ההפעלה של המכשיר שמבצע את השיחה, כמו Android או iOS.
גרסת OS	ax_ua_os_version	גרסת מערכת ההפעלה של המכשיר שממנו מתבצעת השיחה. מומלץ להשתמש במאפיין הזה כמאפיין שני לניתוח מעמיק עם המאפיין 'שם המשפחה של מערכת ההפעלה' (ax_ua_os_family) כדי לראות את הגרסאות של מערכות ההפעלה.
כתובת ה-IP של לקוח ה-Proxy	proxy_client_ip	כתובת ה-IP של הלקוח שמתקשר, שמאוחסנת בproxy.client.ip משתנה הזרימה. בדרך כלל זו כתובת X-Forwarded-For של השיחה הנכנסת, שהיא כתובת ה-IP ש-Apigee קיבלה מהלחיצת יד האחרונה של TCP חיצוני. יכול להיות שמדובר בלקוח שמתקשר או במאזן עומסים. אם יש כמה כתובות IP בכותרת X-Forwarded-For, זו כתובת ה-IP האחרונה שמופיעה.
כתובת ה-IP של הלקוח שהופנה	ax_true_client_ip	כשמשתמשים במוצרי ניתוב כמו Akamai כדי לתעד את כתובות ה-IP האמיתיות של לקוחות, כתובות ה-IP של הלקוחות מועברות אל Apigee בכותרת ה-HTTP‏ True-Client-IP. המאפיין הזה מתעד את כתובות ה-IP האמיתיות של הלקוחות מהכותרת הזו.
נתיב הבקשה	request_path	נתיב המשאב (לא כולל הדומיין) לשירות היעד, לא כולל פרמטרים של שאילתות. לדוגמה, יעד הדוגמה של Apigee‏ http://mocktarget.apigee.net כולל כמה משאבים, כולל /user, שמחזיר ברכה. לא משנה איך ה-proxy ל-API קורא ל-http://mocktarget.apigee.net/user, ה-request_path הוא /user.
URI של בקשה	request_uri	נתיב המשאב (לא כולל הדומיין) לשירות היעד, כולל פרמטרים של שאילתות. לדוגמה, יעד לדוגמה של Apigee‏ http://mocktarget.apigee.net כולל כמה משאבים, כולל משאב /user?user={name} ופרמטר שאילתה להחזרת ברכה מותאמת לשם שסופק. לא משנה איך קריאות ה-API שלכם ל-http://mocktarget.apigee.net/user?user=Dude מתבצעות, request_uri הוא /user?user=Dude.
פועל הבקשה	request_verb	פועל של בקשת HTTP בבקשות ה-API, כמו GET, ‏ POST, ‏ PUT, ‏ DELETE.
סוכן משתמש	useragent	השם של סוכן המשתמש או סוכן התוכנה שדרכו מתבצעת הקריאה ל-API. דוגמאות: מכשיר Pixel XL מבצע שיחה דרך Chrome: Mozilla/5.0 (Linux; Android 7.1.2; Pixel XL Build/NHG47N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.92 Mobile Safari/537.36 שיחה באייפד דרך Chrome: Mozilla/5.0 (iPad; CPU OS 10_2 like Mac OS X) AppleWebKit/602.1.50 (KHTML, like Gecko) CriOS/54.0.2840.91 Mobile/14C92 Safari/602.1 ‫cURL מטרמינל: curl/7.51.0
משפחה של סוכן משתמש	ax_ua_agent_family	המשפחה של ה-useragent, כמו Chrome Mobile או curl.
סוג סוכן המשתמש	ax_ua_agent_type	סוג סוכן המשתמש, כמו Browser, ‏Mobile Browser, ‏Library וכן הלאה.
גרסת סוכן המשתמש	ax_ua_agent_version	גרסת הסוכן המשתמש. מומלץ להשתמש במאפיין הזה כמאפיין שני לניתוח מעמיק עם מאפיין משפחת סוכן המשתמש (ax_ua_agent_family) כדי לקבל את הגרסה של משפחת הסוכן.
יוצא/יעד
יעד	target	נקודת הקצה (endpoint) שאליה מטרגטים את הבקשה. לדוגמה, default.
נתיב בסיס ליעד	target_basepath	נתיב המשאב (לא כולל הדומיין) לשירות היעד, לא כולל פרמטרים של שאילתות, שמוגדר ב-<TargetEndpoint> של ה-proxy. לדוגמה, נניח ש-proxy ל-API קורא ליעד הבא: <TargetEndpoint name="default"> ... <HTTPTargetConnection> <URL>http://mocktarget.apigee.net/user?user=Dude</URL> </HTTPTargetConnection> בדוגמה הזו, target_basepath הוא /user. אם היעד היה: <TargetEndpoint name="default"> ... <HTTPTargetConnection> <URL>http://mocktarget.apigee.net</URL> </HTTPTargetConnection> הערך של target_basepath יהיה null. בכלי לניפוי באגים, כשבוחרים בסמל AX בסוף תרשים הזרימה, target.basepath משתנה הזרימה ממופה למאפיין target_basepath.
שם שירות gRPC	x_apigee_grpc_service_name	המאפיין הזה רלוונטי רק אם שירות היעד הוא gRPC. שם שירות gRPC. למידע על שרתי proxy של gRPC API, אפשר לעיין במאמר בנושא יצירת שרתי proxy של gRPC API.
סטטוס gRPC	x_apigee_grpc_status	המאפיין הזה רלוונטי רק אם שירות היעד הוא gRPC. סטטוס הבקשה ב-gRPC. מידע על שרתי proxy של gRPC זמין במאמר יצירת שרתי proxy של gRPC API.
מארח היעד	target_host	המארח של שירות היעד. לדוגמה, אם proxy ל-API קורא ל-http://mocktarget.apigee.net/help, המארח היעד הוא mocktarget.apigee.net.
כתובת ה-IP של היעד	target_ip	כתובת ה-IP של שירות היעד שמחזיר את התגובה ל-proxy ל-API.
קוד תגובה של היעד	target_response_code	קוד סטטוס של תגובת HTTP שמוחזר משירות היעד ל-proxy ל-API, כמו 200,‏ 404,‏ 503 וכן הלאה. הערך null מציין שהבקשה לא הגיעה לשירות היעד. השגיאה הזו מתרחשת כשהתשובה מוגשת על ידי מדיניות ResponseCache או כשיש כשל בעיבוד הבקשה. המאפיין הזה שונה מהמאפיין קוד הסטטוס של התגובה (response_status_code).
שם ה-RPC של gRPC	x_apigee_grpc_rpc_name	המאפיין הזה רלוונטי רק אם שירות היעד הוא gRPC. שם ה-RPC. למידע על שרתי proxy של gRPC, אפשר לעיין במאמר בנושא יצירת שרתי proxy של gRPC API.
כתובת URL של יעד	target_url	כתובת ה-URL המלאה של שירות היעד שמוגדר ב-TargetEndpoint של פרוקסי API. <TargetEndpoint name="default"> ... <HTTPTargetConnection> <URL>http://mocktarget.apigee.net/user?user=Dude</URL> </HTTPTargetConnection> בדוגמה הזו, target_url הוא http://mocktarget.apigee.net/user?user=Dude. שימו לב שאפשר גם לבטל את כתובת ה-URL במהלך העיבוד של ה-proxy ל-API באמצעות target.url משתנה של flow. בשרשור של שרתי proxy, הערך של target_url ב-proxy ששולח את הקריאה הוא null.
כתובת ה-IP של X-Forwarded-For	x_forwarded_for_ip	רשימת כתובות ה-IP בכותרת X-Forwarded-For. כדי לקבוע את כתובת ה-IP המקורית של הלקוח, שאליה ניגשים דרך המאפיין ax_resolved_client_ip, מערכת Apigee משתמשת בערכים במאפיין x_forwarded_for_ip.
X-Forwarded-For Proto	x_forwarded_proto	הפרוטוקול שבו הלקוח השתמש כדי להתחבר לנתב. הערכים התקינים כוללים http או https.
שעה
יום בשבוע	ax_day_of_week	קיצור של יום בשבוע בן שלוש אותיות שבו בוצעו הקריאות ל-API. לדוגמה, Mon, ‏ Tue, ‏ Wed.
חודש	ax_month_of_year	החודש המספרי שבו בוצעו הקריאות ל-API. לדוגמה, 03 למרץ.
השעה ביום	ax_hour_of_day	השעה שבה בוצעו קריאות ל-API, בפורמט של 2 ספרות, לפי שעון של 24 שעות. לדוגמה, אם בוצעו קריאות ל-API בשעה שבין 22:00 ל-23:00, הערך של ax_hour_of_day יהיה 22. ערך הזמן הוא לפי שעון UTC.
אזור זמן	ax_geo_timezone	שמות נפוצים של אזורי הזמן שמהם בוצעו הקריאות ל-API, כמו America/New_York ו-Europe/Dublin.
השבוע בחודש	ax_week_of_month	מספר שבוע בחודש. לדוגמה, אם קריאות ה-API בוצעו בשבוע השלישי של החודש, הערך של ax_week_of_month הוא 3.
Location
עיר	ax_geo_city	העיר שממנה בוצעו הקריאות ל-API.
יבשת	ax_geo_continent	קוד בן שתי אותיות של היבשת שממנה בוצעו הקריאות ל-API. לדוגמה, NA לאמריקה הצפונית.
מדינה	ax_geo_country	קוד בן שתי אותיות של המדינה שממנה בוצעו הקריאות ל-API. לדוגמה, US לציון ארצות הברית.
אזור גיאוגרפי	ax_geo_region	קוד עם מקף לאזור הגיאוגרפי, כמו STATE-COUNTRY. לדוגמה, ‫WA-US לוושינגטון, ארצות הברית.
אזור	ax_dn_region	השם של מרכז הנתונים של Apigee שבו נפרסים שרתי proxy ל-API, כמו us-east-1.
מונטיזציה
שם קבוצת האפליקציות	app_group_name	שם קבוצת האפליקציות שאליה חלים העמלות, אם רלוונטי. למפתחי אפליקציות, השדה הזה ריק. בהקשר של מדד העמלות, זהו AppGroup שמתאים למוצר ה-API ולתוכנית התמחור שעליהם חלה העמלה.
סוג העמלה	fees_type	סוג העמלה: עמלת הקמה, עמלה חוזרת, טעינה מראש או החזר כספי. הערך הזה מאוכלס רק אם בחרתם במדד Fees.
מועד יצירת העמלה	created	חותמת זמן בפורמט Unix שבה נוסף לוח התעריפים למפתח האפליקציה ולמוצר ה-API. הערך הזה מאוכלס רק אם בחרתם במדד Fees.
מטבע ההכנסות	x_apigee_mintng_currency	המטבע של ההכנסה מהעסקה מוגדר לערך של משתנה המונטיזציה currency שנרשם במדיניות DataCapture. המטבע הזה משויך למטבע של revShareGrossPrice. במסגרת מדד העמלות, זהו המטבע של העמלה.
מזהה תוכנית תמחור	x_apigee_mintng_rate_plan_id	תוכנית שיעור המונטיזציה של מפַתח האפליקציות או של קבוצת האפליקציות.
העסקה בוצעה בהצלחה	x_apigee_mintng_tx_success	סטטוס המונטיזציה של העסקה מוגדר לערך של משתנה המונטיזציה transactionSuccess שתועד במדיניות DataCapture.
תחילת התקופה	period_start	תחילת התקופה שעליה נגבות עמלות חוזרות. לדוגמה, אם יש לכם תשלום חודשי, זה היום הראשון של החודש. הערך הזה מאוכלס רק אם בחרתם במדד Fees.
סוף התקופה	period_end	סוף התקופה שעליה נגבות עמלות חוזרות. לדוגמה, אם מדובר בתשלום חודשי, זהו היום האחרון של החודש. הערך הזה מאוכלס רק אם בחרתם במדד Fees.

מסננים

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

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

מחזירה מדדים של שרתי proxy ל-API עם השם books או music:

filter=(apiproxy in 'books','music')

הפונקציה מחזירה מדדים לשרתי proxy ל-API עם שמות שמתחילים ב-m:

filter=(apiproxy like 'm%')

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

filter=(apiproxy not like 'm%')

הפונקציה מחזירה מדדים של קריאות ל-API עם קודי סטטוס של תגובה בין 400 ל-599:

filter=(response_status_code ge 400 and response_status_code le 599)

הפונקציה מחזירה מדדים של קריאות ל-API עם קוד סטטוס תגובה של 200 וקוד תגובה של יעד 404:

filter=(response_status_code eq 200 and target_response_code eq 404)

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

filter=(response_status_code eq 500)

הפונקציה מחזירה מדדים של קריאות ל-API שלא גרמו לשגיאות:

filter=(is_error eq 0)

המדדים שמוחזרים הם של קריאות ל-API שלא הניבו תגובות מסוג null:

filter=(response_status_code isnot null)

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

אופרטור	תיאור
in	הכללה ברשימה
notin	החרגה מהרשימה
is	משתמשים ב-response_status_code is null כדי לסנן תשובות שקוד הסטטוס שלהן הוא null.
isnot	משתמשים ב-response_status_code isnot null כדי לסנן תשובות שקוד הסטטוס שלהן לא null.
eq	שווה ל-==
ne	לא שווה לערך, !=
gt	גדול מ->
lt	פחות מ-<
ge	גדול מ->= או שווה לו
le	קטן מהערך <= או שווה לו
like	הפונקציה מחזירה את הערך True אם מחרוזת התבנית תואמת לתבנית שצוינה.
not like	הפונקציה מחזירה false אם דפוס המחרוזת תואם לדפוס שצוין.
similar to	הפונקציה מחזירה את הערך true או false בהתאם לכך שהתבנית שלה תואמת למחרוזת הנתונה. היא דומה ל-like, אבל היא מפרשת את התבנית באמצעות ההגדרה של ביטוי רגולרי בתקן SQL.
not similar to	הפונקציה מחזירה את הערך false או true בהתאם להתאמה של התבנית למחרוזת שצוינה. היא דומה ל-not like, אבל היא מפרשת את התבנית באמצעות ההגדרה של ביטוי רגולרי בתקן SQL.
and	מאפשר להשתמש בלוגיקת AND כדי לכלול יותר מביטוי סינון אחד. המסנן כולל נתונים שעומדים בכל התנאים.
or	מאפשר להשתמש בלוגיקת OR כדי להעריך ביטויי סינון שונים. המסנן כולל נתונים שעומדים לפחות באחד מהתנאים.