29.4. Reference of supported JMX MBeans

Prev		Next

MBeans exposed by Neo4j

Name	Description
`Branched Store`	Information about the branched stores present in this HA cluster member
`Cache/NodeCache`	Information about the caching in Neo4j
`Cache/RelationshipCache`	Information about the caching in Neo4j
`Configuration`	The configuration parameters used to configure Neo4j
`Diagnostics`	Diagnostics provided by Neo4j
`High Availability`	Information about an instance participating in a HA cluster
`Kernel`	Information about the Neo4j kernel
`Locking`	Information about the Neo4j lock status
`Memory Mapping`	The status of Neo4j memory mapping
`Primitive count`	Estimates of the numbers of different kinds of Neo4j primitives
`Store file sizes`	Information about the sizes of the different parts of the Neo4j graph store
`Transactions`	Information about the Neo4j transaction manager
`XA Resources`	Information about the XA transaction manager

	Note
	For additional information on the primitive datatypes (`int`, `long` etc.) used in the JMX attributes, please see Property value types.

MBean Branched Store (org.neo4j.management.BranchedStore) Attributes

Name	Description	Type	Read	Write
Information about the branched stores present in this HA cluster member
`BranchedStores`	A list of the branched stores	`org.neo4j.management.BranchedStoreInfo[] as CompositeData[]`	yes	no

MBean Cache/NodeCache (org.neo4j.management.Cache) Attributes

Name	Description	Type	Read	Write
Information about the caching in Neo4j
`CacheSize`	The size of this cache (nr of entities or total size in bytes)	`long`	yes	no
`CacheType`	The type of cache used by Neo4j	`String`	yes	no
`HitCount`	The number of times a cache query returned a result	`long`	yes	no
`MissCount`	The number of times a cache query did not return a result	`long`	yes	no

MBean Cache/NodeCache (org.neo4j.management.Cache) Operations

Name	Description	ReturnType	Signature
`clear`	Clears the Neo4j caches	`void`	`(no parameters)`

MBean Cache/RelationshipCache (org.neo4j.management.Cache) Attributes

Name	Description	Type	Read	Write
Information about the caching in Neo4j
`CacheSize`	The size of this cache (nr of entities or total size in bytes)	`long`	yes	no
`CacheType`	The type of cache used by Neo4j	`String`	yes	no
`HitCount`	The number of times a cache query returned a result	`long`	yes	no
`MissCount`	The number of times a cache query did not return a result	`long`	yes	no

MBean Cache/RelationshipCache (org.neo4j.management.Cache) Operations

Name	Description	ReturnType	Signature
`clear`	Clears the Neo4j caches	`void`	`(no parameters)`

MBean Configuration (org.neo4j.jmx.impl.ConfigurationBean) Attributes

