Informations sur les journaux d'audit de Firestore

Cloud Audit Logs pour Firestore vous permet de suivre les opérations d'administration et d'accès aux données sur vos ressources afin de surveiller les accès et les modifications de configuration. Vous pouvez interroger ces journaux dans l'explorateur de journaux et vérifier quelles méthodes de l'API Firestore génèrent des Cloud Audit Logs.

Pour en savoir plus sur Cloud Audit Logs, consultez les documents suivants :

Remarques

Lorsque vous configurez la journalisation d'audit, utilisez le nom de service datastore.googleapis.com pour configurer à la fois datastore.googleapis.com et firestore.googleapis.com.Une fois configurés, les journaux de l'API Firestore incluent le nom de service firestore.googleapis.com.

Pour afficher le temps nécessaire au traitement d'une requête DATA_READ ou DATA_WRITE, consultez le champ processing_duration dans l'objet metadata d'un AuditLog. processing_duration décrit le temps qu'il a fallu à la base de données pour traiter une requête. Cette valeur est inférieure à la latence de l'utilisateur final. En particulier, il n'inclut pas la surcharge réseau.

Pour les requêtes Listen, processing_duration n'est présent que dans le journal d'audit de l'ensemble de résultats initial renvoyé. Il est absent des journaux d'audit ultérieurs pour cette même cible Listen.

Les écritures individuelles issues d'opérations d'importation, de suppression groupée et de TTL ne sont pas consignées dans les journaux d'audit.

Nom du service

Pour afficher les journaux d'audit Firestore, procédez comme suit :

  1. Dans la console Google Cloud , accédez à la page Explorateur de journaux.

    Accéder à l'explorateur de journaux

  2. Copiez et collez la requête suivante dans le champ Requête de l'explorateur de journaux, puis cliquez sur Exécuter la requête.

        protoPayload.serviceName="firestore.googleapis.com"
      

Méthodes par type d'autorisation

Chaque autorisation IAM possède une propriété type, dont la valeur est une énumération. Il peut s'agir de l'une des quatre valeurs suivantes : ADMIN_READ, ADMIN_WRITE, DATA_READ ou DATA_WRITE. Lorsque vous appelez une méthode, Firestore génère un journal d'audit dont la catégorie dépend de la propriété type de l'autorisation requise pour exécuter la méthode. Les méthodes nécessitant une autorisation IAM avec la valeur de la propriété type de DATA_READ, DATA_WRITE ou ADMIN_READ génèrent des journaux d'audit des accès aux données. Les méthodes nécessitant une autorisation IAM avec la valeur de propriété type de ADMIN_WRITE génèrent des journaux d'audit pour les activités d'administration.

Les méthodes d'API de la liste suivante marquées (LRO) sont des opérations de longue durée (LRO, Long-running operations). Ces méthodes génèrent généralement deux entrées de journal d'audit : une au début de l'opération et une autre à la fin. Pour en savoir plus, consultez Journaux d'audit pour les opérations de longue durée.
Type d'autorisation Méthodes
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.GetChangeStream
google.firestore.admin.v1.FirestoreAdmin.GetDatabase
google.firestore.admin.v1.FirestoreAdmin.GetField
google.firestore.admin.v1.FirestoreAdmin.GetIndex
google.firestore.admin.v1.FirestoreAdmin.GetUserCreds
google.firestore.admin.v1.FirestoreAdmin.ListBackupSchedules
google.firestore.admin.v1.FirestoreAdmin.ListBackups
google.firestore.admin.v1.FirestoreAdmin.ListChangeStreams
google.firestore.admin.v1.FirestoreAdmin.ListDatabases
google.firestore.admin.v1.FirestoreAdmin.ListFields
google.firestore.admin.v1.FirestoreAdmin.ListIndexes
google.firestore.admin.v1.FirestoreAdmin.ListUserCreds
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.CloneDatabase
google.firestore.admin.v1.FirestoreAdmin.CreateBackupSchedule
google.firestore.admin.v1.FirestoreAdmin.CreateChangeStream
google.firestore.admin.v1.FirestoreAdmin.CreateDatabase
google.firestore.admin.v1.FirestoreAdmin.CreateIndex (LRO)
google.firestore.admin.v1.FirestoreAdmin.CreateUserCreds
google.firestore.admin.v1.FirestoreAdmin.DeleteBackup
google.firestore.admin.v1.FirestoreAdmin.DeleteBackupSchedule
google.firestore.admin.v1.FirestoreAdmin.DeleteChangeStream
google.firestore.admin.v1.FirestoreAdmin.DeleteDatabase
google.firestore.admin.v1.FirestoreAdmin.DeleteIndex
google.firestore.admin.v1.FirestoreAdmin.DeleteUserCreds
google.firestore.admin.v1.FirestoreAdmin.DisableUserCreds
google.firestore.admin.v1.FirestoreAdmin.EnableUserCreds
google.firestore.admin.v1.FirestoreAdmin.ExportDocuments (LRO)
google.firestore.admin.v1.FirestoreAdmin.ImportDocuments (LRO)
google.firestore.admin.v1.FirestoreAdmin.ResetUserPassword
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.ExecutePipeline
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.Commit
google.firestore.v1beta1.Firestore.ExecutePipeline
google.firestore.v1beta1.Firestore.GetDocument
google.firestore.v1beta1.Firestore.ListCollectionIds
google.firestore.v1beta1.Firestore.ListDocuments
google.firestore.v1beta1.Firestore.Listen
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.CreateDocument
google.firestore.v1beta1.Firestore.DeleteDocument
google.firestore.v1beta1.Firestore.UpdateDocument
google.firestore.v1beta1.Firestore.Write

