Package org.apache.jackrabbit.oak.plugins.document

Interface FullGCStatsCollector

  • public interface FullGCStatsCollector
    Collector interface for DocumentNodeStore full garbage collection statistics.

    • Method Detail

      • documentRead

        void documentRead()
        Total No. of documents read during FullGC phase

      • candidateProperties

        void candidateProperties​(org.apache.jackrabbit.oak.plugins.document.VersionGarbageCollector.GCPhase mode,
                         long numProps)
        Total No. of properties detected as garbage during a given GC phase
        Parameters:
        mode - GC phase
        numProps - no. of garbage properties found in current cycle

      • candidateDocuments

        void candidateDocuments​(org.apache.jackrabbit.oak.plugins.document.VersionGarbageCollector.GCPhase mode,
                        long numDocs)
        Total No. of documents detected as garbage during a given GC phase
        Parameters:
        mode - GC phase
        numDocs - no. of garbage documents found in current cycle

      • candidateRevisions

        void candidateRevisions​(org.apache.jackrabbit.oak.plugins.document.VersionGarbageCollector.GCPhase mode,
                        long numRevs)
        Total No. of revisions detected as garbage during a given GC phase
        Parameters:
        mode - GC phase
        numRevs - no. of garbage revisions found in current cycle

      • candidateInternalRevisions

        void candidateInternalRevisions​(org.apache.jackrabbit.oak.plugins.document.VersionGarbageCollector.GCPhase mode,
                                long numRevs)
        Total No. of internal revisions detected as garbage during a given GC phase
        Parameters:
        mode - GC phase
        numRevs - no. of garbage internal revisions found in current cycle

      • orphanNodesDeleted

        void orphanNodesDeleted​(long numNodes)
        No. of orphan nodes deleted during FullGC
        Parameters:
        numNodes - no. of orphan nodes deleted in current cycle

      • propertiesDeleted

        void propertiesDeleted​(long numProps)
        No. of properties deleted during FullGC
        Parameters:
        numProps - no. of properties deleted in current cycle

      • unmergedBranchCommitsDeleted

        void unmergedBranchCommitsDeleted​(long numCommits)
        No. of unmerged (unique) branch commits deleted during FullGC
        Parameters:
        numCommits - no. of unmerged branch commits deleted in current cycle

      • documentsUpdated

        void documentsUpdated​(long numDocs)
        No. of documents updated (i.e. have garbage removed) during FullGC
        Parameters:
        numDocs - no. of documents updated in current cycle

      • documentsUpdateSkipped

        void documentsUpdateSkipped​(long numDocs)
        No. of documents which had skipped update (i.e. have been updated between garbage collection & removal) during FullGC
        Parameters:
        numDocs - No. of documents which had skipped update in current cycle

      • documentSkippedDueToEmptySplitProp

        void documentSkippedDueToEmptySplitProp()
        Total No. of documents that were skipped because of empty Split Props

      • started

        void started()
        No. of times the FullGC has started

      • enabled

        void enabled​(boolean enabled)
        Sets whether the FullGC process is enabled.

        This method is called to signal whether the FullGC process is active and ready to perform garbage collection.

        Parameters:
        enabled - true if FullGC is enabled, false otherwise

      • mode

        void mode​(int mode)
        Sets the mode for the FullGC process.

        This method is called to specify the mode in which the FullGC process should operate.

        Parameters:
        mode - the mode to set for the FullGC process

      • verificationEnabled

        void verificationEnabled​(boolean verificationEnabled)
        Sets whether the embedded verification process is enabled for FullGC.

        This method is called to signal whether the verification process is active and ready to perform embedded verification during the FullGC process.

        Parameters:
        verificationEnabled - true if verification is enabled, false otherwise

      • delayFactor

        void delayFactor​(double delayFactor)
        Sets the delay factor for the FullGC process.

        This method is called to specify the delay factor that should be used during the FullGC process.

        Parameters:
        delayFactor - the delay factor to set for the FullGC process

      • batchSize

        void batchSize​(int batchSize)
        Sets the batch size for the FullGC process.

        This method is called to specify the batch size that should be used during the FullGC process.

        Parameters:
        batchSize - the batch size to set for the FullGC process

      • progressSize

        void progressSize​(int progressSize)
        Sets the progress size for the FullGC process.

        This method is called to specify the progress size that should be used during the FullGC process.

        Parameters:
        progressSize - the progress size to set for the FullGC process

      • maxAge

        void maxAge​(long maxAge)
        Sets the maximum age for the FullGC process (in millis).

        This method is called to specify the maximum age that should be used during the FullGC process.

        Parameters:
        maxAge - the maximum age to set for the FullGC process

      • fullGCGeneration

        void fullGCGeneration​(long generation)
        Sets the full garbage collection generation value.

        This method is called to update the current full GC generation being tracked. The generation value is used to reset the full GC process when incremented, allowing it to run from the beginning with fresh state.

        Parameters:
        generation - the full GC generation value to set