Name	Description	Type	Read	Write
The configuration parameters used to configure Neo4j
`all_stores_total_mapped_memory_size`	The size to allocate for a memory mapping pool to be shared between all stores.	`String`	yes	no
`allow_store_upgrade`	Whether to allow a store upgrade in case the current version of the database starts against an older store version. Setting this to true does not guarantee successful upgrade, just that it allows an attempt at it.	`String`	yes	no
`array_block_size`	Specifies the block size for storing arrays. This parameter is only honored when the store is created, otherwise it is ignored. The default block size is 120 bytes, and the overhead of each block is the same as for string blocks, i.e., 8 bytes.	`String`	yes	no
`backup_slave`	Mark this database as a backup slave.	`String`	yes	no
`cache_type`	The type of cache to use for nodes and relationships. Note that the Neo4j Enterprise Edition has the additional gcr cache type. See the chapter on caches in the manual for more information.	`String`	yes	no
`cypher_parser_version`	Enable this to specify a parser other than the default one.	`String`	yes	no
`dump_configuration`	Print out the effective Neo4j configuration after startup.	`String`	yes	no
`ephemeral`	Configuration attribute	`String`	yes	no
`forced_kernel_id`	An identifier that uniquely identifies this graph database instance within this JVM. Defaults to an auto-generated number depending on how many instance are started in this JVM.	`String`	yes	no
`gc_monitor_threshold`	The amount of time in ms the monitor thread has to be blocked before logging a message it was blocked.	`String`	yes	no
`gc_monitor_wait_time`	Amount of time in ms the GC monitor thread will wait before taking another measurement.	`String`	yes	no
`gcr_cache_min_log_interval`	The minimal time that must pass in between logging statistics from the cache (when using the gcr cache).	`String`	yes	no
`grab_file_lock`	Whether to grab locks on files or not.	`String`	yes	no
`ha.allow_init_cluster`	Whether to allow this instance to create a cluster if unable to join	`String`	yes	no
`ha.branched_data_policy`	Policy for how to handle branched data	`String`	yes	no
`ha.broadcast_timeout`	Timeout for broadcasting values in cluster. Must consider end-to-end duration of Paxos algorithm	`String`	yes	no
`ha.cluster_name`	The name of a cluster	`String`	yes	no
`ha.cluster_server`	Host name and port to use for the cluster server	`String`	yes	no
`ha.com_chunk_size`	Max size of the data chunks that flows between master and slaves in HA. Bigger size may increase throughput,but may be more sensitive to variations in bandwidth, whereas lower size increases tolerance for bandwidth variations. Examples: 500k or 3M. Must be within 1k-16M	`String`	yes	no
`ha.configuration_timeout`	Timeout for waiting for configuration from an existing cluster member	`String`	yes	no
`ha.default_timeout`	Default timeout used for clustering timeouts. Override with specific timeouts if necessary	`String`	yes	no
`ha.election_timeout`	Timeout for waiting for other members to finish a role election	`String`	yes	no
`ha.heartbeat_interval`	How often heartbeat messages should be sent	`String`	yes	no
`ha.heartbeat_timeout`	Timeout for heartbeats between cluster members. Should be at least twice that of the interval	`String`	yes	no
`ha.initial_hosts`	This is the list of potential cluster members	`String`	yes	no
`ha.join_timeout`	Timeout for joining a cluster	`String`	yes	no
`ha.learn_timeout`	Timeout for learning values	`String`	yes	no
`ha.leave_timeout`	Timeout for waiting for cluster leave to finish	`String`	yes	no
`ha.lock_read_timeout`	Timeout for taking locks	`String`	yes	no
`ha.max_concurrent_channels_per_slave`	Maximum number of connections a slave can have to the master	`String`	yes	no
`ha.paxos_timeout`	Default timeout for all Paxos timeouts	`String`	yes	no
`ha.phase1_timeout`	Timeout for Paxos phase 1	`String`	yes	no
`ha.phase2_timeout`	Timeout for Paxos phase 2	`String`	yes	no
`ha.pull_interval`	Interval of pulling updates from master	`String`	yes	no
`ha.read_timeout`	Timeout for reading network data	`String`	yes	no
`ha.server_id`	Id for a cluster instance. Must be unique within the cluster	`String`	yes	no
`ha.server`	Where to bind High Availability protocol server	`String`	yes	no
`ha.slave_only`	Whether this instance should only participate as slave in cluster. If enabled it will never be elected as master	`String`	yes	no
`ha.state_switch_timeout`	Timeout for waiting for instance to become master or slave	`String`	yes	no
`ha.tx_push_factor`	The amount of slaves the master will ask to replicate a committed transaction. The master will not throw an exception on commit if the replication failed.	`String`	yes	no
`ha.tx_push_strategy`	Push strategy of a transaction to a slave during commit. Round robin ("round_robin") or fixed ("fixed") selecting the slave with highest machine id first	`String`	yes	no
`ha.zk_session_timeout`	ZooKeeper session timeout. Only needed for rolling upgrade from 1.8 to 1.9	`String`	yes	no
`intercept_committing_transactions`	Determines whether any TransactionInterceptors loaded will intercept prepared transactions before they reach the logical log.	`String`	yes	no
`intercept_deserialized_transactions`	Determines whether any TransactionInterceptors loaded will intercept externally received transactions (e.g. in HA) before they reach the logical log and are applied to the store.	`String`	yes	no
`jmx.port`	Configuration attribute	`String`	yes	no
`keep_logical_logs`	Make Neo4j keep the logical transaction logs for being able to backup the database.Can be used for specifying the threshold to prune logical logs after. For example "10 days" will prune logical logs that only contains transactions older than 10 days from the current time, or "100k txs" will keep the 100k latest transactions and prune any older transactions.	`String`	yes	no
`load_kernel_extensions`	Enable loading kernel extensions	`String`	yes	no
`log_mapped_memory_stats_filename`	The file where Neo4j will record memory mapping statistics.	`String`	yes	no
`log_mapped_memory_stats_interval`	The number of records to be loaded between regular logging of memory mapping statistics.	`String`	yes	no
`log_mapped_memory_stats`	Tell Neo4j to regularly log memory mapping statistics.	`String`	yes	no
`logging.threshold_for_rotation`	Threshold in bytes for when database logs (text logs, for debugging, that is) are rotated.	`String`	yes	no
`logical_log`	The base name for the logical log files, either an absolute path or relative to the store_dir setting. This should generally not be changed.	`String`	yes	no
`mapped_memory_page_size`	Target size for pages of mapped memory.	`String`	yes	no
`neo_store`	The base name for the Neo4j Store files, either an absolute path or relative to the store_dir setting. This should generally not be changed.	`String`	yes	no
`neostore.nodestore.db.mapped_memory`	The size to allocate for memory mapping the node store.	`String`	yes	no
`neostore.propertystore.db.arrays.mapped_memory`	The size to allocate for memory mapping the array property store.	`String`	yes	no
`neostore.propertystore.db.index.keys.mapped_memory`	The size to allocate for memory mapping the store for property key strings.	`String`	yes	no
`neostore.propertystore.db.index.mapped_memory`	The size to allocate for memory mapping the store for property key indexes.	`String`	yes	no
`neostore.propertystore.db.mapped_memory`	The size to allocate for memory mapping the property value store.	`String`	yes	no
`neostore.propertystore.db.strings.mapped_memory`	The size to allocate for memory mapping the string property store.	`String`	yes	no
`neostore.relationshipstore.db.mapped_memory`	The size to allocate for memory mapping the relationship store.	`String`	yes	no
`node_auto_indexing`	Controls the auto indexing feature for nodes. Setting to false shuts it down, while true enables it by default for properties listed in the node_keys_indexable setting.	`String`	yes	no
`node_cache_array_fraction`	The fraction of the heap (1%-10%) to use for the base array in the node cache (when using the gcr cache).	`String`	yes	no
`node_cache_size`	The amount of memory to use for the node cache (when using the gcr cache).	`String`	yes	no
`node_keys_indexable`	A list of property names (comma separated) that will be indexed by default. This applies to Nodes only.	`String`	yes	no
`online_backup_enabled`	Enable support for running online backups	`String`	yes	no
`online_backup_port`	Listening port for online backups. Replaced by online_backup_server	`String`	yes	no
`online_backup_server`	Listening server for online backups	`String`	yes	no
`read_only`	Only allow read operations from this Neo4j instance.	`String`	yes	no
`rebuild_idgenerators_fast`	Use a quick approach for rebuilding the ID generators. This give quicker recovery time, but will limit the ability to reuse the space of deleted entities.	`String`	yes	no
`relationship_auto_indexing`	Controls the auto indexing feature for relationships. Setting to false shuts it down, while true enables it by default for properties listed in the relationship_keys_indexable setting.	`String`	yes	no
`relationship_cache_array_fraction`	The fraction of the heap (1%-10%) to use for the base array in the relationship cache (when using the gcr cache).	`String`	yes	no
`relationship_cache_size`	The amount of memory to use for the relationship cache (when using the gcr cache).	`String`	yes	no
`relationship_grab_size`	How many relationships to read at a time during iteration	`String`	yes	no
`relationship_keys_indexable`	A list of property names (comma separated) that will be indexed by default. This applies to Relationships only.	`String`	yes	no
`remote_logging_enabled`	Whether to enable logging to a remote server or not.	`String`	yes	no
`remote_logging_host`	Host for remote logging using LogBack SocketAppender.	`String`	yes	no
`remote_logging_port`	Port for remote logging using LogBack SocketAppender.	`String`	yes	no
`remote_shell_enabled`	Enable a remote shell server which shell clients can log in to	`String`	yes	no
`store_dir`	The directory where the database files are located.	`String`	yes	no
`string_block_size`	Specifies the block size for storing strings. This parameter is only honored when the store is created, otherwise it is ignored. Note that each character in a string occupies two bytes, meaning that a block size of 120 (the default size) will hold a 60 character long string before overflowing into a second block. Also note that each block carries an overhead of 8 bytes. This means that if the block size is 120, the size of the stored records will be 128 bytes.	`String`	yes	no
`tx_manager_impl`	The name of the Transaction Manager service to use as defined in the TM service provider constructor.	`String`	yes	no
`use_memory_mapped_buffers`	Tell Neo4j to use memory mapped buffers for accessing the native storage layer.	`String`	yes	no

