28.4. Reference of supported JMX MBeans

MBeans exposed by Neo4j

NameDescription

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.

Index sampler

Handle index sampling.

Kernel

Information about the Neo4j kernel.

Locking

Information about the Neo4j lock status.

Memory Mapping

The status of Neo4j memory mapping.

Page cache

Information about the Neo4j page cache.

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.

[Note]Note

For additional information on the primitive datatypes (int, long etc.) used in the JMX attributes, please see Property value types in the section called “Properties”.

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

NameDescriptionTypeReadWrite

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

NameDescriptionTypeReadWrite

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

NameDescriptionReturnTypeSignature

clear

Clears the Neo4j caches

void

(no parameters)

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

NameDescriptionTypeReadWrite

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

NameDescriptionReturnTypeSignature

clear

Clears the Neo4j caches

void

(no parameters)

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

NameDescriptionTypeReadWrite

The configuration parameters used to configure Neo4j

cache.memory_ratio

Set how much of the memory available for caching to use for caching. It is recommended to not have this value exceed 70 percent.

String

yes

no

dbms.pagecache.memory

Configuration attribute

String

yes

no

ephemeral

Configuration attribute

String

yes

no

ha.initial_hosts

Configuration attribute

String

yes

no

ha.server_id

Configuration attribute

String

yes

no

jmx.port

Configuration attribute

String

yes

no

node_cache_array_fraction

Fraction of the heap to dedicate to the array holding the nodes in the cache. Specifying 5 will let that array itself take up 5% out of the entire heap. Increasing this figure will reduce the chance of hash collisions at the expense of more heap used for it. More collisions means more redundant loading of objects from the low level cache.

String

yes

no

node_cache_size

Maximum size of the heap memory to dedicate to the cached nodes. Right before the maximum size is reached a purge is performed. The purge will evict objects from the cache until the cache size gets below 90% of the maximum size. Optimal settings for the maximum size depends on the size of your graph. The configured maximum size should leave enough room for other objects to coexist in the same JVM. At the same time it should be large enough to keep loading from the low level cache at a minimum. Predicted load on the JVM as well as layout of domain level objects should also be taken into consideration.

String

yes

no

online_backup_enabled

Enable support for running online backups

String

yes

no

online_backup_server

Listening server for online backups

String

yes

no

relationship_cache_array_fraction

Fraction of the heap to dedicate to the array holding the relationships in the cache. See node_cache_array_fraction for more information.

String

yes

no

relationship_cache_size

Maximum size of the heap memory to dedicate to the cached relationships. See node_cache_size for more information.

String

yes

no

remote_shell_enabled

Enable a remote shell server which Neo4j Shell clients can log in to.

String

yes

no

remote_shell_host

Remote host for shell. By default, the shell server listens only on the loopback interface, but you can specify the IP address of any network interface or use 0.0.0.0 for all interfaces.

String

yes

no

remote_shell_name

The name of the shell.

String

yes

no

remote_shell_port

The port the shell will listen on.

String

yes

no

remote_shell_read_only

Read only mode. Will only allow read operations.

String

yes

no

store_dir

Configuration attribute

String

yes

no

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

NameDescriptionTypeReadWrite

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

NameDescriptionReturnTypeSignature

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

NameDescriptionTypeReadWrite

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

NameDescriptionReturnTypeSignature

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

NameDescriptionTypeReadWrite

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

NameDescriptionTypeReadWrite

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

NameDescriptionReturnTypeSignature

getContendedLocks

getContendedLocks

java.util.List<org.neo4j.kernel.info.LockInfo> as CompositeData[]

long

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

NameDescriptionTypeReadWrite

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 Page cache (org.neo4j.management.PageCache) Attributes

NameDescriptionTypeReadWrite

Information about the Neo4j page cache

BytesRead

Number of bytes read from durable storage

long

yes

no

BytesWritten

Number of bytes written to durable storage

long

yes

no

EvictionExceptions

Number of exceptions caught during page eviction

long

yes

no

Evictions

Number of page evictions

long

yes

no

Faults

Number of page faults

long

yes

no

FileMappings

Number of files that have been mapped into the page cache

long

yes

no

FileUnmappings

Number of files that have been unmapped from the page cache

long

yes

no

Flushes

Number of page flushes

long

yes

no

Pins

Number of page pins

long

yes

no

Unpins

Number of page unpins

long

yes

no

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

NameDescriptionTypeReadWrite

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.jmx.StoreFile) Attributes

NameDescriptionTypeReadWrite

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

NameDescriptionTypeReadWrite

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

long

yes

no

NumberOfOpenTransactions

The number of currently open transactions

long

yes

no

NumberOfRolledBackTransactions

The total number of rolled back transactions

long

yes

no

PeakNumberOfConcurrentTransactions

The highest number of transactions ever opened concurrently

long

yes

no

MBean Index sampler (org.neo4j.management.IndexSamplingManager) Operations

NameDescriptionReturnTypeSignature

triggerIndexSampling

triggerIndexSampling

void

java.lang.String,java.lang.String,boolean