Informações sobre a geração de registros de auditoria do Firestore

Informações sobre a geração de registros de auditoria do Firestore

Neste documento, descrevemos a geração de registros de auditoria do Firestore. Os serviços do Google Cloud geram registros de auditoria que registram atividades administrativas e de acesso nos recursos do Google Cloud. Para saber mais sobre os Registros de auditoria do Cloud, consulte as seguintes páginas da documentação:

• Tipos de registros de auditoria
• Estrutura da entrada de registro de auditoria
• Detalhes sobre o armazenamento e o roteamento de registros de auditoria
• Resumo dos preços do Cloud Logging
• Como ativar os registros de auditoria de acesso a dados

Observações

Ao configurar a geração de registros de auditoria, use o nome de serviço datastore.googleapis.com para configurar datastore.googleapis.com e firestore.googleapis.com.Depois de configurados, os registros da API Firestore incluem o nome do serviço firestore.googleapis.com.

Para ver o tempo necessário para processar uma solicitação DATA_READ ou DATA_WRITE, consulte o campo processing_duration no objeto metadata de um AuditLog. processing_duration descreve o tempo que o banco de dados levou para processar uma solicitação. Esse valor é menor que a latência do usuário final. Em particular, isso não inclui sobrecarga da rede.

Para solicitações Listen, processing_duration está presente apenas no registro de auditoria do conjunto inicial de resultados retornados. Está ausente de registros de auditoria subsequentes para o mesmo destino Listen.

Gravações individuais de operações de importação e TTL não são registradas de auditoria.

Nome do serviço

Os registros de auditoria do Firestore usam o nome de serviço firestore.googleapis.com. Filtrar por este serviço:

    protoPayload.serviceName="firestore.googleapis.com"
  

Métodos por tipo de permissão

O Firestore também inclui as operações a seguir como parte da ferramenta de diagnóstico Key Visualizer. Esses são registros de auditoria de acesso a dados e têm o nome de serviço firestorekeyvisualizer.googleapis.com. Elas são ativadas ativando DATA_READ para o serviço firestore.googleapis.com.

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

Cada permissão do IAM tem uma propriedade type, que tem o valor de um tipo enumerado que pode ser um dos quatro valores: ADMIN_READ, ADMIN_WRITE, DATA_READ ou DATA_WRITE. Quando você chama um método, O Firestore gera um registro de auditoria com categoria dependente do type da permissão necessária para executar o método. Métodos que exigem uma permissão do IAM com o valor da propriedade type de DATA_READ, DATA_WRITE ou ADMIN_READ geram registros de auditoria de acesso aos dados. Métodos que exigem uma permissão do IAM com o valor da propriedade type de ADMIN_WRITE geram registros de auditoria de Atividade do administrador.

Tipo de permissão	Métodos
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 google.firestore.admin.v1.FirestoreAdmin.CreateBackupSchedule google.firestore.admin.v1.FirestoreAdmin.CreateDatabase google.firestore.admin.v1.FirestoreAdmin.CreateIndex 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 google.firestore.admin.v1.FirestoreAdmin.ImportDocuments google.firestore.admin.v1.FirestoreAdmin.RestoreDatabase google.firestore.admin.v1.FirestoreAdmin.UpdateBackupSchedule google.firestore.admin.v1.FirestoreAdmin.UpdateDatabase google.firestore.admin.v1.FirestoreAdmin.UpdateField google.firestore.admin.v1beta1.FirestoreAdmin.CreateIndex google.firestore.admin.v1beta1.FirestoreAdmin.DeleteIndex google.firestore.admin.v1beta1.FirestoreAdmin.ExportDocuments google.firestore.admin.v1beta1.FirestoreAdmin.ImportDocuments google.firestore.admin.v1beta2.FirestoreAdmin.CreateIndex google.firestore.admin.v1beta2.FirestoreAdmin.DeleteIndex google.firestore.admin.v1beta2.FirestoreAdmin.ExportDocuments google.firestore.admin.v1beta2.FirestoreAdmin.ImportDocuments google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField 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.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

Registros de auditoria da interface da API

Para informações sobre como e quais permissões são avaliadas para cada método, consulte a documentação do Identity and Access Management para o Firestore.

google.cloud.location.Locations

A seção a seguir contém detalhes sobre registros de auditoria associados aos métodos que pertencem ao google.cloud.location.Locations.

GetLocation