MBean Configuration (org.neo4j.jmx.impl.ConfigurationBean) Operations

Name	Description	ReturnType	Signature
`apply`	Apply settings	`void`	`(no parameters)`

MBean Diagnostics (org.neo4j.management.Diagnostics) Attributes

Name	Description	Type	Read	Write
Diagnostics provided by Neo4j
`DiagnosticsProviders`	A list of the ids for the registered diagnostics providers.	`List (java.util.List)`	yes	no

MBean Diagnostics (org.neo4j.management.Diagnostics) Operations

Name	Description	ReturnType	Signature
`dumpAll`	Dump diagnostics information to JMX	`String`	`(no parameters)`
`dumpToLog`	Dump diagnostics information to the log.	`void`	`(no parameters)`
`dumpToLog`	Dump diagnostics information to the log.	`void`	`java.lang.String`
`extract`	Operation exposed for management	`String`	`java.lang.String`

MBean High Availability (org.neo4j.management.HighAvailability) Attributes

Name	Description	Type	Read	Write
Information about an instance participating in a HA cluster
`Alive`	Whether this instance is alive or not	`boolean`	yes	no
`Available`	Whether this instance is available or not	`boolean`	yes	no
`InstanceId`	The identifier used to identify this server in the HA cluster	`String`	yes	no
`InstancesInCluster`	Information about all instances in this cluster	`org.neo4j.management.ClusterMemberInfo[] as CompositeData[]`	yes	no
`LastCommittedTxId`	The latest transaction id present in this instance’s store	`long`	yes	no
`LastUpdateTime`	The time when the data on this instance was last updated from the master	`String`	yes	no
`Role`	The role this instance has in the cluster	`String`	yes	no

