Firestore 审核日志信息

Firestore 审核日志信息

本文档介绍了 Firestore 的审核日志记录。 Google Cloud 服务会生成审核日志，以记录 Google Cloud 资源中的管理和访问活动。如需详细了解 Cloud Audit Logs，请参阅以下内容：

• 审核日志类型
• 审核日志条目结构
• 存储和路由审核日志
• Cloud Logging 价格摘要
• 启用数据访问审核日志

备注

在配置审核日志记录时，使用服务名称 datastore.googleapis.com 来同时配置 datastore.googleapis.com 和 firestore.googleapis.com。配置完成后，Firestore API 的日志将包含服务名称 firestore.googleapis.com。

如需查看处理 DATA_READ 或 DATA_WRITE 请求所用的时间，请参阅 AuditLog 的 metadata 对象中的 processing_duration 字段。 processing_duration 描述了数据库实际处理请求所用的时间。这比最终用户延迟时间更短。具体来说，它不包括网络开销。

对于 Listen 请求，processing_duration 仅出现在返回的初始结果集的审核日志中。在同一 Listen 目标

的后续审核日志中，该字段会缺失。导入、批量删除操作和 TTL 的单个写入操作不会记录在审核日志中。

服务名称

Firestore 审核日志使用服务名称 firestore.googleapis.com。 针对此服务的过滤条件：

    protoPayload.serviceName="firestore.googleapis.com"
  

方法（按权限类型）

Firestore 还将以下操作纳入 Key Visualizer 诊断工具中。这些是数据访问审核日志，服务名称为 firestorekeyvisualizer.googleapis.com。只需为 firestore.googleapis.com 服务启用 DATA_READ 即可启用这些功能。

• google.cloud.keyvisualizer.KeyVisualizer.GetScan
• google.cloud.keyvisualizer.KeyVisualizer.ListScans

每个 IAM 权限都有一个 type 属性，该属性的值是一个枚举，可以是以下四个值之一：ADMIN_READ、ADMIN_WRITE、DATA_READ 或 DATA_WRITE。当您调用某个方法时，Firestore 会生成一个审核日志，其类别取决于执行该方法所需权限的 type 属性。需要 IAM 权限且 type 属性值为 DATA_READ、DATA_WRITE 或 ADMIN_READ 的方法会生成数据访问审核日志。需要 IAM 权限且 type 属性值为 ADMIN_WRITE 的方法会生成管理员活动审核日志。

以下列表中标记为 (LRO) 的 API 方法是长时间运行的操作 (LRO)。 这些方法通常会生成两条审核日志条目：一条在操作开始时生成，另一条在操作结束时生成。如需了解详情，请参阅长时间运行的操作的审核日志。

