[FLINK-15375][core] Improve MemorySize to print / parse with better readability. #10785

xintongsong · 2020-01-07T07:44:36Z

What is the purpose of the change

This PR improves readability and usability of MemorySize.

Brief change log

70b2119: Code clean-up in TaskExecutorResourceUtilsTest. Remove unnecessary usage of MemorySize#toString.
9245f66: Introduce MemorySize#toHumanReadableString
57539a3: Use MemorySize#toHumanReadableString for logs and error messages.
65aaf3d: Introduce factory method for creating MemorySize from mebibytes conveniently.

Verifying this change

Add cases in MemorySizeTest

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

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

Documentation

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

xintongsong · 2020-01-07T07:44:50Z

cc @azagrebin

flinkbot · 2020-01-07T07:46:40Z

Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.

Automated Checks

Last check on commit bfb11ff (Tue Jan 07 07:46:39 UTC 2020)

Warnings:

No documentation files were touched! Remember to keep the Flink docs up to date!

_{Mention the bot in a comment to re-run the automated checks.}

Review Progress

❓ 1. The [description] looks good.
❓ 2. There is [consensus] that the contribution should go into to Flink.
❓ 3. Needs [attention] from.
❓ 4. The change fits into the overall [architecture].
❓ 5. Overall code [quality] is good.

Please see the Pull Request Review Guide for a full explanation of the review process.

The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required

Bot commands

The @flinkbot bot supports the following commands:

@flinkbot approve description to approve one or more aspects (aspects: description, consensus, architecture and quality)
@flinkbot approve all to approve all aspects
@flinkbot approve-until architecture to approve everything until architecture
@flinkbot attention @username1 [@username2 ..] to require somebody's attention
@flinkbot disapprove architecture to remove an approval you gave earlier

flinkbot · 2020-01-07T08:14:32Z

CI report:

bfb11ff Travis: SUCCESS Azure: SUCCESS
65aaf3d Travis: SUCCESS Azure: SUCCESS
9ac1d96 Travis: SUCCESS Azure: SUCCESS
53d6a43 Travis: FAILURE Azure: SUCCESS

Bot commands

The @flinkbot bot supports the following commands:

@flinkbot run travis re-run the last Travis build
@flinkbot run azure re-run the last Azure build

xintongsong · 2020-01-17T08:08:33Z

@tillrohrmann The PR is ready for review. Could you take a look at your convenience?

tillrohrmann

Thanks a lot for updating this PR @xintongsong. The changes look good. The only question I had was whether the human readable string should have the format %.3f%s (%d bytes) instead of %.3f%s (%d). What do you think?

tillrohrmann · 2020-01-17T15:25:05Z

flink-core/src/main/java/org/apache/flink/configuration/MemorySize.java

+ .filter(idx -> bytes > ORDERED_UNITS.get(idx).getMultiplier())
+ .boxed()
+ .max(Comparator.naturalOrder())
+ .map(idx -> ORDERED_UNITS.get(idx))


nit: could be replaced with lambda method reference.

tillrohrmann · 2020-01-17T15:33:20Z

flink-core/src/main/java/org/apache/flink/configuration/MemorySize.java

