[FLINK-37522][docs] Add description for the config about file system connection limit #26326
+29
−11
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
davidradl
reviewed
Mar 20, 2025
| .withDescription( | ||
| "The connection limit for the file system " | ||
| + scheme | ||
| + ". The valid value must >= -1. Values of -1 or 0 will be ignored."); |
There was a problem hiding this comment.
nits:
- will be ignored -> mean there is no connection limit
- could you add the documentation for this option with the same description please.
- I think the description should describe or point to what the scheme is.
|
ping @StephanEwen cc @1996fanrui @davidradl @nilmadhab |
davidradl
reviewed
Mar 21, 2025
| fs.<scheme>.limit.total: (number, 0/-1 mean no limit) | ||
| fs.<scheme>.limit.input: (number, 0/-1 mean no limit) | ||
| fs.<scheme>.limit.output: (number, 0/-1 mean no limit) | ||
| fs.<scheme>.limit.total: (number, 0/-1 mean there is no connection limit) |
davidradl
reviewed
Mar 21, 2025
| } | ||
|
|
||
| /** | ||
| * The total number of input connections that a file system for the given scheme may open. | ||
| * Unlimited be default. | ||
| */ | ||
| public static ConfigOption<Integer> fileSystemConnectionLimitIn(String scheme) { | ||
| return ConfigOptions.key("fs." + scheme + ".limit.input").intType().defaultValue(-1); | ||
| return ConfigOptions.key("fs." + scheme + ".limit.input") |
There was a problem hiding this comment.
nit: as the 3 configurations only differ with the key and first word(s) of the description, could we define a method with the common code. Maybe a common method with connectionLimitType.
send in "total" "input" or "output" as connectionLimitType
key would have
.limit. + connectionLimitType
and the description could start
"The " + connectionLimitType + " connection limit ....
WDYT?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the purpose of the change
This PR aims to add description for the config about file system connection limit.
These descriptions refer to
flink/flink-core/src/main/java/org/apache/flink/core/fs/LimitedConnectionsFileSystem.java
Line 1053 in 1d44789
Brief change log
Add description for the config about file system connection limit
Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
Does this pull request potentially affect one of the following parts:
@Public(Evolving): (no)Documentation