MBean High Availability (org.neo4j.management.HighAvailability) Operations

Name	Description	ReturnType	Signature
`update`	(If this is a slave) Update the database on this instance with the latest transactions from the master	`String`	`(no parameters)`

MBean Kernel (org.neo4j.jmx.Kernel) Attributes

Name	Description	Type	Read	Write
Information about the Neo4j kernel
`KernelStartTime`	The time from which this Neo4j instance was in operational mode.	`Date (java.util.Date)`	yes	no
`KernelVersion`	The version of Neo4j	`String`	yes	no
`MBeanQuery`	An ObjectName that can be used as a query for getting all management beans for this Neo4j instance.	`javax.management.ObjectName`	yes	no
`ReadOnly`	Whether this is a read only instance	`boolean`	yes	no
`StoreCreationDate`	The time when this Neo4j graph store was created.	`Date (java.util.Date)`	yes	no
`StoreDirectory`	The location where the Neo4j store is located	`String`	yes	no
`StoreId`	An identifier that, together with store creation time, uniquely identifies this Neo4j graph store.	`String`	yes	no
`StoreLogVersion`	The current version of the Neo4j store logical log.	`long`	yes	no

MBean Locking (org.neo4j.management.LockManager) Attributes

Name	Description	Type	Read	Write
Information about the Neo4j lock status
`Locks`	Information about all locks held by Neo4j	`java.util.List<org.neo4j.kernel.info.LockInfo> as CompositeData[]`	yes	no
`NumberOfAvertedDeadlocks`	The number of lock sequences that would have lead to a deadlock situation that Neo4j has detected and averted (by throwing DeadlockDetectedException).	`long`	yes	no