权限类型	方法
ADMIN_READ	google.cloud.location.Locations.GetLocation google.cloud.location.Locations.ListLocations google.firestore.admin.v1.FirestoreAdmin.GetBackup google.firestore.admin.v1.FirestoreAdmin.GetBackupSchedule google.firestore.admin.v1.FirestoreAdmin.GetDatabase google.firestore.admin.v1.FirestoreAdmin.GetField google.firestore.admin.v1.FirestoreAdmin.GetIndex google.firestore.admin.v1.FirestoreAdmin.ListBackupSchedules google.firestore.admin.v1.FirestoreAdmin.ListBackups google.firestore.admin.v1.FirestoreAdmin.ListDatabases google.firestore.admin.v1.FirestoreAdmin.ListFields google.firestore.admin.v1.FirestoreAdmin.ListIndexes google.firestore.admin.v1beta1.FirestoreAdmin.GetIndex google.firestore.admin.v1beta1.FirestoreAdmin.ListIndexes google.firestore.admin.v1beta2.FirestoreAdmin.GetField google.firestore.admin.v1beta2.FirestoreAdmin.GetIndex google.firestore.admin.v1beta2.FirestoreAdmin.ListFields google.firestore.admin.v1beta2.FirestoreAdmin.ListIndexes google.longrunning.Operations.GetOperation google.longrunning.Operations.ListOperations
ADMIN_WRITE	google.firestore.admin.v1.FirestoreAdmin.BulkDeleteDocuments (LRO) google.firestore.admin.v1.FirestoreAdmin.CreateBackupSchedule google.firestore.admin.v1.FirestoreAdmin.CreateDatabase google.firestore.admin.v1.FirestoreAdmin.CreateIndex (LRO) google.firestore.admin.v1.FirestoreAdmin.DeleteBackup google.firestore.admin.v1.FirestoreAdmin.DeleteBackupSchedule google.firestore.admin.v1.FirestoreAdmin.DeleteDatabase google.firestore.admin.v1.FirestoreAdmin.DeleteIndex google.firestore.admin.v1.FirestoreAdmin.ExportDocuments (LRO) google.firestore.admin.v1.FirestoreAdmin.ImportDocuments (LRO) google.firestore.admin.v1.FirestoreAdmin.RestoreDatabase google.firestore.admin.v1.FirestoreAdmin.UpdateBackupSchedule google.firestore.admin.v1.FirestoreAdmin.UpdateDatabase google.firestore.admin.v1.FirestoreAdmin.UpdateField (LRO) google.firestore.admin.v1beta1.FirestoreAdmin.CreateIndex (LRO) google.firestore.admin.v1beta1.FirestoreAdmin.DeleteIndex google.firestore.admin.v1beta1.FirestoreAdmin.ExportDocuments (LRO) google.firestore.admin.v1beta1.FirestoreAdmin.ImportDocuments (LRO) google.firestore.admin.v1beta2.FirestoreAdmin.CreateIndex (LRO) google.firestore.admin.v1beta2.FirestoreAdmin.DeleteIndex google.firestore.admin.v1beta2.FirestoreAdmin.ExportDocuments (LRO) google.firestore.admin.v1beta2.FirestoreAdmin.ImportDocuments (LRO) google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField (LRO) google.longrunning.Operations.CancelOperation google.longrunning.Operations.DeleteOperation
DATA_READ	google.firestore.v1.Firestore.BatchGetDocuments google.firestore.v1.Firestore.BeginTransaction google.firestore.v1.Firestore.GetDocument google.firestore.v1.Firestore.ListCollectionIds google.firestore.v1.Firestore.ListDocuments google.firestore.v1.Firestore.Listen google.firestore.v1.Firestore.PartitionQuery google.firestore.v1.Firestore.Rollback google.firestore.v1.Firestore.RunAggregationQuery google.firestore.v1.Firestore.RunQuery google.firestore.v1beta1.Firestore.BatchGetDocuments google.firestore.v1beta1.Firestore.BatchWrite google.firestore.v1beta1.Firestore.BeginTransaction google.firestore.v1beta1.Firestore.GetDocument google.firestore.v1beta1.Firestore.ListCollectionIds google.firestore.v1beta1.Firestore.ListDocuments google.firestore.v1beta1.Firestore.PartitionQuery google.firestore.v1beta1.Firestore.Rollback google.firestore.v1beta1.Firestore.RunAggregationQuery google.firestore.v1beta1.Firestore.RunQuery
DATA_WRITE	google.firestore.v1.Firestore.BatchWrite google.firestore.v1.Firestore.Commit google.firestore.v1.Firestore.CreateDocument google.firestore.v1.Firestore.DeleteDocument google.firestore.v1.Firestore.UpdateDocument google.firestore.v1.Firestore.Write google.firestore.v1beta1.Firestore.BatchWrite google.firestore.v1beta1.Firestore.Commit google.firestore.v1beta1.Firestore.CreateDocument google.firestore.v1beta1.Firestore.DeleteDocument google.firestore.v1beta1.Firestore.UpdateDocument

API 接口审核日志

如需了解如何评估每种方法的权限以及评估哪些权限，请参阅 Firestore 的 Identity and Access Management 文档。

google.cloud.location.Locations

以下审核日志与属于 google.cloud.location.Locations 的方法相关联。

GetLocation

• 方法：google.cloud.location.Locations.GetLocation
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.locations.get - ADMIN_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.cloud.location.Locations.GetLocation"
  