• Método: google.cloud.location.Locations.GetLocation
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.locations.get - ADMIN_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.cloud.location.Locations.GetLocation"
  

ListLocations

• Método: google.cloud.location.Locations.ListLocations
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.locations.list - ADMIN_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.cloud.location.Locations.ListLocations"
  

google.firestore.admin.v1.FirestoreAdmin

A seção a seguir contém detalhes sobre registros de auditoria associados aos métodos que pertencem ao google.firestore.admin.v1.FirestoreAdmin.

BulkDeleteDocuments

• Método: google.firestore.admin.v1.FirestoreAdmin.BulkDeleteDocuments
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.databases.bulkDelete - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: operação de longa duração
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.BulkDeleteDocuments"
  

CreateBackupSchedule

• Método: google.firestore.admin.v1.FirestoreAdmin.CreateBackupSchedule
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.backupSchedules.create - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.CreateBackupSchedule"
  

CreateDatabase

• Método: google.firestore.admin.v1.FirestoreAdmin.CreateDatabase
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.databases.create - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: operação de longa duração
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.CreateDatabase"
  

CreateIndex

• Método: google.firestore.admin.v1.FirestoreAdmin.CreateIndex
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.indexes.create - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: operação de longa duração
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.CreateIndex"
  

DeleteBackup

• Método: google.firestore.admin.v1.FirestoreAdmin.DeleteBackup
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.backups.delete - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.DeleteBackup"
  

DeleteBackupSchedule

• Método: google.firestore.admin.v1.FirestoreAdmin.DeleteBackupSchedule
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.backupSchedules.delete - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.DeleteBackupSchedule"
  

DeleteDatabase

• Método: google.firestore.admin.v1.FirestoreAdmin.DeleteDatabase
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.databases.delete - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: operação de longa duração
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.DeleteDatabase"
  

DeleteIndex

• Método: google.firestore.admin.v1.FirestoreAdmin.DeleteIndex
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.indexes.delete - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.DeleteIndex"
  

ExportDocuments

• Método: google.firestore.admin.v1.FirestoreAdmin.ExportDocuments
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.databases.export - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: operação de longa duração
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ExportDocuments"
  

GetBackup

• Método: google.firestore.admin.v1.FirestoreAdmin.GetBackup
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.backups.get - ADMIN_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.GetBackup"
  

GetBackupSchedule

• Método: google.firestore.admin.v1.FirestoreAdmin.GetBackupSchedule
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.backupSchedules.get - ADMIN_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.GetBackupSchedule"
  

GetDatabase

• Método: google.firestore.admin.v1.FirestoreAdmin.GetDatabase
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.databases.getMetadata - ADMIN_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.GetDatabase"
  

GetField

• Método: google.firestore.admin.v1.FirestoreAdmin.GetField
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.indexes.get - ADMIN_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.GetField"
  

GetIndex

• Método: google.firestore.admin.v1.FirestoreAdmin.GetIndex
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.indexes.get - ADMIN_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.GetIndex"
  

ImportDocuments

• Método: google.firestore.admin.v1.FirestoreAdmin.ImportDocuments
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.databases.import - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: operação de longa duração
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ImportDocuments"
  

ListBackupSchedules

• Método: google.firestore.admin.v1.FirestoreAdmin.ListBackupSchedules
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.backupSchedules.list - ADMIN_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ListBackupSchedules"
  

ListBackups

• Método: google.firestore.admin.v1.FirestoreAdmin.ListBackups
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.backups.list - ADMIN_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ListBackups"
  

ListDatabases

• Método: google.firestore.admin.v1.FirestoreAdmin.ListDatabases
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.databases.list - ADMIN_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ListDatabases"
  

ListFields

• Método: google.firestore.admin.v1.FirestoreAdmin.ListFields
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.indexes.list - ADMIN_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ListFields"
  

ListIndexes

• Método: google.firestore.admin.v1.FirestoreAdmin.ListIndexes
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.indexes.list - ADMIN_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.ListIndexes"
  

RestoreDatabase

• Método: google.firestore.admin.v1.FirestoreAdmin.RestoreDatabase
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.backups.restoreDatabase - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: operação de longa duração
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.RestoreDatabase"
  

UpdateBackupSchedule

• Método: google.firestore.admin.v1.FirestoreAdmin.UpdateBackupSchedule
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.backupSchedules.update - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.UpdateBackupSchedule"
  

UpdateDatabase

