與 OpenLineage 整合

本文說明如何將 OpenLineage 與 Knowledge Catalog (原稱 Dataplex Universal Catalog) 整合，以便從各種系統中查看歷程資料。

總覽

OpenLineage 是開放式平台，可收集及分析資料歷程資訊。OpenLineage 會使用開放式標準處理歷程資料，從資料管道元件擷取歷程事件，並使用 OpenLineage API 產生執行作業、工作和資料集的報表。

您可以透過 Data Lineage API 匯入 OpenLineage 事件，在 Knowledge Catalog 網頁介面中顯示，並與來自Google Cloud 服務 (例如 BigQuery、Managed Service for Apache Airflow、Cloud Data Fusion 和 Managed Service for Apache Spark) 的歷程資訊並列。

如要匯入使用 OpenLineage 規格的 OpenLineage 事件，請使用 ProcessOpenLineageRunEvent REST API 方法，並將 OpenLineage 層面對應至 Data Lineage API 屬性。

限制

  • Data Lineage API 支援 OpenLineage 主要版本 1。

  • Data Lineage API 端點 ProcessOpenLineageRunEvent 僅做為 OpenLineage 訊息的消費者，而非生產者。您可以透過這個 API，將任何符合 OpenLineage 規範的工具或系統所產生的沿襲資訊傳送至 Knowledge Catalog。部分 Google Cloud 服務 (例如 Managed Service for Apache Spark 和 Managed Airflow) 內建 OpenLineage producer，可將事件傳送至這個端點，自動擷取這些服務的歷程。

  • Data Lineage API 不支援下列項目：

    • 後續任何 OpenLineage 版本，只要訊息格式有變更
    • DatasetEvent
    • JobEvent

  • 單一訊息大小上限為 5 MB。

  • 輸入和輸出內容中每個完整名稱的長度上限為 4000 個字元。

  • 連結會依活動分組，每個活動最多可有 100 個連結。資料表層級連結的總數上限為 1000 個。如果郵件包含超過 1500 個資料欄層級的連結，系統會略過資料欄層級的資訊。

  • Knowledge Catalog 會顯示每個工作執行的沿襲圖表，其中包含沿襲事件的輸入和輸出內容。不支援 Spark 階段等較低層級的程序。

OpenLineage 對應

如要瞭解 OpenLineage 對應，請參閱「OpenLineage 對應」。

匯入 OpenLineage 事件

如果尚未設定 OpenLineage，請參閱「開始使用」。

如要將 OpenLineage 事件匯入 Knowledge Catalog，請呼叫 REST API 方法 ProcessOpenLineageRunEvent：

POST https://datalineage.googleapis.com/v1/projects/{project}/locations/{location}:processOpenLineageRunEvent \
--data '{"eventTime":"2023-04-04T13:21:16.098Z","eventType":"COMPLETE","inputs":[{"name":"somename","namespace":"somenamespace"}],"job":{"name":"somename","namespace":"somenamespace"},"outputs":[{"name":"somename","namespace":"somenamespace"}],"producer":"someproducer","run":{"runId":"somerunid"},"schemaURL":"https://openlineage.io/spec/1-0-5/OpenLineage.json#/$defs/RunEvent"}'

傳送 OpenLineage 訊息的工具

如要簡化將事件傳送至 Data Lineage API 的程序，可以使用各種工具和程式庫：

  • Google Cloud Java Producer 程式庫：Google 提供開放原始碼 Java 程式庫，協助建構 OpenLineage 事件並傳送至 Data Lineage API。詳情請參閱「資料歷程的 Producer Java 程式庫現已開放原始碼」網誌文章。您可以在 GitHub 和 Maven 取得這個程式庫。
  • OpenLineage GCP 傳輸：對於以 Java 為基礎的 OpenLineage 產生器，系統提供專用的 GcpLineage 傳輸。這項功能可減少將事件傳送至 Data Lineage API 時所需的程式碼，簡化與 Data Lineage API 的整合。GcpLineageTransport 可設定為任何現有 OpenLineage 生產者 (例如 Airflow、Spark 和 Flink) 的事件接收器。如需更多資訊和範例，請參閱 GcpLineage。

分析 OpenLineage 的資訊

如要分析匯入的 OpenLineage 事件，請參閱「在 Knowledge Catalog 使用者介面中查看歷程圖」。

儲存的資料量

Data Lineage API 不會儲存 OpenLineage 訊息中的所有構面資料。Data Lineage API 會儲存下列構面欄位：

  • spark_version
    • openlineage-spark-version
    • spark-version
  • 所有 spark.logicalPlan.*
  • environment-properties (自訂 Google Cloud 沿襲層面)
    • origin.sourcetype 和 origin.name
    • spark.app.id
    • spark.app.name
    • spark.batch.id
    • spark.batch.uuid
    • spark.cluster.name
    • spark.cluster.region
    • spark.job.id
    • spark.job.uuid
    • spark.project.id
    • spark.query.node.name
    • spark.session.id
    • spark.session.uuid

Data Lineage API 會儲存下列資訊：

  • eventTime
  • run.runId
  • job.namespace
  • job.name

後續步驟