This page is meant as a template for writing a FLIP. To create a FLIP choose Tools->Copy on this page and modify with your content and replace the heading with the next FLIP number and a description of your issue. Replace anything in italics with your own description.
Page properties | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Document the state by adding a label to the FLIP page with one of "discussion", "accepted", "released", "rejected".
|
Please keep the discussion on the mailing list rather than commenting on the wiki (wiki discussions get unwieldy fast).
...
- Only hostname is provided to represent TaskManager location in some places (e.g. SubtaskCurrentAttemptDetailsHandler). However, in a containerized era, it is common to have multiple TMs on the same host, and port info is crucial to distinguish different TMs.
- Inconsistent naming of the field to represent TaskManager location: "host" is used in most places but "location" is also used in JobExceptions-related places.
- Inconsistent semantics of the "host" field: The semantics of the host field are inconsistent, sometimes it denotes hostname only while in other times it denotes hostname + port (which is also inconsistent with the name of "host"). To provide some examples:
Places | Semantics of the "host" field |
---|---|
SubtaskCurrentAttemptDetailsHandler | Hostname only |
JobVertexTaskManagersHandler | Hostname + port |
SubtasksTimesHandler | Hostname only |
As a result, users find it difficult to identify TM-related problems and confusing to deal with the inconsistent naming and semantics of the fields in REST API. Similar issues have been raised independently multiple times, trying to address it:
- [FLINK-24957] show `host:port` information in `subtasks` tab - ASF JIRA (apache.org)
- [FLINK-25371] Include data port as part of the host info for subtask detail panel on Web UI - ASF JIRA (apache.org)
- [FLINK-32984] Display the host port information on the suttasks page of SubtaskExecution - ASF JIRA (apache.org)
Public Interfaces
Briefly list any new interfaces that will be introduced as part of this proposal or any existing interfaces that will be removed or changed. The purpose of this section is to concisely call out the public contract that will come along with this feature.
Any handlers/interfaces in the entire REST API and Web UI that contains TaskManager location info.
- SubtasksAllAccumulatorsHandler
- SubtasksTimesHandler
- SubtaskCurrentAttemptDetailsHandler (corresponds to the subtasks details panel of a job vertex on UI)
JobVertexTaskManagersHandler (corresponds to theTaskManger details panel of a job vertex on UI)
- JobExceptionsHandler
Proposed Changes
Describe the new thing you want to do in appropriate detail. This may be fairly extensive and have large subsections of its own. Or it may be a few sentences. Use judgement based on the scope of the change.
- Use a field named "location" (already used in
JobExceptionsInfoWithHistory
) that represents TaskManager location Add a new string formatter methodgetEndpoint()
toTaskManagerLocation
andArchivedTaskManagerLocation
that prints in the form of "${hostname}:${port}" in a consistent mannerto align the string formatter used by REST API. - Use a field named "endpoint" that represents TaskManager endpoint (host + port) using the newly added string formatter method.
- Update the front-end to adopt the new location endpoint field.
- Rename the column name from "Host" to "LocationEndpoint" on the Web UI to reflect the change that both hostname and port are displayed.
- Keep the old "host" field untouched for compatibility. Notice that the info stored in the old "host" field is inconsistent, sometimes only host is stored, sometimes host + port is stored, we 'll leave them as they were with a few comments to keep being compatible.
Compatibility, Deprecation, and Migration Plan
...
The the old "host" fields in REST API is left untouched for compatibility, they will be marked as deprecated and can be removed in the next major version (2.0after being kept for at least 2 minot releases).
Test Plan
...
UTs and simple human-involved tests on UI should cover it well.
Rejected Alternatives
...
Not applicable.