Source code for airflow.providers.openlineage.utils.spark
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
from __future__ import annotations
import logging
from typing import TYPE_CHECKING
from airflow.providers.openlineage.plugins.listener import get_openlineage_listener
from airflow.providers.openlineage.plugins.macros import (
lineage_job_name,
lineage_job_namespace,
lineage_root_job_name,
lineage_root_run_id,
lineage_run_id,
)
if TYPE_CHECKING:
from airflow.providers.common.compat.sdk import Context
def _get_parent_job_information_as_spark_properties(context: Context) -> dict:
"""
Retrieve parent job information as Spark properties.
Args:
context: The context containing task instance information.
Returns:
Spark properties with the parent job information.
"""
ti = context["ti"]
return {
"spark.openlineage.parentJobNamespace": lineage_job_namespace(),
"spark.openlineage.parentJobName": lineage_job_name(ti), # type: ignore[arg-type]
"spark.openlineage.parentRunId": lineage_run_id(ti), # type: ignore[arg-type]
"spark.openlineage.rootParentRunId": lineage_root_run_id(ti), # type: ignore[arg-type]
"spark.openlineage.rootParentJobName": lineage_root_job_name(ti), # type: ignore[arg-type]
"spark.openlineage.rootParentJobNamespace": lineage_job_namespace(),
}
def _get_transport_information_as_spark_properties() -> dict:
"""Retrieve transport information as Spark properties."""
def _get_transport_information(tp) -> dict:
properties = {
"type": tp.kind,
"url": tp.url,
"endpoint": tp.endpoint,
"timeoutInMillis": str(
int(tp.timeout) * 1000 # convert to milliseconds, as required by Spark integration
),
}
if hasattr(tp, "compression") and tp.compression:
properties["compression"] = str(tp.compression)
if hasattr(tp.config.auth, "api_key") and tp.config.auth.get_bearer():
properties["auth.type"] = "api_key"
properties["auth.apiKey"] = tp.config.auth.get_bearer()
if hasattr(tp.config, "custom_headers") and tp.config.custom_headers:
for key, value in tp.config.custom_headers.items():
properties[f"headers.{key}"] = value
return properties
def _format_transport(props: dict, transport: dict, name: str | None):
for key, value in transport.items():
if name:
props[f"spark.openlineage.transport.transports.{name}.{key}"] = value
else:
props[f"spark.openlineage.transport.{key}"] = value
return props
transport = get_openlineage_listener().adapter.get_or_create_openlineage_client().transport
if transport.kind == "composite":
http_transports = {}
for nested_transport in transport.transports:
if nested_transport.kind == "http":
http_transports[nested_transport.name] = _get_transport_information(nested_transport)
else:
name = nested_transport.name if hasattr(nested_transport, "name") else "no-name"
log.info(
"OpenLineage transport type `%s` with name `%s` is not supported in composite transport.",
nested_transport.kind,
name,
)
if len(http_transports) == 0:
log.warning(
"OpenLineage transport type `composite` does not contain http transport. Skipping "
"injection of OpenLineage transport information into Spark properties.",
)
return {}
props = {
"spark.openlineage.transport.type": "composite",
"spark.openlineage.transport.continueOnFailure": str(transport.config.continue_on_failure),
}
for name, http_transport in http_transports.items():
props = _format_transport(props, http_transport, name)
return props
if transport.kind == "http":
return _format_transport({}, _get_transport_information(transport), None)
log.info(
"OpenLineage transport type `%s` does not support automatic "
"injection of OpenLineage transport information into Spark properties.",
transport.kind,
)
return {}
def _is_parent_job_information_present_in_spark_properties(properties: dict) -> bool:
"""
Check if any parent job information is present in Spark properties.
Args:
properties: Spark properties.
Returns:
True if parent job information is present, False otherwise.
"""
return any(str(key).startswith("spark.openlineage.parent") for key in properties)
def _is_transport_information_present_in_spark_properties(properties: dict) -> bool:
"""
Check if any transport information is present in Spark properties.
Args:
properties: Spark properties.
Returns:
True if transport information is present, False otherwise.
"""
return any(str(key).startswith("spark.openlineage.transport") for key in properties)
[docs]
def inject_parent_job_information_into_spark_properties(properties: dict, context: Context) -> dict:
"""
Inject parent job information into Spark properties if not already present.
Args:
properties: Spark properties.
context: The context containing task instance information.
Returns:
Modified Spark properties with OpenLineage parent job information properties injected, if applicable.
"""
if _is_parent_job_information_present_in_spark_properties(properties):
log.info(
"Some OpenLineage properties with parent job information are already present "
"in Spark properties. Skipping the injection of OpenLineage "
"parent job information into Spark properties."
)
return properties
return {**properties, **_get_parent_job_information_as_spark_properties(context)}
[docs]
def inject_transport_information_into_spark_properties(properties: dict, context: Context) -> dict:
"""
Inject transport information into Spark properties if not already present.
Args:
properties: Spark properties.
context: The context containing task instance information.
Returns:
Modified Spark properties with OpenLineage transport information properties injected, if applicable.
"""
if _is_transport_information_present_in_spark_properties(properties):
log.info(
"Some OpenLineage properties with transport information are already present "
"in Spark properties. Skipping the injection of OpenLineage "
"transport information into Spark properties."
)
return properties
return {**properties, **_get_transport_information_as_spark_properties()}
[docs]
def inject_parent_job_information_into_glue_arguments(script_args: dict, context: Context) -> dict:
"""
Inject parent job information into Glue job arguments if not already present.
Glue jobs pass Spark properties via the ``--conf`` key in the script_args dict.
Multiple Spark conf properties are combined into the ``--conf`` key value with
``' --conf '`` as separator between each property assignment.
Args:
script_args: Glue job script arguments dict (maps to boto3 ``Arguments``).
context: The context containing task instance information.
Returns:
Modified script_args dict with OpenLineage parent job information injected, if applicable.
"""
existing_conf = script_args.get("--conf", "")
if "spark.openlineage.parent" in existing_conf:
log.info(
"Some OpenLineage properties with parent job information are already present "
"in Glue job arguments. Skipping the injection of OpenLineage "
"parent job information into Glue job arguments."
)
return script_args
parent_props = _get_parent_job_information_as_spark_properties(context)
if not parent_props:
return script_args
new_conf_parts = " --conf ".join(f"{k}={v}" for k, v in parent_props.items())
combined_conf = f"{existing_conf} --conf {new_conf_parts}" if existing_conf else new_conf_parts
return {**script_args, "--conf": combined_conf}
[docs]
def inject_transport_information_into_glue_arguments(script_args: dict, context: Context) -> dict:
"""
Inject transport information into Glue job arguments if not already present.
Glue jobs pass Spark properties via the ``--conf`` key in the script_args dict.
Multiple Spark conf properties are combined into the ``--conf`` key value with
``' --conf '`` as separator between each property assignment.
Args:
script_args: Glue job script arguments dict (maps to boto3 ``Arguments``).
context: The context containing task instance information.
Returns:
Modified script_args dict with OpenLineage transport information injected, if applicable.
"""
existing_conf = script_args.get("--conf", "")
if "spark.openlineage.transport" in existing_conf:
log.info(
"Some OpenLineage properties with transport information are already present "
"in Glue job arguments. Skipping the injection of OpenLineage "
"transport information into Glue job arguments."
)
return script_args
transport_props = _get_transport_information_as_spark_properties()
if not transport_props:
return script_args
new_conf_parts = " --conf ".join(f"{k}={v}" for k, v in transport_props.items())
combined_conf = f"{existing_conf} --conf {new_conf_parts}" if existing_conf else new_conf_parts
return {**script_args, "--conf": combined_conf}