• Método: google.firestore.admin.v1.FirestoreAdmin.UpdateDatabase
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.databases.update - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: operação de longa duração
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.UpdateDatabase"
  

UpdateField

• Método: google.firestore.admin.v1.FirestoreAdmin.UpdateField
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.indexes.update - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: operação de longa duração
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1.FirestoreAdmin.UpdateField"
  

google.firestore.admin.v1beta1.FirestoreAdmin

A seção a seguir contém detalhes sobre registros de auditoria associados aos métodos que pertencem ao google.firestore.admin.v1beta1.FirestoreAdmin.

CreateIndex

• Método: google.firestore.admin.v1beta1.FirestoreAdmin.CreateIndex
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.indexes.create - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: operação de longa duração
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1beta1.FirestoreAdmin.CreateIndex"
  

DeleteIndex

• Método: google.firestore.admin.v1beta1.FirestoreAdmin.DeleteIndex
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.indexes.delete - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1beta1.FirestoreAdmin.DeleteIndex"
  

ExportDocuments

• Método: google.firestore.admin.v1beta1.FirestoreAdmin.ExportDocuments
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.databases.export - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: operação de longa duração
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1beta1.FirestoreAdmin.ExportDocuments"
  

GetIndex

• Método: google.firestore.admin.v1beta1.FirestoreAdmin.GetIndex
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.indexes.get - ADMIN_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1beta1.FirestoreAdmin.GetIndex"
  

ImportDocuments

• Método: google.firestore.admin.v1beta1.FirestoreAdmin.ImportDocuments
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.databases.import - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: operação de longa duração
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1beta1.FirestoreAdmin.ImportDocuments"
  

ListIndexes

• Método: google.firestore.admin.v1beta1.FirestoreAdmin.ListIndexes
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.indexes.list - ADMIN_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1beta1.FirestoreAdmin.ListIndexes"
  

google.firestore.admin.v1beta2.FirestoreAdmin

A seção a seguir contém detalhes sobre registros de auditoria associados aos métodos que pertencem ao google.firestore.admin.v1beta2.FirestoreAdmin.

CreateIndex

• Método: google.firestore.admin.v1beta2.FirestoreAdmin.CreateIndex
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.indexes.create - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: operação de longa duração
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.CreateIndex"
  

DeleteIndex

• Método: google.firestore.admin.v1beta2.FirestoreAdmin.DeleteIndex
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.indexes.delete - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.DeleteIndex"
  

ExportDocuments

• Método: google.firestore.admin.v1beta2.FirestoreAdmin.ExportDocuments
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.databases.export - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: operação de longa duração
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.ExportDocuments"
  

GetField

• Método: google.firestore.admin.v1beta2.FirestoreAdmin.GetField
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.indexes.get - ADMIN_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.GetField"
  

GetIndex

• Método: google.firestore.admin.v1beta2.FirestoreAdmin.GetIndex
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.indexes.get - ADMIN_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.GetIndex"
  

ImportDocuments

• Método: google.firestore.admin.v1beta2.FirestoreAdmin.ImportDocuments
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.databases.import - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: operação de longa duração
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.ImportDocuments"
  

ListFields

• Método: google.firestore.admin.v1beta2.FirestoreAdmin.ListFields
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.indexes.list - ADMIN_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.ListFields"
  

ListIndexes

• Método: google.firestore.admin.v1beta2.FirestoreAdmin.ListIndexes
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.indexes.list - ADMIN_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.ListIndexes"
  

UpdateField

• Método: google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.indexes.update - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: operação de longa duração
  
• Filtrar para este método: protoPayload.methodName="google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField"
  

google.firestore.v1.Firestore

A seção a seguir contém detalhes sobre registros de auditoria associados aos métodos que pertencem ao google.firestore.v1.Firestore.

BatchGetDocuments

• Método: google.firestore.v1.Firestore.BatchGetDocuments
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.get - DATA_READ
• O método é uma operação de streaming ou de longa duração: RPC de streaming
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1.Firestore.BatchGetDocuments"
  

BatchWrite

• Método: google.firestore.v1.Firestore.BatchWrite
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.create - DATA_WRITE
  • datastore.entities.delete - DATA_WRITE
  • datastore.entities.update - DATA_WRITE
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1.Firestore.BatchWrite"
  

BeginTransaction

• Método: google.firestore.v1.Firestore.BeginTransaction
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.databases.get - DATA_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1.Firestore.BeginTransaction"
  

Commit

