ניהול התוסף Apigee API Analytics

הדף הזה מתייחס ל-Apigee, אבל לא ל-Apigee Hybrid.

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

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

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

זמינות

הכלי Apigee API Analytics זמין כתוסף בתשלום שמנוהל לכל סביבת Apigee בהטמעה של Apigee. אפשר להפעיל את התוסף בכל סביבת Intermediate או Comprehensive של Apigee. אי אפשר להפעיל את Apigee API Analytics ולהשתמש בו בסביבות Base. לפרטים נוספים על היכולות של סביבות Apigee, אפשר לעיין במאמר השוואה בין סוגי סביבות.

תפקידים והרשאות נדרשים

כדי לקבל את ההרשאות שנדרשות לניהול התוסף Apigee API Analytics, צריך לבקש מהאדמין להקצות לכם ב-IAM את התפקיד אדמין סביבת Apigee ‏ (apigee.environment.admin) בפרויקט. להסבר על מתן תפקידים, קראו איך מנהלים את הגישה ברמת הפרויקט, התיקייה והארגון.

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

ההרשאות הנדרשות

כדי לנהל את התוסף Apigee API Analytics, נדרשות ההרשאות הבאות:

  • apigee.addonsconfig.get
  • apigee.addonsconfig.update

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

הפעלת התוסף Apigee API Analytics

אפשר להפעיל את התוסף Apigee API Analytics בסביבת Intermediate או Comprehensive של Apigee באמצעות ממשק המשתמש של Apigee במסוף Google Cloud או באמצעות ה-API, כמו שמתואר בקטעים הבאים.

‫Apigee במסוף Google Cloud

כדי להפעיל את התוסף Apigee API Analytics במסוף Google Cloud :

  1. פותחים את הדף Apigee במסוף.

    מעבר אל Apigee

  2. בוחרים את הפרויקט עם הארגון והסביבות בתשלום לפי שימוש שרוצים לנהל.
  3. בוחרים באפשרות תוספים > Analytics כדי לפתוח את הדף Analytics add-on (התוסף של Analytics).
  4. בחלונית Manage Apigee API Analytics add-on (ניהול התוסף Apigee API Analytics), מסמנים את התיבה לצד הסביבה (או הסביבות) שבהן רוצים להפעיל את התוסף.
  5. לוחצים על הפעלת הנבחרים.
  6. כשההפעלה של הסביבות שנבחרו תושלם, הסטטוס של הסביבה יהיה מופעל.
  7. כדי לראות את נתוני הניתוח של Apigee API, בוחרים באפשרות Analytics > API Metrics. יכול להיות שיחלפו 10 דקות עד שנתוני הניתוח יוצגו.

Apigee API

כדי להפעיל את התוסף Apigee API Analytics באמצעות Apigee API, מזינים את הפקודה הבאה: 

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"analyticsEnabled":true}'

כאשר:

  • ‫ORG_NAME הוא השם של הארגון ב-Apigee עם תשלום לפי שימוש שבו רוצים להוסיף את Analytics לסביבות שעומדות בדרישות.
  • ‫ENV_NAME הוא השם של סביבת Apigee שבה רוצים להפעיל את התוסף Apigee API Analytics.

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

תהליך ההפעלה של התוסף Apigee API Analytics יכול להימשך עד 15 דקות. אחרי שמפעילים את האפשרות הזו, נתוני הניתוח של הסביבה נשמרים למשך 14 חודשים. אפשר לגשת לנתונים ההיסטוריים של הסביבה מהדף API Metrics במסוף, כל עוד התוסף מופעל.

החיוב על השימוש בתוסף Apigee API Analytics מתחיל ברגע שהתוסף מופעל.

השבתת התוסף Apigee API Analytics

אפשר להשבית את התוסף Apigee API Analytics בסביבת Apigee Intermediate או Comprehensive באמצעות ממשק המשתמש של Apigee ב Google Cloud מסוף או באמצעות ה-API, כמו שמתואר בקטעים הבאים.