ListLocations

• 方法：google.cloud.location.Locations.ListLocations
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.locations.list - ADMIN_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.cloud.location.Locations.ListLocations"
  

google.firestore.admin.v1.FirestoreAdmin

以下审核日志与属于 google.firestore.admin.v1.FirestoreAdmin 的方法相关联。

BulkDeleteDocuments

• 方法：google.firestore.admin.v1.FirestoreAdmin.BulkDeleteDocuments
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.databases.bulkDelete - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：长时间运行的操作
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.BulkDeleteDocuments"
  

CreateBackupSchedule

• 方法：google.firestore.admin.v1.FirestoreAdmin.CreateBackupSchedule
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.backupSchedules.create - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.CreateBackupSchedule"
  

CreateDatabase

• 方法：google.firestore.admin.v1.FirestoreAdmin.CreateDatabase
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.databases.create - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.CreateDatabase"
  

CreateIndex

• 方法：google.firestore.admin.v1.FirestoreAdmin.CreateIndex
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.indexes.create - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：长时间运行的操作
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.CreateIndex"
  

DeleteBackup

• 方法：google.firestore.admin.v1.FirestoreAdmin.DeleteBackup
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.backups.delete - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.DeleteBackup"
  

DeleteBackupSchedule

• 方法：google.firestore.admin.v1.FirestoreAdmin.DeleteBackupSchedule
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.backupSchedules.delete - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.DeleteBackupSchedule"
  

DeleteDatabase

• 方法：google.firestore.admin.v1.FirestoreAdmin.DeleteDatabase
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.databases.delete - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.DeleteDatabase"
  

DeleteIndex

• 方法：google.firestore.admin.v1.FirestoreAdmin.DeleteIndex
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.indexes.delete - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.DeleteIndex"
  

ExportDocuments

• 方法：google.firestore.admin.v1.FirestoreAdmin.ExportDocuments
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.databases.export - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：长时间运行的操作
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ExportDocuments"
  

GetBackup

• 方法：google.firestore.admin.v1.FirestoreAdmin.GetBackup
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.backups.get - ADMIN_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.GetBackup"
  

GetBackupSchedule

• 方法：google.firestore.admin.v1.FirestoreAdmin.GetBackupSchedule
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.backupSchedules.get - ADMIN_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.GetBackupSchedule"
  

GetDatabase

• 方法：google.firestore.admin.v1.FirestoreAdmin.GetDatabase
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.databases.getMetadata - ADMIN_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.GetDatabase"
  

GetField

• 方法：google.firestore.admin.v1.FirestoreAdmin.GetField
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.indexes.get - ADMIN_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.GetField"
  

GetIndex

• 方法：google.firestore.admin.v1.FirestoreAdmin.GetIndex
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.indexes.get - ADMIN_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.GetIndex"
  

ImportDocuments

• 方法：google.firestore.admin.v1.FirestoreAdmin.ImportDocuments
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.databases.import - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：长时间运行的操作
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ImportDocuments"
  

ListBackupSchedules

• 方法：google.firestore.admin.v1.FirestoreAdmin.ListBackupSchedules
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.backupSchedules.list - ADMIN_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ListBackupSchedules"
  

ListBackups

• 方法：google.firestore.admin.v1.FirestoreAdmin.ListBackups
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.backups.list - ADMIN_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ListBackups"
  

ListDatabases

• 方法：google.firestore.admin.v1.FirestoreAdmin.ListDatabases
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.databases.list - ADMIN_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ListDatabases"
  

ListFields

• 方法：google.firestore.admin.v1.FirestoreAdmin.ListFields
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.indexes.list - ADMIN_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ListFields"
  

ListIndexes

• 方法：google.firestore.admin.v1.FirestoreAdmin.ListIndexes
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.indexes.list - ADMIN_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ListIndexes"
  

RestoreDatabase

• 方法：google.firestore.admin.v1.FirestoreAdmin.RestoreDatabase
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.backups.restoreDatabase - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.RestoreDatabase"
  

UpdateBackupSchedule

