JMX Interface

The existing Hawkore's Lucene indexes expose some attributes and operations through JMX, using the same MBean server as Apache Ignite. The MBeans provided by Hawkore are under the domain com.hawkore.ignite.indexing.

Please note that all the JMX attributes and operations refer to the index shard living inside the local JVM, and not to the globally distributed index.

Name	Type	Notes
NumDeletedDocs	Attribute	Total number of documents in the index.
NumDocs	Attribute	Total number of documents in the index.
DirectoryPath	Attribute	User defined directory path to store index.
MaxCachedBytes	Attribute	Max off-heap memory in bytes.
MemoryAllocatedSize	Attribute	Current allocated off-heap memory in bytes.
MemoryFreeSize	Attribute	Free off-heap memory in bytes.
MemoryTotalSize	Attribute	Max off-heap memory in bytes.
MemoryZone	Attribute	Name of assigned memory zone.
MemoryZoneId	Attribute	Id of assigned memory zone.
OptimizationExecutionTime	Attribute	Last optimization execution.
OptimizationNextExecutionTime	Attribute	Next optimization execution.
OptimizationSchedulerCron	Attribute	Show optimization schedule's CRON expression if optimization is enabled.
Partitions	Attribute	Number of local partitions.
PendingCommits	Attribute	Pending commits to write.
PersistenceEnabled	Attribute	Whether index is persisted on disk.
QueryParallelismSegments	Attribute	Query parallelism segments.
RamBufferMB	Attribute	Memory on MB for indexWriter buffer.
RefreshSeconds	Attribute	Configured index refresh seconds.
stats	Operation	Shows index stats.
commit	Operation	Commits all the pending index changes to disk and reopens all the readers and searchers to provide a recent view of the index.
optimize	Operation	Optimizes the index by merging deletes and deleting unused files if index needs optimization.
rebuild	Operation	Rebuilds index.
optimizationReschedule	Operation	Reschedules index optimization with new provided CRON expression. This change is volatile, will be restore to configured once JVM restarts.