אם התוסף Advanced API Security מופעל בסביבה, צריך להשבית אותו לפני שמשביתים את התוסף Apigee API Analytics. אם התוסף Advanced API Security לא מושבת, כל בקשה להשבתת Apigee API Analytics בסביבה תיכשל. אם התוסף Advanced API Security מופעל בסביבה שלכם, הוא יוצג בעמודה Other enabled add-ons (תוספים מופעלים אחרים) בחלונית Manage Apigee API Analytics add-on (ניהול התוסף Apigee API Analytics).

הוראות להשבתת התוסף מופיעות במאמר השבתת התוסף Advanced API Security.

‫Apigee במסוף Cloud

כדי להשבית את התוסף Apigee API Analytics במסוף Google Cloud :

  1. פותחים את הדף Apigee במסוף.

    מעבר אל Apigee

  2. בוחרים את הפרויקט עם הארגון והסביבות בתשלום לפי שימוש שרוצים לנהל.
  3. בוחרים באפשרות תוספים > Analytics כדי לפתוח את הדף Analytics add-on (התוסף של Analytics).
  4. בחלונית Manage Apigee API Analytics add-on (ניהול התוסף Apigee API Analytics), מסמנים את התיבה לצד הסביבה (או הסביבות) שבהן רוצים להשבית את התוסף.
  5. לוחצים על השבתה של הפריטים שנבחרו.
  6. בסיום ההשבתה, בעמודה סטטוס יוצג מושבת לכל סביבה.

Apigee API

כדי להשבית את התוסף Apigee API Analytics באמצעות Apigee API, מזינים את הפקודה הבאה: 

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"analyticsEnabled":false}'

כאשר:

  • ‫ORG_NAME הוא השם של הארגון ב-Apigee עם תשלום לפי שימוש שבו רוצים להוסיף את Analytics לסביבות שעומדות בדרישות.
  • ‫ENV_NAME הוא השם של סביבת Apigee שבה רוצים להפעיל את התוסף Apigee API Analytics.

הצגת הסטטוס של התוסף Apigee API Analytics בסביבה

אפשר לבדוק את הסטטוס של התוסף Apigee API Analytics בסביבת Apigee Intermediate או Comprehensive באמצעות ממשק המשתמש של Apigee במסוף Google Cloud או באמצעות ה-API, כמו שמתואר בקטעים הבאים.

‫Apigee במסוף Google Cloud

כדי לראות את הסטטוס של התוסף Apigee API Analytics בסביבה באמצעות מסוף Google Cloud :

  1. פותחים את הדף Apigee במסוף.

    מעבר אל Apigee

  2. בוחרים את הפרויקט עם הארגון והסביבות בתשלום לפי שימוש שרוצים לנהל.
  3. בוחרים באפשרות תוספים > Analytics כדי לפתוח את הדף Analytics add-on (התוסף של Analytics).
  4. בחלונית Manage Apigee API Analytics add-on (ניהול התוסף Apigee API Analytics), מוצגת רשימה של סביבות.
  5. בעמודת הסטטוס אפשר לראות אם התוסף מופעל או מושבת בכל סביבה של Intermediate או Comprehensive. בסביבות בסיסיות לא מוצג אף אחד מהסטטוסים.

Apigee API

כדי לראות את הסטטוס של התוסף Apigee API Analytics בסביבה באמצעות Apigee API, מזינים את הפקודה הבאה: 

curl -X GET \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json"

כאשר:

  • ‫ORG_NAME הוא השם של הארגון ב-Apigee עם תשלום לפי שימוש.
  • ‫ENV_NAME הוא השם של סביבת Apigee.

התגובה מחזירה אובייקט analyticsConfig שמייצג את הסטטוס הנוכחי של התוסף.

ניהול הנתונים של Apigee API Analytics

אחרי שמפעילים את התוסף Apigee API Analytics בסביבה מסוימת, נתוני הניתוח של הסביבה נשמרים למשך 14 חודשים. אפשר לגשת לנתוני ניתוח היסטוריים של הסביבה מהדף מדדי API במסוף, כל עוד התוסף מופעל.

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

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