forked from datahub-project/datahub
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(ingest): add options for Airflow lineage backend (datahub-projec…
- Loading branch information
Showing
8 changed files
with
291 additions
and
192 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
183 changes: 183 additions & 0 deletions
183
metadata-ingestion/src/datahub_provider/_lineage_core.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,183 @@ | ||
| import json | ||
| from typing import TYPE_CHECKING, Dict, List | ||
|
|
||
| import dateutil.parser | ||
| from airflow.configuration import conf | ||
|
|
||
| import datahub.emitter.mce_builder as builder | ||
| import datahub.metadata.schema_classes as models | ||
| from datahub.configuration.common import ConfigModel | ||
| from datahub_provider.entities import _Entity | ||
|
|
||
| if TYPE_CHECKING: | ||
| from airflow import DAG | ||
| from airflow.models.baseoperator import BaseOperator | ||
|
|
||
| from datahub_provider.hooks.datahub import DatahubGenericHook | ||
|
|
||
|
|
||
| def _entities_to_urn_list(iolets: List[_Entity]) -> List[str]: | ||
| return [let.urn for let in iolets] | ||
|
|
||
|
|
||
| class DatahubBasicLineageConfig(ConfigModel): | ||
| # DataHub hook connection ID. | ||
| datahub_conn_id: str | ||
|
|
||
| # If true, the owners field of the DAG will be capture as a DataHub corpuser. | ||
| capture_ownership_info: bool = True | ||
|
|
||
| # If true, the tags field of the DAG will be captured as DataHub tags. | ||
| capture_tags_info: bool = True | ||
|
|
||
| def make_emitter_hook(self) -> "DatahubGenericHook": | ||
| # This is necessary to avoid issues with circular imports. | ||
| from datahub_provider.hooks.datahub import DatahubGenericHook | ||
|
|
||
| return DatahubGenericHook(self.datahub_conn_id) | ||
|
|
||
|
|
||
| def send_lineage_to_datahub( | ||
| config: DatahubBasicLineageConfig, | ||
| operator: "BaseOperator", | ||
| inlets: List[_Entity], | ||
| outlets: List[_Entity], | ||
| context: Dict, | ||
| ) -> None: | ||
| # This is necessary to avoid issues with circular imports. | ||
| from airflow.serialization.serialized_objects import ( | ||
| SerializedBaseOperator, | ||
| SerializedDAG, | ||
| ) | ||
|
|
||
| dag: "DAG" = context["dag"] | ||
| task = context["task"] | ||
|
|
||
| # TODO: capture context | ||
| # context dag_run | ||
| # task_instance: "TaskInstance" = context["task_instance"] | ||
| # TODO: capture raw sql from db operators | ||
|
|
||
| flow_urn = builder.make_data_flow_urn("airflow", dag.dag_id) | ||
| job_urn = builder.make_data_job_urn_with_flow(flow_urn, task.task_id) | ||
|
|
||
| base_url = conf.get("webserver", "base_url") | ||
| flow_url = f"{base_url}/tree?dag_id={dag.dag_id}" | ||
| job_url = f"{base_url}/taskinstance/list/?flt1_dag_id_equals={dag.dag_id}&_flt_3_task_id={task.task_id}" | ||
| # operator.log.info(f"{flow_url=}") | ||
| # operator.log.info(f"{job_url=}") | ||
| # operator.log.info(f"{dag.get_serialized_fields()=}") | ||
| # operator.log.info(f"{task.get_serialized_fields()=}") | ||
| # operator.log.info(f"{SerializedDAG.serialize_dag(dag)=}") | ||
|
|
||
| flow_property_bag: Dict[str, str] = { | ||
| key: repr(value) for (key, value) in SerializedDAG.serialize_dag(dag).items() | ||
| } | ||
| for key in dag.get_serialized_fields(): | ||
| if key not in flow_property_bag: | ||
| flow_property_bag[key] = repr(getattr(dag, key)) | ||
| job_property_bag: Dict[str, str] = { | ||
| key: repr(value) | ||
| for (key, value) in SerializedBaseOperator.serialize_operator(task).items() | ||
| } | ||
| for key in task.get_serialized_fields(): | ||
| if key not in job_property_bag: | ||
| job_property_bag[key] = repr(getattr(task, key)) | ||
| # operator.log.info(f"{flow_property_bag=}") | ||
| # operator.log.info(f"{job_property_bag=}") | ||
|
|
||
| if config.capture_ownership_info: | ||
| timestamp = int(dateutil.parser.parse(context["ts"]).timestamp() * 1000) | ||
| ownership = models.OwnershipClass( | ||
| owners=[ | ||
| models.OwnerClass( | ||
| owner=builder.make_user_urn(dag.owner), | ||
| type=models.OwnershipTypeClass.DEVELOPER, | ||
| source=models.OwnershipSourceClass( | ||
| type=models.OwnershipSourceTypeClass.SERVICE, | ||
| url=dag.filepath, | ||
| ), | ||
| ) | ||
| ], | ||
| lastModified=models.AuditStampClass( | ||
| time=timestamp, actor=builder.make_user_urn("airflow") | ||
| ), | ||
| ) | ||
| # operator.log.info(f"{ownership=}") | ||
| ownership_aspect = [ownership] | ||
| else: | ||
| ownership_aspect = [] | ||
|
|
||
| if config.capture_tags_info: | ||
| tags = models.GlobalTagsClass( | ||
| tags=[ | ||
| models.TagAssociationClass(tag=builder.make_tag_urn(tag)) | ||
| for tag in (dag.tags or []) | ||
| ] | ||
| ) | ||
| # operator.log.info(f"{tags=}") | ||
| tags_aspect = [tags] | ||
| else: | ||
| tags_aspect = [] | ||
|
|
||
| flow_mce = models.MetadataChangeEventClass( | ||
| proposedSnapshot=models.DataFlowSnapshotClass( | ||
| urn=flow_urn, | ||
| aspects=[ | ||
| models.DataFlowInfoClass( | ||
| name=dag.dag_id, | ||
| description=f"{dag.description}\n\n{dag.doc_md or ''}", | ||
| customProperties=flow_property_bag, | ||
| externalUrl=flow_url, | ||
| ), | ||
| *ownership_aspect, | ||
| *tags_aspect, | ||
| ], | ||
| ) | ||
| ) | ||
|
|
||
| job_mce = models.MetadataChangeEventClass( | ||
| proposedSnapshot=models.DataJobSnapshotClass( | ||
| urn=job_urn, | ||
| aspects=[ | ||
| models.DataJobInfoClass( | ||
| name=task.task_id, | ||
| type=models.AzkabanJobTypeClass.COMMAND, | ||
| description=None, | ||
| customProperties=job_property_bag, | ||
| externalUrl=job_url, | ||
| ), | ||
| models.DataJobInputOutputClass( | ||
| inputDatasets=_entities_to_urn_list(inlets or []), | ||
| outputDatasets=_entities_to_urn_list(outlets or []), | ||
| ), | ||
| *ownership_aspect, | ||
| *tags_aspect, | ||
| ], | ||
| ) | ||
| ) | ||
|
|
||
| force_entity_materialization = [ | ||
| models.MetadataChangeEventClass( | ||
| proposedSnapshot=models.DatasetSnapshotClass( | ||
| urn=iolet, | ||
| aspects=[ | ||
| models.StatusClass(removed=False), | ||
| ], | ||
| ) | ||
| ) | ||
| for iolet in _entities_to_urn_list((inlets or []) + (outlets or [])) | ||
| ] | ||
|
|
||
| hook = config.make_emitter_hook() | ||
|
|
||
| mces = [ | ||
| flow_mce, | ||
| job_mce, | ||
| *force_entity_materialization, | ||
| ] | ||
| operator.log.info( | ||
| "DataHub lineage backend - emitting metadata:\n" | ||
| + "\n".join(json.dumps(mce.to_obj()) for mce in mces) | ||
| ) | ||
| hook.emit_mces(mces) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.