Define an operator extra link¶

If you want to add further links to operators you can define them via a plugin or provider package. Extra links will be displayed in task details page in Grid view.

The following code shows how to add extra links to an operator via Plugins:

from airflow.models.baseoperator import BaseOperator
from airflow.models.baseoperatorlink import BaseOperatorLink
from airflow.models.taskinstancekey import TaskInstanceKey
from airflow.plugins_manager import AirflowPlugin


class GoogleLink(BaseOperatorLink):
    name = "Google"

    def get_link(self, operator: BaseOperator, *, ti_key: TaskInstanceKey):
        return "https://www.google.com"


class MyFirstOperator(BaseOperator):
    operator_extra_links = (GoogleLink(),)

    def __init__(self, **kwargs):
        super().__init__(**kwargs)

    def execute(self, context):
        self.log.info("Hello World!")


# Defining the plugin class
class AirflowExtraLinkPlugin(AirflowPlugin):
    name = "extra_link_plugin"
    operator_extra_links = [
        GoogleLink(),
    ]

Note

Operator Extra Links should be registered via Airflow Plugins or custom Airflow Provider to work.

You can also add a global operator extra link that will be available to all the operators through an Airflow plugin or through Airflow providers. You can learn more about it in the plugin interface and in Provider packages.

You can see all the extra links available via community-managed providers in Extra Links.

Add or override Links to Existing Operators¶

You can also add (or override) an extra link to an existing operators through an Airflow plugin or custom provider.

For example, the following Airflow plugin will add an Operator Link on all tasks using GCSToS3Operator operator.

Adding Operator Links to Existing Operators plugins/extra_link.py:

from airflow.models.baseoperator import BaseOperator
from airflow.models.baseoperatorlink import BaseOperatorLink
from airflow.models.taskinstancekey import TaskInstanceKey
from airflow.plugins_manager import AirflowPlugin
from airflow.providers.amazon.aws.transfers.gcs_to_s3 import GCSToS3Operator


class S3LogLink(BaseOperatorLink):
    name = "S3"

    # Add list of all the operators to which you want to add this OperatorLinks
    # Example: operators = [GCSToS3Operator, GCSToBigQueryOperator]
    operators = [GCSToS3Operator]

    def get_link(self, operator: BaseOperator, *, ti_key: TaskInstanceKey):
        # Invalid bucket name because upper case letters and underscores are used
        # This will not be a valid bucket in any region
        bucket_name = "Invalid_Bucket_Name"
        return "https://s3.amazonaws.com/airflow-logs/{bucket_name}/{dag_id}/{task_id}/{run_id}".format(
            bucket_name=bucket_name,
            dag_id=operator.dag_id,
            task_id=operator.task_id,
            run_id=ti_key.run_id,
        )


# Defining the plugin class
class AirflowExtraLinkPlugin(AirflowPlugin):
    name = "extra_link_plugin"
    operator_extra_links = [
        S3LogLink(),
    ]

Overriding Operator Links of Existing Operators:

It is also possible to replace a built in link on an operator via a Plugin. For example BigQueryExecuteQueryOperator includes a link to the Google Cloud Console, but if we wanted to change that link we could:

from airflow.models.baseoperator import BaseOperator
from airflow.models.baseoperatorlink import BaseOperatorLink
from airflow.models.taskinstancekey import TaskInstanceKey
from airflow.models.xcom import XCom
from airflow.plugins_manager import AirflowPlugin
from airflow.providers.google.cloud.operators.bigquery import BigQueryOperator

# Change from https to http just to display the override
BIGQUERY_JOB_DETAILS_LINK_FMT = "http://console.cloud.google.com/bigquery?j={job_id}"


class BigQueryDatasetLink(BaseGoogleLink):
    """
    Helper class for constructing BigQuery Dataset Link.
    """

    name = "BigQuery Dataset"
    key = "bigquery_dataset"
    format_str = BIGQUERY_DATASET_LINK

    @staticmethod
    def persist(
        context: Context,
        task_instance: BaseOperator,
        dataset_id: str,
        project_id: str,
    ):
        task_instance.xcom_push(
            context,
            key=BigQueryDatasetLink.key,
            value={"dataset_id": dataset_id, "project_id": project_id},
        )


# Defining the plugin class
class AirflowExtraLinkPlugin(AirflowPlugin):
    name = "extra_link_plugin"
    operator_extra_links = [
        BigQueryDatasetLink(),
    ]

Adding Operator Links via Providers

As explained in Provider packages, when you create your own Airflow Provider, you can specify the list of operators that provide extra link capability. This happens by including the operator class name in the provider-info information stored in your Provider’s package meta-data:

Example meta-data required in your provider-info dictionary (this is part of the meta-data returned by apache-airflow-providers-google provider currently:

extra-links:
  - airflow.providers.google.cloud.links.bigquery.BigQueryDatasetLink
  - airflow.providers.google.cloud.links.bigquery.BigQueryTableLink

You can include as many operators with extra links as you want.