• 方法：google.firestore.admin.v1.FirestoreAdmin.UpdateBackupSchedule
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.backupSchedules.update - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.UpdateBackupSchedule"
  

UpdateDatabase

• 方法：google.firestore.admin.v1.FirestoreAdmin.UpdateDatabase
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.databases.update - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.UpdateDatabase"
  

UpdateField

• 方法：google.firestore.admin.v1.FirestoreAdmin.UpdateField
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.indexes.update - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：长时间运行的操作
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.UpdateField"
  

google.firestore.admin.v1beta1.FirestoreAdmin

以下审核日志与属于 google.firestore.admin.v1beta1.FirestoreAdmin 的方法相关联。

CreateIndex

• 方法：google.firestore.admin.v1beta1.FirestoreAdmin.CreateIndex
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.indexes.create - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：长时间运行的操作
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1beta1.FirestoreAdmin.CreateIndex"
  

DeleteIndex

• 方法：google.firestore.admin.v1beta1.FirestoreAdmin.DeleteIndex
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.indexes.delete - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1beta1.FirestoreAdmin.DeleteIndex"
  

ExportDocuments

• 方法：google.firestore.admin.v1beta1.FirestoreAdmin.ExportDocuments
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.databases.export - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：长时间运行的操作
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1beta1.FirestoreAdmin.ExportDocuments"
  

GetIndex

• 方法：google.firestore.admin.v1beta1.FirestoreAdmin.GetIndex
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.indexes.get - ADMIN_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1beta1.FirestoreAdmin.GetIndex"
  

ImportDocuments

• 方法：google.firestore.admin.v1beta1.FirestoreAdmin.ImportDocuments
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.databases.import - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：长时间运行的操作
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1beta1.FirestoreAdmin.ImportDocuments"
  

ListIndexes

• 方法：google.firestore.admin.v1beta1.FirestoreAdmin.ListIndexes
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.indexes.list - ADMIN_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1beta1.FirestoreAdmin.ListIndexes"
  

google.firestore.admin.v1beta2.FirestoreAdmin

以下审核日志与属于 google.firestore.admin.v1beta2.FirestoreAdmin 的方法相关联。

CreateIndex

• 方法：google.firestore.admin.v1beta2.FirestoreAdmin.CreateIndex
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.indexes.create - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：长时间运行的操作
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.CreateIndex"
  

DeleteIndex

• 方法：google.firestore.admin.v1beta2.FirestoreAdmin.DeleteIndex
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.indexes.delete - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.DeleteIndex"
  

ExportDocuments

• 方法：google.firestore.admin.v1beta2.FirestoreAdmin.ExportDocuments
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.databases.export - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：长时间运行的操作
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.ExportDocuments"
  

GetField

• 方法：google.firestore.admin.v1beta2.FirestoreAdmin.GetField
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.indexes.get - ADMIN_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.GetField"
  

GetIndex

• 方法：google.firestore.admin.v1beta2.FirestoreAdmin.GetIndex
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.indexes.get - ADMIN_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.GetIndex"
  

ImportDocuments

• 方法：google.firestore.admin.v1beta2.FirestoreAdmin.ImportDocuments
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.databases.import - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：长时间运行的操作
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.ImportDocuments"
  

ListFields

• 方法：google.firestore.admin.v1beta2.FirestoreAdmin.ListFields
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.indexes.list - ADMIN_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.ListFields"
  

ListIndexes

• 方法：google.firestore.admin.v1beta2.FirestoreAdmin.ListIndexes
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.indexes.list - ADMIN_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.ListIndexes"
  

UpdateField

• 方法：google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.indexes.update - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：长时间运行的操作
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField"
  

google.firestore.v1.Firestore

以下审核日志与属于 google.firestore.v1.Firestore 的方法相关联。

BatchGetDocuments

• 方法：google.firestore.v1.Firestore.BatchGetDocuments
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.get - DATA_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1.Firestore.BatchGetDocuments"
  

BatchWrite

• 方法：google.firestore.v1.Firestore.BatchWrite
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.create - DATA_WRITE
  • datastore.entities.delete - DATA_WRITE
  • datastore.entities.update - DATA_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1.Firestore.BatchWrite"
  

