Add custom metadata to Tasks in Graph View

[matthewblock]

Description

This feature would enable the user to add custom metadata that would be viewable within the tooltip upon hovering on a Task in Graph View.

Currently when the user hovers on a Task in Graph View, they can see the following:

There is a DAG run

There is no DAG run

TaskGroups allow the user to add custom information to the tooltip by providing it in the tooltip field on instantiation:

The information in the tooltip could be fully customizable, or scoped to a specific use case - for example, adding just the Dataset associated with a task.

Use case/motivation

General information about a task

TaskGroups allow the user to provide custom metadata about a task. This would be similarly useful for Tasks.

Sources and Targets

Tasks often have information like source and target. Airflow 2.4 introduced the concept of Datasets. In Dataset view, the user can see which tasks influence datasets. This information would also be useful in Graph View - on hover, the user could see the Dataset(s) specified to the Operator.

Related issues

AIP-34 added TaskGroup. Users can customize the information in a TaskGroup's tooltip.

AIP-34 implemented Issue #8078.

Are you willing to submit a PR?

• Yes I am willing to submit a PR!

Code of Conduct

• I agree to follow this project's Code of Conduct

[tirkarthi]

Is this similar to #26457 ?

[matthewblock]

Is this similar to #26457 ?

Similar but not the same - Thanks! I think #26457 is more for adding notes about a specific DAG run at the TaskInstance level, this is for adding information at the Task level, what would appear for all DAG runs.

[uranusjr]

could be fully customizable

Do you have thoughts in mind how this kind of information can be provided by the user? I persume this requires some sort of UI that allows you to modify things both before and after execution.

[matthewblock]

Do you have thoughts in mind how this kind of information can be provided by the user? I persume this requires some sort of UI that allows you to modify things both before and after execution.

I was thinking it would be not be editable through the UI, and it would be essentially the same as TaskGroup.tooltip, just a str provided in the TaskGroup constructor.

I guess the most similar implementation would be adding a tooltip arg to BaseOperator.

[uranusjr]

That makes sense, thanks for the clarification.

[amoghrajesh]

@potiuk @uranusjr is this issue taken up? I would like to understand this issue more and try to work on it if possible

[uranusjr]

Feel free to take it. essentially what’s requested here is we add a tooltip argument to BaseOperator, similar to the argument of the same name on TaskGroup, and display that in the UI.