HDDS-15077. Explain exclusiveSize and exclusiveSizeDeltaFromDirDeepCleaning#10544
Draft
jojochuang wants to merge 2 commits into
Draft
HDDS-15077. Explain exclusiveSize and exclusiveSizeDeltaFromDirDeepCleaning#10544jojochuang wants to merge 2 commits into
jojochuang wants to merge 2 commits into
Conversation
…eaning Change-Id: Ia27efffe27156997f82a4db99ed810efb6b7900f
…erencedReplicatedSize Change-Id: I5fa24e9eeec4d88b5da2629a1175883c330b1cc0
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 changes were proposed in this pull request?
HDDS-15077. Explain exclusiveSize and exclusiveSizeDeltaFromDirDeepCleaning
Please describe your PR in detail:
SnapshotInfo.java
Added comprehensive Javadocs to the metadata representation of Snapshots:
• Fields: Documented the purpose of all six space and replication size metrics:
• referencedSize & referencedReplicatedSize : Logical and replicated sizes of active bucket contents at snapshot creation time.
• exclusiveSize & exclusiveReplicatedSize : Exclusive sizes calculated by KeyDeletingService (key-level deep cleaning).
• exclusiveSizeDeltaFromDirDeepCleaning & exclusiveReplicatedSizeDeltaFromDirDeepCleaning : Exclusive size deltas discovered by
SnapshotDirectoryCleaningService (directory-level deep cleaning).
• Builder: Replaced terse parameter markers (e.g., /** @param ... */ ) with detailed descriptions explaining the calculations and units.
• Getters: Added descriptive method Javadocs for the respective getters.
──────
3. Documentation Changes
Snapshot.md
Added a new subsection under "System Architecture Deep Dive" titled "Snapshot Space & Size Tracking":
• Documented the definition of Referenced Size (logical and replicated).
• Explained the architecture of Exclusive Size Tracking and how it is split between the two independent background services ( KeyDeletingService and
SnapshotDirectoryCleaningService ) to prevent write overlaps and correctness bugs.
• Specified how the true total exclusive size is calculated:
• Total Exclusive Size = exclusiveSize + exclusiveSizeDeltaFromDirDeepCleaning
• Total Exclusive Replicated Size = exclusiveReplicatedSize + exclusiveReplicatedSizeDeltaFromDirDeepCleaning
What is the link to the Apache JIRA
https://issues.apache.org/jira/browse/HDDS-15077
How was this patch tested?
Javadoc and markdown user doc only.