Journaux d'audit d'interface API

Pour en savoir plus sur la manière dont les autorisations sont évaluées, pour chaque méthode, consultez la documentation Identity and Access Management pour Firestore.

google.cloud.location.Locations

Les journaux d'audit suivants sont associés aux méthodes appartenant à google.cloud.location.Locations.

GetLocation

ListLocations

google.firestore.admin.v1.FirestoreAdmin

Les journaux d'audit suivants sont associés aux méthodes appartenant à google.firestore.admin.v1.FirestoreAdmin.

BulkDeleteDocuments

CloneDatabase

CreateBackupSchedule

CreateChangeStream

CreateDatabase

CreateIndex

CreateUserCreds

DeleteBackup

DeleteBackupSchedule

DeleteChangeStream

DeleteDatabase

DeleteIndex

DeleteUserCreds

DisableUserCreds

EnableUserCreds

ExportDocuments

GetBackup

GetBackupSchedule

GetChangeStream

GetDatabase

GetField

GetIndex

GetUserCreds

ImportDocuments

ListBackupSchedules

ListBackups

ListChangeStreams

ListDatabases

ListFields

ListIndexes

ListUserCreds

ResetUserPassword

RestoreDatabase

UpdateBackupSchedule

UpdateDatabase

UpdateField

google.firestore.admin.v1beta1.FirestoreAdmin

Les journaux d'audit suivants sont associés aux méthodes appartenant à google.firestore.admin.v1beta1.FirestoreAdmin.

CreateIndex

DeleteIndex

ExportDocuments

GetIndex

ImportDocuments

ListIndexes

google.firestore.admin.v1beta2.FirestoreAdmin

Les journaux d'audit suivants sont associés aux méthodes appartenant à google.firestore.admin.v1beta2.FirestoreAdmin.

CreateIndex

DeleteIndex

ExportDocuments

GetField

GetIndex

ImportDocuments

ListFields

ListIndexes

UpdateField

google.firestore.v1.Firestore

Les journaux d'audit suivants sont associés aux méthodes appartenant à google.firestore.v1.Firestore.

BatchGetDocuments

BatchWrite

  • Méthode : google.firestore.v1.Firestore.BatchWrite
  • Type de journaux d'audit : journaux d'audit des accès aux données
  • Autorisations :
    • datastore.entities.create - DATA_WRITE
    • datastore.entities.delete - DATA_WRITE
    • datastore.entities.update - DATA_WRITE
  • La méthode est une opération de longue durée ou en flux continu : Non.
  • Filtre pour cette méthode : protoPayload.methodName="google.firestore.v1.Firestore.BatchWrite"

BeginTransaction