• Método: google.firestore.v1.Firestore.Commit
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.create - DATA_WRITE
  • datastore.entities.delete - DATA_WRITE
  • datastore.entities.update - DATA_WRITE
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1.Firestore.Commit"
  

CreateDocument

• Método: google.firestore.v1.Firestore.CreateDocument
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.allocateIds - DATA_WRITE
  • datastore.entities.create - DATA_WRITE
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1.Firestore.CreateDocument"
  

DeleteDocument

• Método: google.firestore.v1.Firestore.DeleteDocument
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.delete - DATA_WRITE
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1.Firestore.DeleteDocument"
  

GetDocument

• Método: google.firestore.v1.Firestore.GetDocument
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.get - DATA_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1.Firestore.GetDocument"
  

ListCollectionIds

• Método: google.firestore.v1.Firestore.ListCollectionIds
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.list - DATA_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1.Firestore.ListCollectionIds"
  

ListDocuments

• Método: google.firestore.v1.Firestore.ListDocuments
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1.Firestore.ListDocuments"
  

Listen

• Método: google.firestore.v1.Firestore.Listen
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• O método é uma operação de streaming ou de longa duração: RPC de streaming
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1.Firestore.Listen"
  

Observação:

Listen é uma RPC de longa duração que combina vários destinos de streaming. Cada destino é uma consulta ou um conjunto de chaves de documentos. O fluxo de cada destino inclui um conjunto de resultados inicial e uma sequência de atualizações, adições e remoções do conjunto de resultados. As metas são a unidade de auditoria relevante. O Firestore audita cada destino da seguinte maneira:

• Quando o alvo for adicionado, emita uma entrada de registro com a consulta de destinos ou o conjunto de chaves do documento. Nessas entradas, operation.first é verdadeiro. Esse registro de auditoria é omitido quando a transmissão é uma retomada de uma transmissão de destino do Listen anterior.
• Emitir atualizações periódicas informando o número de atualizações desde o último registro de auditoria do destino.
• Emita uma entrada de registro quando o destino é removido do stream, seja explicitamente ou devido ao encerramento da RPC Listen. Essa entrada de registro informa a contagem de atualizações desde o último registro de auditoria para esse destino. Nessas entradas, operation.last é verdadeiro.
• As entradas de registro emitidas usam o mesmo operation.id.

PartitionQuery

• Método: google.firestore.v1.Firestore.PartitionQuery
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1.Firestore.PartitionQuery"
  

Rollback

• Método: google.firestore.v1.Firestore.Rollback
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.databases.get - DATA_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1.Firestore.Rollback"
  

RunAggregationQuery

• Método: google.firestore.v1.Firestore.RunAggregationQuery
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• O método é uma operação de streaming ou de longa duração: RPC de streaming
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1.Firestore.RunAggregationQuery"
  

RunQuery

• Método: google.firestore.v1.Firestore.RunQuery
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• O método é uma operação de streaming ou de longa duração: RPC de streaming
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1.Firestore.RunQuery"
  

Observação : RunQuery é uma RPC de streaming de curta duração e emite uma entrada de registro quando a última mensagem (documento) é enviada.

UpdateDocument

• Método: google.firestore.v1.Firestore.UpdateDocument
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.create - DATA_WRITE
  • datastore.entities.update - DATA_WRITE
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1.Firestore.UpdateDocument"
  

Write

• Método: google.firestore.v1.Firestore.Write
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.create - DATA_WRITE
  • datastore.entities.update - DATA_WRITE
• O método é uma operação de streaming ou de longa duração: RPC de streaming
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1.Firestore.Write"
  

Observação : Write emite uma entrada de registro para cada mensagem recebida, já que cada mensagem corresponde a uma gravação independente no banco de dados. As entradas de registro emitidas usam as mesmas operation.id.

google.firestore.v1beta1.Firestore

A seção a seguir contém detalhes sobre registros de auditoria associados aos métodos que pertencem ao google.firestore.v1beta1.Firestore.

BatchGetDocuments

• Método: google.firestore.v1beta1.Firestore.BatchGetDocuments
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.databases.get - DATA_READ
  • datastore.entities.get - DATA_READ
• O método é uma operação de streaming ou de longa duração: RPC de streaming
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1beta1.Firestore.BatchGetDocuments"
  

BatchWrite

• Método: google.firestore.v1beta1.Firestore.BatchWrite
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.create - DATA_WRITE
  • datastore.entities.update - DATA_WRITE
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1beta1.Firestore.BatchWrite"
  

