jojochuang opened a new pull request, #10544:
URL: https://github.com/apache/ozone/pull/10544
## 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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
