Apigee Api Management audit logging

This document describes audit logging for Apigee Api Management. Google Cloud services generate audit logs that record administrative and access activities within your Google Cloud resources. For more information about Cloud Audit Logs, see the following:

Service name

Apigee Api Management audit logs use the service name apim.googleapis.com. Filter for this service: 

    protoPayload.serviceName="apim.googleapis.com"

Methods by permission type

Each IAM permission has a type property, whose value is an enum that can be one of four values: ADMIN_READ, ADMIN_WRITE, DATA_READ, or DATA_WRITE. When you call a method, Apigee Api Management generates an audit log whose category is dependent on the type property of the permission required to perform the method. Methods that require an IAM permission with the type property value of DATA_READ, DATA_WRITE, or ADMIN_READ generate Data Access audit logs. Methods that require an IAM permission with the type property value of ADMIN_WRITE generate Admin Activity audit logs.

Permission type Methods
ADMIN_READ google.cloud.apim.v1alpha.ApiDiscoveryObservation.GetObservationJob
google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListApiObservationTags
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
google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationSource
google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationJob
google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationSource
google.cloud.apim.v1alpha.ApiDiscoveryObservation.DisableObservationJob
google.cloud.apim.v1alpha.ApiDiscoveryObservation.EnableObservationJob
DATA_READ google.cloud.apim.v1alpha.ApiDiscoveryObservation.GetApiObservation
google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListApiObservations
google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListApiOperations

API interface audit logs

For information about how and which permissions are evaluated for each method, see the Identity and Access Management documentation for Apigee Api Management.

google.cloud.apim.v1alpha.ApiDiscoveryObservation

The following audit logs are associated with methods belonging to google.cloud.apim.v1alpha.ApiDiscoveryObservation.

BatchEditTagsApiObservations

  • Method: google.cloud.apim.v1alpha.ApiDiscoveryObservation.BatchEditTagsApiObservations
  • Audit log type: Admin activity
  • Permissions:
    • apim.apiObservations.batchEditTags - ADMIN_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.BatchEditTagsApiObservations"

CreateObservationJob

  • Method: google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationJob
  • Audit log type: Admin activity
  • Permissions:
    • apim.observationJobs.create - ADMIN_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationJob"

CreateObservationSource

  • Method: google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationSource
  • Audit log type: Admin activity
  • Permissions:
    • apim.observationSources.create - ADMIN_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.CreateObservationSource"

DeleteObservationJob

  • Method: google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationJob
  • Audit log type: Admin activity
  • Permissions:
    • apim.observationJobs.delete - ADMIN_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationJob"

DeleteObservationSource

  • Method: google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationSource
  • Audit log type: Admin activity
  • Permissions:
    • apim.observationSources.delete - ADMIN_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.DeleteObservationSource"

DisableObservationJob

  • Method: google.cloud.apim.v1alpha.ApiDiscoveryObservation.DisableObservationJob
  • Audit log type: Admin activity
  • Permissions:
    • apim.observationJobs.disable - ADMIN_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.DisableObservationJob"

EnableObservationJob

  • Method: google.cloud.apim.v1alpha.ApiDiscoveryObservation.EnableObservationJob
  • Audit log type: Admin activity
  • Permissions:
    • apim.observationJobs.enable - ADMIN_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.EnableObservationJob"

GetApiObservation

  • Method: google.cloud.apim.v1alpha.ApiDiscoveryObservation.GetApiObservation
  • Audit log type: Data access
  • Permissions:
    • apim.apiObservations.get - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.GetApiObservation"

GetObservationJob

  • Method: google.cloud.apim.v1alpha.ApiDiscoveryObservation.GetObservationJob
  • Audit log type: Data access
  • Permissions:
    • apim.observationJobs.get - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.GetObservationJob"

ListApiObservationTags

  • Method: google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListApiObservationTags
  • Audit log type: Data access
  • Permissions:
    • apim.locations.listApiObservationTags - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListApiObservationTags"

ListApiObservations

  • Method: google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListApiObservations
  • Audit log type: Data access
  • Permissions:
    • apim.apiObservations.list - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListApiObservations"

ListApiOperations

  • Method: google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListApiOperations
  • Audit log type: Data access
  • Permissions:
    • apim.apiOperations.list - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListApiOperations"

ListObservationJobs

  • Method: google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationJobs
  • Audit log type: Data access
  • Permissions:
    • apim.observationJobs.list - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationJobs"

ListObservationSources

  • Method: google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationSources
  • Audit log type: Data access
  • Permissions:
    • apim.observationSources.list - ADMIN_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.apim.v1alpha.ApiDiscoveryObservation.ListObservationSources"

Methods that don't produce audit logs

A method might not produce audit logs for one or more of the following reasons:

  • It is a high volume method involving signifcant log generation and storage costs.
  • It has low auditing value.
  • Another audit or platform log already provides method coverage.

The following methods don't produce audit logs:

  • 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