Data Lineage API audit logging

This document describes audit logging for Data Lineage API, which methods generate audit logs, details about the audit logs each method produces, and which methods do not produce audit logs, if any. Google Cloud generates audit logs that record administrative and access activities within your Google Cloud resources. For more information, see Cloud Audit Logs overview.

Service name

Data Lineage API audit logs use the service name datalineage.googleapis.com.

Methods by permission type

Methods that check DATA_READ, DATA_WRITE, and ADMIN_READ permissions generate logs categorized as Data Access audit logs. Methods that check ADMIN_WRITE permissions generate logs categorized as Admin Activity audit logs.

Permission type	Methods
ADMIN_READ	google.longrunning.Operations.GetOperation
DATA_READ	google.cloud.datacatalog.lineage.v1.Lineage.BatchSearchLinkProcesses google.cloud.datacatalog.lineage.v1.Lineage.GetLineageEvent google.cloud.datacatalog.lineage.v1.Lineage.GetProcess google.cloud.datacatalog.lineage.v1.Lineage.GetRun google.cloud.datacatalog.lineage.v1.Lineage.ListLineageEvents google.cloud.datacatalog.lineage.v1.Lineage.ListProcesses google.cloud.datacatalog.lineage.v1.Lineage.ListRuns google.cloud.datacatalog.lineage.v1.Lineage.SearchLinks
DATA_WRITE	google.cloud.datacatalog.lineage.v1.Lineage.CreateLineageEvent google.cloud.datacatalog.lineage.v1.Lineage.CreateProcess google.cloud.datacatalog.lineage.v1.Lineage.CreateRun google.cloud.datacatalog.lineage.v1.Lineage.DeleteLineageEvent google.cloud.datacatalog.lineage.v1.Lineage.DeleteProcess google.cloud.datacatalog.lineage.v1.Lineage.DeleteRun google.cloud.datacatalog.lineage.v1.Lineage.ProcessOpenLineageRunEvent google.cloud.datacatalog.lineage.v1.Lineage.UpdateProcess google.cloud.datacatalog.lineage.v1.Lineage.UpdateRun

Audit logs for each API interface

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

google.cloud.datacatalog.lineage.v1.Lineage

The following section contains details about audit logs associated with methods belonging to google.cloud.datacatalog.lineage.v1.Lineage.

BatchSearchLinkProcesses

• Method: google.cloud.datacatalog.lineage.v1.Lineage.BatchSearchLinkProcesses
  
• Audit log type: Data access
  
• Permissions:
  • datalineage.locations.searchLinks - DATA_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.lineage.v1.Lineage.BatchSearchLinkProcesses"
  

CreateLineageEvent

• Method: google.cloud.datacatalog.lineage.v1.Lineage.CreateLineageEvent
  
• Audit log type: Data access
  
• Permissions:
  • datalineage.events.create - DATA_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.lineage.v1.Lineage.CreateLineageEvent"
  

CreateProcess

• Method: google.cloud.datacatalog.lineage.v1.Lineage.CreateProcess
  
• Audit log type: Data access
  
• Permissions:
  • datalineage.processes.create - DATA_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.lineage.v1.Lineage.CreateProcess"
  

CreateRun

• Method: google.cloud.datacatalog.lineage.v1.Lineage.CreateRun
  
• Audit log type: Data access
  
• Permissions:
  • datalineage.runs.create - DATA_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.lineage.v1.Lineage.CreateRun"
  

DeleteLineageEvent

• Method: google.cloud.datacatalog.lineage.v1.Lineage.DeleteLineageEvent
  
• Audit log type: Data access
  
• Permissions:
  • datalineage.events.delete - DATA_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.lineage.v1.Lineage.DeleteLineageEvent"
  

DeleteProcess

• Method: google.cloud.datacatalog.lineage.v1.Lineage.DeleteProcess
  
• Audit log type: Data access
  
• Permissions:
  • datalineage.processes.delete - DATA_WRITE
• Method is a long-running or streaming operation: Long-running operation
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.lineage.v1.Lineage.DeleteProcess"
  

DeleteRun

• Method: google.cloud.datacatalog.lineage.v1.Lineage.DeleteRun
  
• Audit log type: Data access
  
• Permissions:
  • datalineage.runs.delete - DATA_WRITE
• Method is a long-running or streaming operation: Long-running operation
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.lineage.v1.Lineage.DeleteRun"
  

GetLineageEvent

• Method: google.cloud.datacatalog.lineage.v1.Lineage.GetLineageEvent
  
• Audit log type: Data access
  
• Permissions:
  • datalineage.events.get - DATA_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.lineage.v1.Lineage.GetLineageEvent"
  

GetProcess

• Method: google.cloud.datacatalog.lineage.v1.Lineage.GetProcess
  
• Audit log type: Data access
  
• Permissions:
  • datalineage.processes.get - DATA_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.lineage.v1.Lineage.GetProcess"
  

GetRun

• Method: google.cloud.datacatalog.lineage.v1.Lineage.GetRun
  
• Audit log type: Data access
  
• Permissions:
  • datalineage.runs.get - DATA_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.lineage.v1.Lineage.GetRun"
  

ListLineageEvents

• Method: google.cloud.datacatalog.lineage.v1.Lineage.ListLineageEvents
  
• Audit log type: Data access
  
• Permissions:
  • datalineage.events.list - DATA_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.lineage.v1.Lineage.ListLineageEvents"
  

ListProcesses

• Method: google.cloud.datacatalog.lineage.v1.Lineage.ListProcesses
  
• Audit log type: Data access
  
• Permissions:
  • datalineage.processes.list - DATA_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.lineage.v1.Lineage.ListProcesses"
  

ListRuns

• Method: google.cloud.datacatalog.lineage.v1.Lineage.ListRuns
  
• Audit log type: Data access
  
• Permissions:
  • datalineage.runs.list - DATA_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.lineage.v1.Lineage.ListRuns"
  

ProcessOpenLineageRunEvent

• Method: google.cloud.datacatalog.lineage.v1.Lineage.ProcessOpenLineageRunEvent
  
• Audit log type: Data access
  
• Permissions:
  • datalineage.locations.processOpenLineageMessage - DATA_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.lineage.v1.Lineage.ProcessOpenLineageRunEvent"
  

SearchLinks

• Method: google.cloud.datacatalog.lineage.v1.Lineage.SearchLinks
  
• Audit log type: Data access
  
• Permissions:
  • datalineage.locations.searchLinks - DATA_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.lineage.v1.Lineage.SearchLinks"
  

UpdateProcess

• Method: google.cloud.datacatalog.lineage.v1.Lineage.UpdateProcess
  
• Audit log type: Data access
  
• Permissions:
  • datalineage.processes.update - DATA_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.lineage.v1.Lineage.UpdateProcess"
  

UpdateRun

• Method: google.cloud.datacatalog.lineage.v1.Lineage.UpdateRun
  
• Audit log type: Data access
  
• Permissions:
  • datalineage.runs.update - DATA_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.lineage.v1.Lineage.UpdateRun"
  

google.longrunning.Operations

The following section contains details about audit logs associated with methods belonging to google.longrunning.Operations.

GetOperation

• Method: google.longrunning.Operations.GetOperation
  
• Audit log type: Data access
  
• Permissions:
  • datalineage.operations.get - ADMIN_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.longrunning.Operations.GetOperation"
  

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.longrunning.Operations.CancelOperation
• google.longrunning.Operations.DeleteOperation
• google.longrunning.Operations.ListOperations
• google.longrunning.Operations.WaitOperation