[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add custom metadata to Tasks in Graph View #27795

Open
1 of 2 tasks
matthewblock opened this issue Nov 19, 2022 · 7 comments
Open
1 of 2 tasks

Add custom metadata to Tasks in Graph View #27795

matthewblock opened this issue Nov 19, 2022 · 7 comments
Assignees
@amoghrajesh
Labels
area:UI Related to UI/UX. For Frontend Developers. good first issue kind:feature Feature Requests

Comments

@matthewblock
Copy link
matthewblock commented Nov 19, 2022 •
edited
Loading

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
image

There is no DAG run
image

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

image

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
@matthewblock matthewblock added the kind:feature Feature Requests label Nov 19, 2022
@tirkarthi
Copy link
Contributor

Is this similar to #26457 ?

@matthewblock
Copy link
Author
matthewblock commented Nov 21, 2022 •
edited
Loading

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 uranusjr added the area:UI Related to UI/UX. For Frontend Developers. label Nov 21, 2022
@uranusjr
Copy link
Member

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
Copy link
Author
matthewblock commented Nov 21, 2022 •
edited
Loading

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
Copy link
Member

That makes sense, thanks for the clarification.

@amoghrajesh
Copy link
Contributor

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

@uranusjr
Copy link
Member
uranusjr commented Dec 13, 2022 •
edited
Loading

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.

@amoghrajesh amoghrajesh mentioned this issue Jun 26, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@amoghrajesh amoghrajesh

Labels
area:UI Related to UI/UX. For Frontend Developers. good first issue kind:feature Feature Requests
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add custom metadata to Tasks in Graph View amoghrajesh/airflow
5 participants
@potiuk @uranusjr @tirkarthi @matthewblock @amoghrajesh