Jörg Hoh created OAK-6791:
-----------------------------

             Summary: Create documentation for Indexing related MBeans
                 Key: OAK-6791
                 URL: https://issues.apache.org/jira/browse/OAK-6791
             Project: Jackrabbit Oak
          Issue Type: Documentation
    Affects Versions: 1.6.1
            Reporter: Jörg Hoh


At the moment there is no documentation on the information provided by the Oak 
MBeans or the actions which can be triggered. Instead of just having inline 
documentation (which sometimes is available, sometimes not) it would be much 
better if the documentation is provided on the Oak site in a consolidated 
manner.

The affected MBeans for Indexing as of Oak 1.6:

org.apache.jackrabbit.oak:name=IndexCopierStats,type=IndexCopierStats
org.apache.jackrabbit.oak:name=async,type=IndexStats
org.apache.jackrabbit.oak:name=async-reindex,type=IndexStats
org.apache.jackrabbit.oak:name=fulltext-async,type=IndexStats
org.apache.jackrabbit.oak:name=Lucene Index statistics, type=LuceneIndex
org.apache.jackrabbit.oak:name=async,type=PropertyIndexAsyncReindex
org.apache.jackrabbit.oak:name=Property Index statistics, 
type=PropertyIndexStats

(A sample of a good documentation is the documentation of the 
SegmentRevisionGarbageCollection available at [1]).

[1] 
http://jackrabbit.apache.org/oak/docs/nodestore/segment/overview.html#monitoring-via-jmx



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

Reply via email to