Package org.apache.geode.cache.lucene.management

Class LuceneIndexMetrics

  • public class LuceneIndexMetrics
extends java.lang.Object

    • Constructor Detail

      • LuceneIndexMetrics

        @ConstructorProperties({"regionPath","indexName","queryExecutions","queryExecutionTime","queryRateAverageLatency","queryExecutionsInProgress","queryExecutionTotalHits","updates","updateTime","updateRateAverageLatency","updatesInProgress","commits","commitTime","commitRateAverageLatency","commitsInProgress","documents","reindexRepositories","reindexRepositoriesTime","reindexRepositoriesInProgress","reindexes","reindexTime","reindexesInProgress"})
public LuceneIndexMetrics​(java.lang.String regionPath,
                          java.lang.String indexName,
                          int queryExecutions,
                          long queryExecutionTime,
                          long queryRateAverageLatency,
                          int queryExecutionsInProgress,
                          long queryExecutionTotalHits,
                          int updates,
                          long updateTime,
                          long updateRateAverageLatency,
                          int updatesInProgress,
                          int commits,
                          long commitTime,
                          long commitRateAverageLatency,
                          int commitsInProgress,
                          int documents,
                          int reindexRepositories,
                          long reindexRepositoriesTime,
                          int reindexRepositoriesInProgress,
                          int reindexes,
                          long reindexTime,
                          int reindexesInProgress)
        This constructor is to be used by internal JMX framework only. A user should not try to create an instance of this class.
        Parameters:
        regionPath - the path for the region on which the LuceneIndex is created
        indexName - the name of the LuceneIndex created
        queryExecutions - the number of query executions using the LuceneIndex
        queryExecutionTime - the time duration for execution of queries using the LuceneIndex
        queryRateAverageLatency - the average latency for query executions using the LuceneIndex
        queryExecutionsInProgress - the number of query executions in progress which are using the LuceneIndex
        queryExecutionTotalHits - the number of hits for the query execution using the LuceneIndex
        updates - the number of update operations on the LuceneIndex
        updateTime - the time consumed for the update operations on the LuceneIndex
        updateRateAverageLatency - the average latency for the update operations on the LuceneIndex
        updatesInProgress - the number of update operations in progress for the LuceneIndex
        commits - the number of commit operations executed on the LuceneIndex
        commitTime - the time consumed by the commit operations on the LuceneIndex
        commitRateAverageLatency - the average latency for the commit operations using the LuceneIndex
        commitsInProgress - the number of commit operations in progress for the LuceneIndex
        documents - the number of documents indexed by LuceneIndex
        reindexRepositories - the number of reindex operations on repositories executed on the LuceneIndex
        reindexRepositoriesTime - the time consumed by the reindex operations on repositories on the LuceneIndex
        reindexRepositoriesInProgress - the number of reindex operations on repositories in progress for the LuceneIndex
        reindexes - the number of reindex operations executed on the LuceneIndex
        reindexTime - the time consumed by the reindex operations on the LuceneIndex
        reindexesInProgress - the number of reindex operations in progress for the LuceneIndex

    • Method Detail

      • getRegionPath

        public java.lang.String getRegionPath()
        Returns the String path for the region on which the LuceneIndex is created
        Returns:
        String value of the region path on the Lucene Index is created

      • getIndexName

        public java.lang.String getIndexName()
        Returns the String name of the LuceneIndex created
        Returns:
        String value of the index name

      • getQueryExecutions

        public int getQueryExecutions()
        Returns the number of query executions using the LuceneIndex
        Returns:
        Number of queries executed using this Lucene index

      • getQueryExecutionTime

        public long getQueryExecutionTime()
        Returns the time duration for execution of queries using the LuceneIndex
        Returns:
        long value for the time in nanoseconds consumed in the execution of queries using this Lucene Index

      • getQueryRateAverageLatency

        public long getQueryRateAverageLatency()
        Returns the average latency for query executions using the LuceneIndex
        Returns:
        the average latency for query executions in nanoseconds using the Lucene Index

      • getQueryExecutionsInProgress

        public int getQueryExecutionsInProgress()
        Returns the number of query executions in progress which are using the LuceneIndex
        Returns:
        the number of query executions in progress which are using the Lucene Index

      • getQueryExecutionTotalHits

        public long getQueryExecutionTotalHits()
        Returns the number of hits for the query execution using the LuceneIndex
        Returns:
        the number of hits for the query execution using the Lucene Index

      • getUpdates

        public int getUpdates()
        Returns the number of update operations on the LuceneIndex
        Returns:
        the number of update operations on the Lucene Index

      • getUpdateTime

        public long getUpdateTime()
        Returns the time consumed for the update operations on the LuceneIndex
        Returns:
        the time consumed in nanoseconds for the update operations on the Lucene Index

      • getUpdateRateAverageLatency

        public long getUpdateRateAverageLatency()
        Returns the average latency for the update operations on the LuceneIndex
        Returns:
        the average latency for the update operations in nanoseconds on the Lucene Index

      • getUpdatesInProgress

        public int getUpdatesInProgress()
        Returns the number of update operations in progress for the LuceneIndex
        Returns:
        the number of update operations in progress for the Lucene Index

      • getCommits

        public int getCommits()
        Returns the number of commit operations executed on the LuceneIndex
        Returns:
        the number of commit operations executed on the Lucene Index

      • getCommitTime

        public long getCommitTime()
        Returns the time consumed by the commit operations on the LuceneIndex
        Returns:
        the time consumed in nanoseconds by the commit operations on the Lucene Index

      • getCommitRateAverageLatency

        public long getCommitRateAverageLatency()
        Returns the average latency for the commit operations using the LuceneIndex
        Returns:
        Returns the average latency for the commit operations in nanoseconds using the Lucene Index

      • getCommitsInProgress

        public int getCommitsInProgress()
        Returns the number of commit operations in progress for the LuceneIndex
        Returns:
        Returns the number of commit operations in progress for the Lucene Indexes

      • getDocuments

        public int getDocuments()
        Returns the number of documents indexed by LuceneIndex
        Returns:
        Returns the number of documents indexed by Lucene

      • getReindexRepositories

        public int getReindexRepositories()
        Returns the number of reindex operations on repository executed on the LuceneIndex
        Returns:
        the number of reindex on operations repository executed on the Lucene Index

      • getReindexRepositoriesTime

        public long getReindexRepositoriesTime()
        Returns the time consumed by the reindex operations for the repository on the LuceneIndex
        Returns:
        the time consumed in nanoseconds by the reindex operations for the repository on the Lucene Index

      • getReindexRepositoriesInProgress

        public int getReindexRepositoriesInProgress()
        Returns the number of reindex operations for the repository in progress for the LuceneIndex
        Returns:
        Returns the number of reindex operations for the repository in progress for the Lucene Indexes

      • getReindexes

        public int getReindexes()
        Returns the number of reindex operations executed on the LuceneIndex
        Returns:
        the number of reindex operations executed on the Lucene Index

      • getReindexTime

        public long getReindexTime()
        Returns the time consumed by the reIndex operations on the LuceneIndex
        Returns:
        the time consumed in nanoseconds by the reindex operations on the Lucene Index

      • getReindexesInProgress

        public int getReindexesInProgress()
        Returns the number of reindex operations in progress for the LuceneIndex
        Returns:
        Returns the number of reindex operations in progress for the Lucene Indexes

      • toString

        public java.lang.String toString()
        Outputs the string message containing all the stats stored for the LuceneIndex
        Overrides:
        toString in class java.lang.Object
        Returns:
        the string message containing all the stats stored for the Lucene Index