Skip to content

Alias task_display_name for EventLogResponse #55160

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+32 −0
Open

Alias task_display_name for EventLogResponse #55160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b84a8ad
Alias `task_display_name` for `event_logs`
guan404ming Sep 2, 2025
3c90f03
Remove lazy loading from task_instance relationship in Log model
guan404ming Sep 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions airflow-core/src/airflow/api_fastapi/core_api/datamodels/event_logs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ class EventLogResponse(BaseModel):
dag_display_name: str | None = Field(
validation_alias=AliasPath("dag_model", "dag_display_name"), default=None
)
task_display_name: str | None = Field(
validation_alias=AliasPath("task_instance", "task_display_name"), default=None
)


class EventLogCollectionResponse(BaseModel):
Expand Down
5 changes: 5 additions & 0 deletions airflow-core/src/airflow/api_fastapi/core_api/openapi/v2-rest-api-generated.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10660,6 +10660,11 @@ components:
- type: string
- type: 'null'
title: Dag Display Name
task_display_name:
anyOf:
- type: string
- type: 'null'
title: Task Display Name
type: object
required:
- event_log_id
Expand Down
7 changes: 7 additions & 0 deletions airflow-core/src/airflow/models/log.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,13 @@ class Log(Base):
primaryjoin="Log.dag_id == DagModel.dag_id",
)

task_instance = relationship(
"TaskInstance",
viewonly=True,
foreign_keys=[task_id],
primaryjoin="Log.task_id == TaskInstance.task_id",
)

__table_args__ = (
Index("idx_log_dttm", dttm),
Index("idx_log_event", event),
Expand Down
11 changes: 11 additions & 0 deletions airflow-core/src/airflow/ui/openapi-gen/requests/schemas.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3341,6 +3341,17 @@ export const $EventLogResponse = {
}
],
title: 'Dag Display Name'
},
task_display_name: {
anyOf: [
{
type: 'string'
},
{
type: 'null'
}
],
title: 'Task Display Name'
}
},
type: 'object',
Expand Down
1 change: 1 addition & 0 deletions airflow-core/src/airflow/ui/openapi-gen/requests/types.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -871,6 +871,7 @@ export type EventLogResponse = {
owner: string | null;
extra: string | null;
dag_display_name?: string | null;
task_display_name?: string | null;
};

/**
Expand Down
4 changes: 4 additions & 0 deletions airflow-core/tests/unit/api_fastapi/core_api/routes/public/test_event_logs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
DAG_DISPLAY_NAME = "TEST_DAG_ID"
DAG_RUN_ID = "TEST_DAG_RUN_ID"
TASK_ID = "TEST_TASK_ID"
TASK_DISPLAY_NAME = "TEST_TASK_ID"
DAG_EXECUTION_DATE = datetime(2024, 6, 15, 0, 0, tzinfo=timezone.utc)
OWNER = "TEST_OWNER"
OWNER_DISPLAY_NAME = "Test Owner"
Expand Down Expand Up @@ -135,6 +136,7 @@ class TestGetEventLog(TestEventLogsEndpoint):
"owner": OWNER_AIRFLOW,
"run_id": DAG_RUN_ID,
"task_id": TASK_ID,
"task_display_name": TASK_DISPLAY_NAME,
},
),
(
Expand All @@ -148,6 +150,7 @@ class TestGetEventLog(TestEventLogsEndpoint):
"owner": OWNER,
"run_id": DAG_RUN_ID,
"task_id": TASK_ID,
"task_display_name": TASK_DISPLAY_NAME,
"try_number": 0,
},
),
Expand All @@ -168,6 +171,7 @@ def test_get_event_log(self, test_client, setup, event_log_key, expected_status_
"dag_display_name": expected_body.get("dag_display_name"),
"dag_id": expected_body.get("dag_id"),
"task_id": expected_body.get("task_id"),
"task_display_name": expected_body.get("task_display_name"),
"run_id": expected_body.get("run_id"),
"map_index": event_log.map_index,
"try_number": event_log.try_number,
Expand Down
1 change: 1 addition & 0 deletions airflow-ctl/src/airflowctl/api/datamodels/generated.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,7 @@ class EventLogResponse(BaseModel):
owner: Annotated[str | None, Field(title="Owner")] = None
extra: Annotated[str | None, Field(title="Extra")] = None
dag_display_name: Annotated[str | None, Field(title="Dag Display Name")] = None
task_display_name: Annotated[str | None, Field(title="Task Display Name")] = None


class ExternalLogUrlResponse(BaseModel):
Expand Down