+ } else {
+ double approximate = 1.0 * bytes / highestUnit.getMultiplier();
+ return String.format(
+ "%.3f%s (%d)",


Should we add %.3f%s (%d bytes)?

I thought people could easily understand that the value in the parentheses are they exact bytes. But true, it would be better to explicitly add the unit.

xintongsong · 2020-01-18T02:12:56Z

@tillrohrmann, thanks for the review. I've addressed your comments.

tillrohrmann · 2020-01-21T13:01:27Z

Thanks for addressing my comments @xintongsong. Merging this PR now.

…ing in logs and error messages. This include changes in: - ResourceSpec - ResourceProfile - TaskExecutorResourceSpec - TaskExecutorResourceUtils

…ebibytes. This closes apache#10785.

…ebibytes. This closes #10785.

…ebibytes. This closes apache#10785.

rmetzger added the review=description? label Jan 7, 2020

rmetzger added the component=Runtime/Configuration label Jan 7, 2020

zentol mentioned this pull request Jan 10, 2020

[FLINK-14853][docs] Use higher granularity units in generated docs for Duration & MemorySize if possible #10829

Closed

xintongsong force-pushed the FLINK-15375-print-parse-memory-size branch from bfb11ff to 65aaf3d Compare January 17, 2020 08:03

xintongsong requested a review from tillrohrmann January 17, 2020 08:07

tillrohrmann self-assigned this Jan 17, 2020

tillrohrmann approved these changes Jan 17, 2020

View reviewed changes

xintongsong force-pushed the FLINK-15375-print-parse-memory-size branch from 72f09ab to 9ac1d96 Compare January 18, 2020 02:11

xintongsong added 4 commits January 21, 2020 14:03

[hotfix] Clean up in TaskExecutorResourceUtilsTest.

857d6df

[FLINK-15375][core] Introduce MemorySize#toHumanReadableString.

e217620

[FLINK-15375][core][runtime] Print MemorySize with human readable str…

d7c592f

…ing in logs and error messages. This include changes in: - ResourceSpec - ResourceProfile - TaskExecutorResourceSpec - TaskExecutorResourceUtils

[FLINK-15375][core] Add factory method for creating MemorySize from m…

53d6a43

…ebibytes. This closes apache#10785.

tillrohrmann force-pushed the FLINK-15375-print-parse-memory-size branch from 9ac1d96 to 53d6a43 Compare January 21, 2020 13:05

tillrohrmann pushed a commit to tillrohrmann/flink that referenced this pull request Jan 21, 2020

[FLINK-15375][core] Add factory method for creating MemorySize from m…

2f7e7f2

…ebibytes. This closes apache#10785.

tillrohrmann closed this in 4f55895 Jan 21, 2020

tillrohrmann pushed a commit that referenced this pull request Jan 21, 2020

[FLINK-15375][core] Add factory method for creating MemorySize from m…

f64d343

…ebibytes. This closes #10785.

JTaky pushed a commit to JTaky/flink that referenced this pull request Feb 20, 2020

[FLINK-15375][core] Add factory method for creating MemorySize from m…

e88ec52

…ebibytes. This closes apache#10785.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FLINK-15375][core] Improve MemorySize to print / parse with better readability. #10785

[FLINK-15375][core] Improve MemorySize to print / parse with better readability. #10785

xintongsong commented Jan 7, 2020 •

edited

Loading

xintongsong commented Jan 7, 2020

flinkbot commented Jan 7, 2020

flinkbot commented Jan 7, 2020 •

edited

Loading

xintongsong commented Jan 17, 2020

tillrohrmann left a comment

tillrohrmann Jan 17, 2020

tillrohrmann Jan 17, 2020

xintongsong Jan 18, 2020

xintongsong commented Jan 18, 2020

tillrohrmann commented Jan 21, 2020

[FLINK-15375][core] Improve MemorySize to print / parse with better readability. #10785

[FLINK-15375][core] Improve MemorySize to print / parse with better readability. #10785

Conversation

xintongsong commented Jan 7, 2020 • edited Loading

What is the purpose of the change

Brief change log

Verifying this change

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

Documentation

xintongsong commented Jan 7, 2020

flinkbot commented Jan 7, 2020

Automated Checks

Review Progress

flinkbot commented Jan 7, 2020 • edited Loading

CI report:

xintongsong commented Jan 17, 2020

tillrohrmann left a comment

Choose a reason for hiding this comment

tillrohrmann Jan 17, 2020

Choose a reason for hiding this comment

tillrohrmann Jan 17, 2020

Choose a reason for hiding this comment

xintongsong Jan 18, 2020

Choose a reason for hiding this comment

xintongsong commented Jan 18, 2020

tillrohrmann commented Jan 21, 2020

xintongsong commented Jan 7, 2020 •

edited

Loading

flinkbot commented Jan 7, 2020 •

edited

Loading