Skip to content

[FLINK-38897][Runtime/REST] Introduce the /jobs/:jobid/rescales/config endpoint in the REST API #27580

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
Open
RocMarshal wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[FLINK-38897][Runtime/REST] Introduce the /jobs/:jobid/rescales/config endpoint in the REST API #27580

RocMarshal wants to merge 1 commit into from
+671 −11

Conversation

@RocMarshal
Copy link
Contributor

@RocMarshal RocMarshal commented Feb 11, 2026 •
edited
Loading

What is the purpose of the change

  • [FLINK-38897][Runtime/REST] Introduce the /jobs/:jobid/rescales/config endpoint in the REST API
  • The pr is not blocked by FLIP-495 completion and is independent sub-task in FLIP-487.

Brief change log

  • [FLINK-38897][Runtime/REST] Introduce the /jobs/:jobid/rescales/config endpoint in the REST API
  • Done the related adaption logic and added test cases.

Verifying this change

This change added tests and can be verified as follows:

  • org.apache.flink.runtime.rest.handler.job.rescales.JobRescaleConfigHandlerTest

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): (yes / no)
  • The public API, i.e., is any changed class annotated with @Public(Evolving): (yes / no)
  • The serializers: (yes / no / don't know)
  • The runtime per-record code paths (performance sensitive): (yes / no / don't know)
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: (yes / no / don't know)
  • The S3 file system connector: (yes / no / don't know)

Documentation

  • Does this pull request introduce a minor new feature? (yes / no)
  • If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)

@flinkbot
Copy link
Collaborator

flinkbot commented Feb 11, 2026 •
edited
Loading

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

featzhang
featzhang reviewed Feb 12, 2026
View reviewed changes
flink-runtime-web/src/test/resources/rest_api_v1.snapshot Outdated
},
"response" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ThreadDumpInfo",
Copy link
Member

@featzhang featzhang Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:rescales:JobRescaleConfigInfo",

Copy link
Contributor Author

@RocMarshal RocMarshal Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch!

flink-runtime/src/main/java/org/apache/flink/runtime/executiongraph/AccessExecutionGraph.java Outdated

/***
* Get the rescale related configuration when using {@link org.apache.flink.runtime.scheduler.adaptive.AdaptiveScheduler}.
* @return The rescale related configuration.
Copy link
Member

@featzhang featzhang Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The method is marked as @nullable, but the contract does not clearly specify:

Under which scheduler modes this may return null

Whether REST handlers properly guard against null

This makes the API semantics unclear for callers:

Returns null if the scheduler is not AdaptiveScheduler.

docs/static/generated/rest_v1_dispatcher.yml
SchedulerExecutionMode:
type: string
enum:
- REACTIVE
Copy link
Member

@featzhang featzhang Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The enum currently contains only REACTIVE.

If future scheduler modes are added (e.g., ADAPTIVE_BATCH), this may create REST compatibility constraints.

Please confirm whether this enum is intended to be strictly single-valued or extensible.

Copy link
Contributor Author

@RocMarshal RocMarshal Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image

Thanks for the reminder.
There is only one enum value now.

RocMarshal
RocMarshal commented Feb 12, 2026
View reviewed changes
Copy link
Contributor Author

@RocMarshal RocMarshal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @featzhang for the review. 👍
Updated.

flink-runtime-web/src/test/resources/rest_api_v1.snapshot Outdated
},
"response" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ThreadDumpInfo",
Copy link
Contributor Author

@RocMarshal RocMarshal Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch!

docs/static/generated/rest_v1_dispatcher.yml
SchedulerExecutionMode:
type: string
enum:
- REACTIVE
Copy link
Contributor Author

@RocMarshal RocMarshal Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image

Thanks for the reminder.
There is only one enum value now.

@github-actions github-actions bot added the community-reviewed PR has been reviewed by the community. label Feb 12, 2026
RocMarshal
RocMarshal commented Feb 12, 2026
View reviewed changes
flink-runtime/src/main/java/org/apache/flink/runtime/executiongraph/DefaultExecutionGraph.java
* When the scheduler of the job is not {@link
* org.apache.flink.runtime.scheduler.adaptive.AdaptiveScheduler}, the value will be null.
*/
@Nullable private final JobRescaleConfigInfo jobRescaleConfigInfo;
Copy link
Contributor Author

@RocMarshal RocMarshal Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, @davidradl

@featzhang proposed a suggestion regarding where the newly added information should be stored:
#27544 (review)

It might be better to discuss it together there.

I’ve briefly looked into it. If we can reach a consensus on that suggestion, moving the newly added information into the ExecutionGraphInfo class so as to decouple JobRescaleConfigInfo from ExecutionGraph would also be a good option.

WDYTA ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@featzhang featzhang featzhang approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

community-reviewed PR has been reviewed by the community.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@RocMarshal @flinkbot @featzhang