Author: mduerig
Date: Fri Jan 19 15:40:31 2018
New Revision: 1821670
URL: http://svn.apache.org/viewvc?rev=1821670&view=rev
Log:
OAK-7075: Document oak-run compact arguments and system properties
merged r1821665
Modified:
jackrabbit/oak/branches/1.8/ (props changed)
jackrabbit/oak/branches/1.8/oak-doc/src/site/markdown/nodestore/segment/overview.md
Propchange: jackrabbit/oak/branches/1.8/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Fri Jan 19 15:40:31 2018
@@ -1,3 +1,3 @@
/jackrabbit/oak/branches/1.0:1665962
-/jackrabbit/oak/trunk:1820660-1820661,1820859,1820861,1820878,1820888,1820947,1821130,1821140-1821141,1821240,1821258,1821325,1821358,1821361-1821362,1821370,1821375,1821393,1821477,1821487,1821516
+/jackrabbit/oak/trunk:1820660-1820661,1820859,1820861,1820878,1820888,1820947,1821130,1821140-1821141,1821240,1821258,1821325,1821358,1821361-1821362,1821370,1821375,1821393,1821477,1821487,1821516,1821665
/jackrabbit/trunk:1345480
Modified:
jackrabbit/oak/branches/1.8/oak-doc/src/site/markdown/nodestore/segment/overview.md
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/branches/1.8/oak-doc/src/site/markdown/nodestore/segment/overview.md?rev=1821670&r1=1821669&r2=1821670&view=diff
==============================================================================
---
jackrabbit/oak/branches/1.8/oak-doc/src/site/markdown/nodestore/segment/overview.md
(original)
+++
jackrabbit/oak/branches/1.8/oak-doc/src/site/markdown/nodestore/segment/overview.md
Fri Jan 19 15:40:31 2018
@@ -466,13 +466,17 @@ This parameter is used only if compactio
* **RetainedGenerations (int)**
How many generations should be preserved when cleaning up the Segment Store.
When the cleanup phase runs, only the latest `RetainedGenerations` generations
are kept intact.
-Older generations will be deleted.
+Older generations will be deleted. *Deprecated*: as of Oak 1.8 this value is
fixed to 2 generations and cannot be modified.
* **GcSizeDeltaEstimation (long)**
The size (in bytes) of new content added to the repository since the end of
the last garbage collection that would trigger another garbage collection run.
This parameter influences the behaviour of the estimation phase.
* **EstimationDisabled (boolean)**
Determines if the estimation phase is disabled.
If this parameter is set to `true`, the estimation phase will be skipped and
compaction will run unconditionally.
+* **GCType ("FULL" or "TAIL")**
+Determines the type of the garbage collection that should run when invoking
the `startRevisionGC` operation.
+* **RevisionGCProgressLog (long)**
+The number of processed nodes after which a progress message is logged. `-1`
indicates no logging.
* **MemoryThreshold (int)**
A number between `0` and `100` that represents the percentage of heap memory
that should always be free during compaction.
If the amount of free memory falls below the provided percentage, compaction
will be interrupted.
@@ -494,6 +498,14 @@ The last log message produced during gar
* **Status (string)**
The current status of the garbage collection process.
This property can assume the values `idle`, `estimation`, `compaction`,
`compaction-retry-N` (where `N` is the number of the current retry iteration),
`compaction-force-compact` and `cleanup`.
+* **RevisionGCRunning (boolean)**
+Indicates whether online revision garbage collection is currently running.
+* **CompactedNodes (long)**
+The number of compacted nodes during the previous garbage collection
+* **EstimatedCompactableNodes (long)**
+The estimated number of nodes to compact during the next garbage collection.
`-1` indicates an estimated value is not available.
+* **EstimatedRevisionGCCompletion (int)**
+Estimated percentage completed for the current garbage collection run. `-1`
indicates an estimated percentage is not available.
The `SegmentRevisionGarbageCollection` MBean also exposes the following
management operations.