BeginTransaction

• Método: google.firestore.v1beta1.Firestore.BeginTransaction
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.databases.get - DATA_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1beta1.Firestore.BeginTransaction"
  

Commit

• Método: google.firestore.v1beta1.Firestore.Commit
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.create - DATA_WRITE
  • datastore.entities.update - DATA_WRITE
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1beta1.Firestore.Commit"
  

CreateDocument

• Método: google.firestore.v1beta1.Firestore.CreateDocument
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.allocateIds - DATA_WRITE
  • datastore.entities.create - DATA_WRITE
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1beta1.Firestore.CreateDocument"
  

DeleteDocument

• Método: google.firestore.v1beta1.Firestore.DeleteDocument
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.delete - DATA_WRITE
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1beta1.Firestore.DeleteDocument"
  

GetDocument

• Método: google.firestore.v1beta1.Firestore.GetDocument
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.get - DATA_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1beta1.Firestore.GetDocument"
  

ListCollectionIds

• Método: google.firestore.v1beta1.Firestore.ListCollectionIds
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.list - DATA_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1beta1.Firestore.ListCollectionIds"
  

ListDocuments

• Método: google.firestore.v1beta1.Firestore.ListDocuments
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1beta1.Firestore.ListDocuments"
  

PartitionQuery

• Método: google.firestore.v1beta1.Firestore.PartitionQuery
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1beta1.Firestore.PartitionQuery"
  

Rollback

• Método: google.firestore.v1beta1.Firestore.Rollback
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.databases.get - DATA_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1beta1.Firestore.Rollback"
  

RunAggregationQuery

• Método: google.firestore.v1beta1.Firestore.RunAggregationQuery
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• O método é uma operação de streaming ou de longa duração: RPC de streaming
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1beta1.Firestore.RunAggregationQuery"
  

RunQuery

• Método: google.firestore.v1beta1.Firestore.RunQuery
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.get - DATA_READ
  • datastore.entities.list - DATA_READ
• O método é uma operação de streaming ou de longa duração: RPC de streaming
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1beta1.Firestore.RunQuery"
  

Observação : RunQuery é uma RPC de streaming de curta duração e emite uma entrada de registro quando a última mensagem (documento) é enviada.

UpdateDocument

• Método: google.firestore.v1beta1.Firestore.UpdateDocument
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.entities.create - DATA_WRITE
  • datastore.entities.update - DATA_WRITE
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.firestore.v1beta1.Firestore.UpdateDocument"
  

google.longrunning.Operations

A seção a seguir contém detalhes sobre registros de auditoria associados aos métodos que pertencem ao google.longrunning.Operations.

CancelOperation

• Método: google.longrunning.Operations.CancelOperation
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.operations.cancel - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.longrunning.Operations.CancelOperation"
  

DeleteOperation

• Método: google.longrunning.Operations.DeleteOperation
  
• Tipo de registro de auditoria: atividade do administrador
  
• Permissões:
  • datastore.operations.delete - ADMIN_WRITE
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.longrunning.Operations.DeleteOperation"
  

GetOperation

• Método: google.longrunning.Operations.GetOperation
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.operations.get - ADMIN_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.longrunning.Operations.GetOperation"
  

ListOperations

• Método: google.longrunning.Operations.ListOperations
  
• Tipo de registro de auditoria: acesso a dados
  
• Permissões:
  • datastore.operations.list - ADMIN_READ
• O método é uma operação de streaming ou de longa duração: No
  
• Filtrar para este método: protoPayload.methodName="google.longrunning.Operations.ListOperations"
  

Identificar os autores das chamadas de solicitação

As entradas do registro de auditoria incluem informações sobre a identidade que executou operação registrada. Para identificar um autor da chamada de solicitação, consulte os seguintes campos em um objeto AuditLog:

• A identidade do autor da chamada é retida AuthenticationInfo . Isso pode incluir o principalEmail do usuário. Essas informações são às vezes encobertos.

  Se um JSON Web Token (JWT, na sigla em inglês) for usado para a autenticação de terceiros, o campo thirdPartyPrincipal vai conter o cabeçalho e o payload do token. Por exemplo, os registros de auditoria de solicitações autenticadas com o Firebase Authentication incluem o token de autenticação dessa solicitação.

• No campo callerIp, requestMetadata de uma entrada AuditLog inclui o endereço IP do autor da chamada.