Skip to content

Docs: clarify G1ConcurrentStringDeduplication units #580

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
Hashim Khan (Hashim1999164) wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs: clarify G1ConcurrentStringDeduplication units #580

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 19 additions & 2 deletions api/src/main/java/com/microsoft/gctoolkit/event/g1gc/G1ConcurrentStringDeduplication.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,25 @@
import com.microsoft.gctoolkit.time.DateTimeStamp;

/**
* 2015-10-17T21:10:23.673-0400: 3993.137: [GC concurrent-string-deduplication, 79.3K->792.0B(78.6K), avg 96.2%, 0.0024351 secs]
* Concurrent string deduplication statistics from a G1 GC log line such as:
* {@code 2015-10-17T21:10:23.673-0400: 3993.137: [GC concurrent-string-deduplication, 79.3K->792.0B(78.6K), avg 96.2%, 0.0024351 secs]}
*
* <p>String volume fields ({@link #getStartingStringVolume()}, {@link #getEndingStringVolume()}, and
* {@link #getReduction()}) are expressed in kilobytes (KiB), matching the parser's conversion of
* log sizes such as {@code B}, {@code K}, {@code M}, and {@code G} into K units.
*
* <p>{@link #getPercentReduction()} is the average reduction percentage from the log (for example,
* {@code avg 96.2%} is represented as {@code 96.2}, not {@code 0.962}).
*/

public class G1ConcurrentStringDeduplication extends G1GCConcurrentEvent {

/** Occupied string table size before deduplication, in kilobytes. */
private double startingStringVolume;
/** Occupied string table size after deduplication, in kilobytes. */
private double endingStringVolume;
/** Size removed by deduplication, in kilobytes. */
private double reduction;
/** Average reduction percentage where {@code 100.0} means 100%. */
private double percentReduction;

public G1ConcurrentStringDeduplication(DateTimeStamp timeStamp, double startingStringVolume, double endingStringVolume, double reduction, double percentReduction, double duration) {
Expand All @@ -29,18 +40,24 @@ public G1ConcurrentStringDeduplication(DateTimeStamp timeStamp, GCCause cause, d
this.percentReduction = percentReduction;
}

/** @return occupied string table size before deduplication, in kilobytes */
public double getStartingStringVolume() {
return startingStringVolume;
}

/** @return occupied string table size after deduplication, in kilobytes */
public double getEndingStringVolume() {
return endingStringVolume;
}

/** @return size removed by deduplication, in kilobytes */
public double getReduction() {
return reduction;
}

/**
* @return average reduction percentage where {@code 100.0} means 100%
*/
public double getPercentReduction() {
return percentReduction;
}
Expand Down