Commit

  • Méthode : google.firestore.v1.Firestore.Commit
  • Type de journaux d'audit : journaux d'audit des accès aux données
  • Autorisations :
    • datastore.databases.get - DATA_READ
    • datastore.entities.create - DATA_WRITE
    • datastore.entities.delete - DATA_WRITE
    • datastore.entities.update - DATA_WRITE
  • La méthode est une opération de longue durée ou en flux continu : Non.
  • Filtre pour cette méthode : protoPayload.methodName="google.firestore.v1.Firestore.Commit"

CreateDocument

DeleteDocument

ExecutePipeline

  • Méthode : google.firestore.v1.Firestore.ExecutePipeline
  • Type de journaux d'audit : journaux d'audit des accès aux données
  • Autorisations :
    • datastore.databases.get - DATA_READ
    • datastore.entities.create - DATA_WRITE
    • datastore.entities.get - DATA_READ
    • datastore.entities.list - DATA_READ
    • datastore.entities.update - DATA_WRITE
  • La méthode est une opération de longue durée ou en flux continu : Non.
  • Filtre pour cette méthode : protoPayload.methodName="google.firestore.v1.Firestore.ExecutePipeline"

GetDocument

ListCollectionIds

ListDocuments

Listen

PartitionQuery

Rollback

RunAggregationQuery

RunQuery

UpdateDocument

Write

  • Méthode : google.firestore.v1.Firestore.Write
  • Type de journaux d'audit : journaux d'audit des accès aux données
  • Autorisations :
    • datastore.entities.create - DATA_WRITE
    • datastore.entities.delete - DATA_WRITE
    • datastore.entities.update - DATA_WRITE
  • La méthode est une opération de longue durée ou en flux continu : Non.
  • Filtre pour cette méthode : protoPayload.methodName="google.firestore.v1.Firestore.Write"

google.firestore.v1beta1.Firestore

Les journaux d'audit suivants sont associés aux méthodes appartenant à google.firestore.v1beta1.Firestore.

BatchGetDocuments

BatchWrite

BeginTransaction

Commit

  • Méthode : google.firestore.v1beta1.Firestore.Commit
  • Type de journaux d'audit : journaux d'audit des accès aux données
  • Autorisations :
    • datastore.databases.get - DATA_READ
    • datastore.entities.create - DATA_WRITE
    • datastore.entities.update - DATA_WRITE
  • La méthode est une opération de longue durée ou en flux continu : Non.
  • Filtre pour cette méthode : protoPayload.methodName="google.firestore.v1beta1.Firestore.Commit"

CreateDocument

DeleteDocument

ExecutePipeline

GetDocument

ListCollectionIds

ListDocuments

Listen

PartitionQuery

Rollback

RunAggregationQuery

RunQuery

UpdateDocument

Write

google.longrunning.Operations

Les journaux d'audit suivants sont associés aux méthodes appartenant à google.longrunning.Operations.

CancelOperation

DeleteOperation

GetOperation

ListOperations

Méthodes ne produisant pas de journaux d'audit

Il est possible qu'une méthode ne produise pas de journaux d'audit pour une ou plusieurs des raisons suivantes :

  • Il s'agit d'une méthode à volume élevé impliquant des coûts significatifs de génération de journaux et de stockage.
  • Sa valeur d'audit est faible.
  • Un autre journal d'audit ou de plate-forme couvre déjà cette méthode.

Les méthodes suivantes ne génèrent pas de journaux d'audit :

  • google.longrunning.Operations.WaitOperation

Identifier les appelants de requêtes

Les entrées de journal d'audit incluent des informations sur l'identité qui a effectué l'opération consignée. Pour identifier l'appelant d'une requête, consultez les champs suivants dans un objet AuditLog :

  • L'identité de l'appelant est conservée dans le champ AuthenticationInfo. Cela peut inclure l'principalEmail de l'utilisateur. Ces informations sont parfois masquées.

    Si un jeton Web JSON (JWT) a été utilisé pour l'authentification tierce, le champ thirdPartyPrincipal inclut l'en-tête et la charge utile du jeton. Par exemple, les journaux d'audit des requêtes authentifiées avec Firebase Authentication incluent le jeton d'authentification de cette requête.

  • Le champ callerIp de l'objet requestMetadata d'une entrée AuditLog inclut l'adresse IP de l'appelant.