BeginTransaction

• 方法：google.firestore.v1.Firestore.BeginTransaction
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.databases.get - DATA_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1.Firestore.BeginTransaction"
  

Commit

• 方法：google.firestore.v1.Firestore.Commit
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.databases.get - DATA_READ
  • datastore.entities.create - DATA_WRITE
  • datastore.entities.delete - DATA_WRITE
  • datastore.entities.get - DATA_READ
  • datastore.entities.update - DATA_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1.Firestore.Commit"
  

CreateDocument

• 方法：google.firestore.v1.Firestore.CreateDocument
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.allocateIds - DATA_WRITE
  • datastore.entities.create - DATA_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1.Firestore.CreateDocument"
  

DeleteDocument

• 方法：google.firestore.v1.Firestore.DeleteDocument
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.delete - DATA_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1.Firestore.DeleteDocument"
  

GetDocument

• 方法：google.firestore.v1.Firestore.GetDocument
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.get - DATA_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1.Firestore.GetDocument"
  

ListCollectionIds

• 方法：google.firestore.v1.Firestore.ListCollectionIds
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.list - DATA_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1.Firestore.ListCollectionIds"
  

ListDocuments

• 方法：google.firestore.v1.Firestore.ListDocuments
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1.Firestore.ListDocuments"
  

Listen

• 方法：google.firestore.v1.Firestore.Listen
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• 方法是长时间运行的操作或流式传输操作： 流式传输 RPC
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1.Firestore.Listen"
  

注意：

Listen 是一个长期的 RPC，结合了多个流式传输目标。每个目标是一个查询或一组文档键。每个目标的数据流包括初始结果集以及对该结果集的一系列更新、添加和移除。目标是相关的审核单元。Firestore 会按以下方式审核每个目标：

• 添加目标后，发送包含目标查询或文档键集的日志条目。在这些条目中，operation.first 为 true。如果数据流是之前 Listen 目标数据流的恢复，则会省略此审核日志。
• 发送定期更新，报告此目标上次审核日志以来的更新计数。
• 从数据流中移除（明确移除或由于 Listen RPC 终止而移除）目标时，发送一项日志条目。此日志条目会报告此目标上次审核日志以来的更新计数。在这些条目中，operation.last 为 true。
• 发送的日志条目使用相同的 operation.id。

PartitionQuery

• 方法：google.firestore.v1.Firestore.PartitionQuery
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1.Firestore.PartitionQuery"
  

Rollback

• 方法：google.firestore.v1.Firestore.Rollback
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.databases.get - DATA_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1.Firestore.Rollback"
  

RunAggregationQuery

• 方法：google.firestore.v1.Firestore.RunAggregationQuery
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1.Firestore.RunAggregationQuery"
  

RunQuery

• 方法：google.firestore.v1.Firestore.RunQuery
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1.Firestore.RunQuery"
  

注意： RunQuery 是一个短期流式传输 RPC，在发送最后一条消息（文档）时会发送一项日志条目。

UpdateDocument

• 方法：google.firestore.v1.Firestore.UpdateDocument
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.create - DATA_WRITE
  • datastore.entities.update - DATA_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1.Firestore.UpdateDocument"
  

Write

• 方法：google.firestore.v1.Firestore.Write
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.create - DATA_WRITE
  • datastore.entities.update - DATA_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1.Firestore.Write"
  

注意： Write 为收到的每条消息发送一项日志条目，每条消息对应于数据库的一次独立写入。发送的日志条目使用相同的 operation.id。

google.firestore.v1beta1.Firestore

以下审核日志与属于 google.firestore.v1beta1.Firestore 的方法相关联。

BatchGetDocuments

• 方法：google.firestore.v1beta1.Firestore.BatchGetDocuments
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.databases.get - DATA_READ
  • datastore.entities.get - DATA_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1beta1.Firestore.BatchGetDocuments"
  

BatchWrite

• 方法：google.firestore.v1beta1.Firestore.BatchWrite
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.databases.get - DATA_READ
  • datastore.entities.create - DATA_WRITE
  • datastore.entities.update - DATA_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1beta1.Firestore.BatchWrite"
  

