[IGNITE-7781] JMX beans documentation

• Type: Task
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Component/s: documentation
• Labels: documentation jmx
• Assignee: Artem Budnikov
• Reporter: Aleksey Plekhanov
• Created: 21/Feb/18 17:13
• Updated: 21/Oct/19 13:28

Description

There are about 30 JMX beans implemented in Ignite, but there is no documentation for most of these beans, except memory metrics and brief overview of cache metrics.

Folowing MBeans/MXBeans can be documented:

MBeans group	Interface	Path	Comment
Eviction metrics	org.apache.ignite.cache.eviction.fifo.FifoEvictionPolicyMBean, org.apache.ignite.cache.eviction.igfs.IgfsPerBlockLruEvictionPolicyMXBean, org.apache.ignite.cache.eviction.lru.LruEvictionPolicyMBean, org.apache.ignite.cache.eviction.sorted.SortedEvictionPolicyMBean	org.apache.<ClassLoaderId>.<InstanceName>.<CacheName>.<MBeanInterfaceName>	For each cache, if eviction for cache is configured
Cache group metrics	org.apache.ignite.mxbean.CacheGroupMetricsMXBean	org.apache.<ClassLoaderId>.<InstanceName>."Cache groups".<CacheGroupName>	For each group
Cache metrics	org.apache.ignite.mxbean.CacheMetricsMXBean	org.apache.<ClassLoaderId>.<InstanceName>.<CacheName>.CacheClusterMetricsMXBeanImpl, org.apache.<ClassLoaderId>.<InstanceName>.<CacheName>.CacheLocalMetricsMXBeanImpl	For each cache
Cluster metrics	org.apache.ignite.mxbean.ClusterMetricsMXBean	org.apache.<ClassLoaderId>.<InstanceName>.Kernal.ClusterLocalNodeMetricsMXBeanImpl, org.apache.<ClassLoaderId>.<InstanceName>.Kernal.ClusterMetricsMXBeanImpl
Data region (memory) metrics	org.apache.ignite.mxbean.DataRegionMetricsMXBean	org.apache.<ClassLoaderId>.<InstanceName>.DataRegionMetrics.<DataRegion>	For each data region
Data storage metrics	org.apache.ignite.mxbean.DataStorageMetricsMXBean	org.apache.<ClassLoaderId>.<InstanceName>."Persistent Store".DataStorageMetrics
Instance information	org.apache.ignite.mxbean.IgniteMXBean	org.apache.<ClassLoaderId>.<InstanceName>.Kernal.IgniteKernal
Ignition state	org.apache.ignite.mxbean.IgnitionMXBean	org.apache.<ClassLoaderId>.Kernel.Ignition
Thread pools metrics	org.apache.ignite.mxbean.ThreadPoolMXBean, org.apache.ignite.mxbean.StripedExecutorMXBean	org.apache.<ClassLoaderId>.<InstanceName>."Thread Pools".<PoolName>	For each executor
SPI	org.apache.ignite.spi.cache.CacheCheckpointSpiMBean, org.apache.ignite.spi.collision.fifoqueue.FifoQueueCollisionSpiMBean, org.apache.ignite.spi.collision.jobstealing.JobStealingCollisionSpiMBean, org.apache.ignite.spi.collision.priorityqueue.PriorityQueueCollisionSpiMBean, org.apache.ignite.spi.communication.tcp.TcpCommunicationSpiMBean, org.apache.ignite.spi.deployment.local.LocalDeploymentSpiMBean, org.apache.ignite.spi.discovery.tcp.TcpDiscoverySpiMBean, org.apache.ignite.spi.eventstorage.memory.MemoryEventStorageSpiMBean, org.apache.ignite.spi.failover.always.AlwaysFailoverSpiMBean, org.apache.ignite.spi.failover.jobstealing.JobStealingFailoverSpiMBean, org.apache.ignite.spi.failover.never.NeverFailoverSpiMBean, org.apache.ignite.spi.jdbc.JdbcCheckpointSpiMBean, org.apache.ignite.spi.loadbalancing.adaptive.AdaptiveLoadBalancingSpiMBean, org.apache.ignite.spi.loadbalancing.roundrobin.RoundRobinLoadBalancingSpiMBean, org.apache.ignite.spi.loadbalancing.weightedrandom.WeightedRandomLoadBalancingSpiMBean, org.apache.ignite.spi.sharedfs.SharedFsCheckpointSpiMBean	org.apache.<ClassLoaderId>.<InstanceName>.SPIs.<SpiImplementation>

 

JavaDoc for this beans is attached.