MBean Locking (org.neo4j.management.LockManager) Operations

Name	Description	ReturnType	Signature
`getContendedLocks`	getContendedLocks	`java.util.List<org.neo4j.kernel.info.LockInfo> as CompositeData[]`	`long`

MBean Memory Mapping (org.neo4j.management.MemoryMapping) Attributes

Name	Description	Type	Read	Write
The status of Neo4j memory mapping
`MemoryPools`	Get information about each pool of memory mapped regions from store files with memory mapping enabled	`org.neo4j.management.WindowPoolInfo[] as CompositeData[]`	yes	no

MBean Primitive count (org.neo4j.jmx.Primitives) Attributes

Name	Description	Type	Read	Write
Estimates of the numbers of different kinds of Neo4j primitives
`NumberOfNodeIdsInUse`	An estimation of the number of nodes used in this Neo4j instance	`long`	yes	no
`NumberOfPropertyIdsInUse`	An estimation of the number of properties used in this Neo4j instance	`long`	yes	no
`NumberOfRelationshipIdsInUse`	An estimation of the number of relationships used in this Neo4j instance	`long`	yes	no
`NumberOfRelationshipTypeIdsInUse`	The number of relationship types used in this Neo4j instance	`long`	yes	no

MBean Store file sizes (org.neo4j.management.StoreFile) Attributes

Name	Description	Type	Read	Write
Information about the sizes of the different parts of the Neo4j graph store
`ArrayStoreSize`	The amount of disk space used to store array properties, in bytes.	`long`	yes	no
`LogicalLogSize`	The amount of disk space used by the current Neo4j logical log, in bytes.	`long`	yes	no
`NodeStoreSize`	The amount of disk space used to store nodes, in bytes.	`long`	yes	no
`PropertyStoreSize`	The amount of disk space used to store properties (excluding string values and array values), in bytes.	`long`	yes	no
`RelationshipStoreSize`	The amount of disk space used to store relationships, in bytes.	`long`	yes	no
`StringStoreSize`	The amount of disk space used to store string properties, in bytes.	`long`	yes	no
`TotalStoreSize`	The total disk space used by this Neo4j instance, in bytes.	`long`	yes	no

MBean Transactions (org.neo4j.management.TransactionManager) Attributes

Name	Description	Type	Read	Write
Information about the Neo4j transaction manager
`LastCommittedTxId`	The id of the latest committed transaction	`long`	yes	no
`NumberOfCommittedTransactions`	The total number of committed transactions	`long`	yes	no
`NumberOfOpenedTransactions`	The total number started transactions	`int`	yes	no
`NumberOfOpenTransactions`	The number of currently open transactions	`int`	yes	no
`NumberOfRolledBackTransactions`	The total number of rolled back transactions	`long`	yes	no
`PeakNumberOfConcurrentTransactions`	The highest number of transactions ever opened concurrently	`int`	yes	no

MBean XA Resources (org.neo4j.management.XaManager) Attributes

Name	Description	Type	Read	Write
Information about the XA transaction manager
`XaResources`	Information about all XA resources managed by the transaction manager	`org.neo4j.management.XaResourceInfo[] as CompositeData[]`	yes	no