יומני ביקורת של ניהול API ב-Apigee

במאמר הזה מוסבר על רישום ביומני ביקורת בניהול API ב-Apigee.שירותי Google Cloud יוצרים יומני ביקורת שבהם מתועדים אירועי גישה למשאבי Google Cloud ופעילויות אדמין שנעשות בהם. אתם יכולים לקרוא מידע נוסף על יומני הביקורת של Cloud במאמרים האלה:

• הסוגים של יומני הביקורת
• המבנה של רשומות ביומני הביקורת
• שמירה וניתוב של יומני ביקורת
• מחירון מקוצר של Cloud Logging
• הפעלת יומני ביקורת של גישה לנתונים

שם השירות

יומני הביקורת של ניהול API ב-Apigee משתמשים בשם השירות apim.googleapis.com. אתם יכולים לסנן לפי השירות הזה:

    protoPayload.serviceName="apim.googleapis.com"
  

‫Methods לפי סוג ההרשאה

לכל הרשאה ב-IAM יש מאפיין type עם enum שיכול להיות אחד מארבעת הערכים הבאים: ADMIN_READ,‏ ADMIN_WRITE,‏ DATA_READ או DATA_WRITE. כשקוראים ל-method, במסגרת ניהול API ב-Apigee נוצר יומן ביקורת שהקטגוריה שלו תלויה במאפיין type של ההרשאה שנדרשת לביצוע ה-method. ה-methods שבשבילן צריך הרשאה ב-IAM עם הערכים DATA_READ‏, DATA_WRITE או ADMIN_READ במאפיין type יוצרות יומני ביקורת של Data Access. ה-methods שבשבילן צריך הרשאה ב-IAM עם הערכים ADMIN_WRITE במאפיין type יוצרות יומני ביקורת של Admin Activity.

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

סוג ההרשאה	Methods
ADMIN_READ	google.cloud.apim.v1alpha.ApiDiscoveryObservation.GetObservationSource google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationJobs google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationSources
ADMIN_WRITE	google.cloud.apim.v1alpha.ApiDiscoveryObservation.BatchEditTagsApiObservations google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationJob (LRO) google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationSource (LRO) google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationJob (LRO) google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationSource (LRO) google.cloud.apim.v1alpha.ApiDiscoveryObservation.DisableObservationJob (LRO) google.cloud.apim.v1alpha.ApiDiscoveryObservation.EnableObservationJob (LRO)

יומני ביקורת של ממשק ה-API

במאמרי העזרה בנושא ניהול זהויות והרשאות גישה (IAM) לניהול API ב-Apigee מוסבר איך מתבצעת הבדיקה של ההרשאות לכל method ואילו הרשאות נבדקות.

google.cloud.apim.v1alpha.ApiDiscoveryObservation

יומני הביקורת הבאים משויכים ל-methods ששייכות ל-google.cloud.apim.v1alpha.ApiDiscoveryObservation.

BatchEditTagsApiObservations

• Method:‏ google.cloud.apim.v1alpha.ApiDiscoveryObservation.BatchEditTagsApiObservations
  
• סוג יומן הביקורת: פעילות אדמין
  
• הרשאות:
  • apim.apiObservations.batchEditTags - ADMIN_WRITE
• ה-method היא פעולה ממושכת או פעולת סטרימינג: לא.
  
• סינון לפי ה-method: ‏ protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.BatchEditTagsApiObservations"
  

CreateObservationJob

• Method:‏ google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationJob
  
• סוג יומן הביקורת: פעילות אדמין
  
• הרשאות:
  • apim.observationJobs.create - ADMIN_WRITE
• ה-method היא פעולה ממושכת או פעולת סטרימינג: פעולה ממושכת
  
• סינון לפי ה-method: ‏ protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationJob"
  

CreateObservationSource

• Method:‏ google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationSource
  
• סוג יומן הביקורת: פעילות אדמין
  
• הרשאות:
  • apim.observationSources.create - ADMIN_WRITE
• ה-method היא פעולה ממושכת או פעולת סטרימינג: פעולה ממושכת
  
• סינון לפי ה-method: ‏ protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationSource"
  

DeleteObservationJob

• Method:‏ google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationJob
  
• סוג יומן הביקורת: פעילות אדמין
  
• הרשאות:
  • apim.observationJobs.delete - ADMIN_WRITE
• ה-method היא פעולה ממושכת או פעולת סטרימינג: פעולה ממושכת
  
• סינון לפי ה-method: ‏ protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationJob"
  

DeleteObservationSource

• Method:‏ google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationSource
  
• סוג יומן הביקורת: פעילות אדמין
  
• הרשאות:
  • apim.observationSources.delete - ADMIN_WRITE
• ה-method היא פעולה ממושכת או פעולת סטרימינג: פעולה ממושכת
  
• סינון לפי ה-method: ‏ protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationSource"
  

DisableObservationJob

• Method:‏ google.cloud.apim.v1alpha.ApiDiscoveryObservation.DisableObservationJob
  
• סוג יומן הביקורת: פעילות אדמין
  
• הרשאות:
  • apim.observationJobs.disable - ADMIN_WRITE
• ה-method היא פעולה ממושכת או פעולת סטרימינג: פעולה ממושכת
  
• סינון לפי ה-method: ‏ protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.DisableObservationJob"
  

EnableObservationJob

• Method:‏ google.cloud.apim.v1alpha.ApiDiscoveryObservation.EnableObservationJob
  
• סוג יומן הביקורת: פעילות אדמין
  
• הרשאות:
  • apim.observationJobs.enable - ADMIN_WRITE
• ה-method היא פעולה ממושכת או פעולת סטרימינג: פעולה ממושכת
  
• סינון לפי ה-method: ‏ protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.EnableObservationJob"
  

GetObservationSource

• Method:‏ google.cloud.apim.v1alpha.ApiDiscoveryObservation.GetObservationSource
  
• סוג יומן הביקורת: גישה לנתונים
  
• הרשאות:
  • apim.observationSources.get - ADMIN_READ
• ה-method היא פעולה ממושכת או פעולת סטרימינג: לא.
  
• סינון לפי ה-method: ‏ protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.GetObservationSource"
  

ListObservationJobs

• Method:‏ google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationJobs
  
• סוג יומן הביקורת: גישה לנתונים
  
• הרשאות:
  • apim.observationJobs.list - ADMIN_READ
• ה-method היא פעולה ממושכת או פעולת סטרימינג: לא.
  
• סינון לפי ה-method: ‏ protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationJobs"
  

ListObservationSources

• Method:‏ google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationSources
  
• סוג יומן הביקורת: גישה לנתונים
  
• הרשאות:
  • apim.observationSources.list - ADMIN_READ
• ה-method היא פעולה ממושכת או פעולת סטרימינג: לא.
  
• סינון לפי ה-method: ‏ protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationSources"
  

אילו methods לא יוצרות יומני ביקורת

יכולות להיות כמה סיבות שב-method מסוימת לא נוצרים יומני ביקורת:

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

ה-methods הבאות לא יוצרות יומני ביקורת:

• google.cloud.location.Locations.GetLocation
• google.cloud.location.Locations.ListLocations
• google.longrunning.Operations.CancelOperation
• google.longrunning.Operations.DeleteOperation
• google.longrunning.Operations.GetOperation
• google.longrunning.Operations.ListOperations
• google.longrunning.Operations.WaitOperation