BeginTransaction

• 方法：google.firestore.v1beta1.Firestore.BeginTransaction
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.databases.get - DATA_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1beta1.Firestore.BeginTransaction"
  

Commit

• 方法：google.firestore.v1beta1.Firestore.Commit
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.databases.get - DATA_READ
  • datastore.entities.create - DATA_WRITE
  • datastore.entities.delete - DATA_WRITE
  • datastore.entities.update - DATA_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1beta1.Firestore.Commit"
  

CreateDocument

• 方法：google.firestore.v1beta1.Firestore.CreateDocument
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.allocateIds - DATA_WRITE
  • datastore.entities.create - DATA_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1beta1.Firestore.CreateDocument"
  

DeleteDocument

• 方法：google.firestore.v1beta1.Firestore.DeleteDocument
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.delete - DATA_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1beta1.Firestore.DeleteDocument"
  

GetDocument

• 方法：google.firestore.v1beta1.Firestore.GetDocument
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.get - DATA_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1beta1.Firestore.GetDocument"
  

ListCollectionIds

• 方法：google.firestore.v1beta1.Firestore.ListCollectionIds
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.list - DATA_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1beta1.Firestore.ListCollectionIds"
  

ListDocuments

• 方法：google.firestore.v1beta1.Firestore.ListDocuments
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1beta1.Firestore.ListDocuments"
  

PartitionQuery

• 方法：google.firestore.v1beta1.Firestore.PartitionQuery
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1beta1.Firestore.PartitionQuery"
  

Rollback

• 方法：google.firestore.v1beta1.Firestore.Rollback
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.databases.get - DATA_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1beta1.Firestore.Rollback"
  

RunAggregationQuery

• 方法：google.firestore.v1beta1.Firestore.RunAggregationQuery
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1beta1.Firestore.RunAggregationQuery"
  

RunQuery

• 方法：google.firestore.v1beta1.Firestore.RunQuery
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1beta1.Firestore.RunQuery"
  

注意： RunQuery 是一个短期流式传输 RPC，在发送最后一条消息（文档）时会发送一项日志条目。

UpdateDocument

• 方法：google.firestore.v1beta1.Firestore.UpdateDocument
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.entities.create - DATA_WRITE
  • datastore.entities.update - DATA_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.firestore.v1beta1.Firestore.UpdateDocument"
  

google.longrunning.Operations

以下审核日志与属于 google.longrunning.Operations 的方法相关联。

CancelOperation

• 方法：google.longrunning.Operations.CancelOperation
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.operations.cancel - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.longrunning.Operations.CancelOperation"
  

DeleteOperation

• 方法：google.longrunning.Operations.DeleteOperation
  
• 审核日志类型：管理员活动
  
• 权限：
  • datastore.operations.delete - ADMIN_WRITE
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.longrunning.Operations.DeleteOperation"
  

GetOperation

• 方法：google.longrunning.Operations.GetOperation
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.operations.get - ADMIN_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.longrunning.Operations.GetOperation"
  

ListOperations

• 方法：google.longrunning.Operations.ListOperations
  
• 审核日志类型：数据访问
  
• 权限：
  • datastore.operations.list - ADMIN_READ
• 方法是长时间运行的操作或流式传输操作：否。
  
• 此方法的过滤条件： protoPayload.methodName="google.longrunning.Operations.ListOperations"
  

识别请求调用方

审核日志条目包含有关执行所记录操作的身份的信息。如需识别请求调用方，请查看 AuditLog 对象中的以下字段：

• 调用方的身份保存在 AuthenticationInfo 字段中。这可能包括用户的 principalEmail。此信息有时会隐去。

  如果 JSON Web 令牌 (JWT) 用于第三方身份验证，则 thirdPartyPrincipal 字段会包含该令牌的标头和载荷。例如，使用 Firebase Authentication 进行身份验证的请求的审核日志包含该请求的身份验证令牌。

• AuditLog 条目的 requestMetadata 对象中的 callerIp 字段包含调用方的 IP 地址。