26.4. Reference of supported JMX MBeans
MBeans exposed by Neo4j
Name | Description |
---|---|
Information about the branched stores present in this HA cluster member | |
Information about the caching in Neo4j | |
Information about the caching in Neo4j | |
The configuration parameters used to configure Neo4j | |
Diagnostics provided by Neo4j | |
Information about an instance participating in a HA cluster | |
Information about the Neo4j kernel | |
Information about the Neo4j lock status | |
The status of Neo4j memory mapping | |
Estimates of the numbers of different kinds of Neo4j primitives | |
Information about the sizes of the different parts of the Neo4j graph store | |
Information about the Neo4j transaction manager | |
Information about the XA transaction manager |
Note For additional information on the primitive datatypes ( |
MBean Branched Store (org.neo4j.management.BranchedStore) Attributes
Name | Description | Type | Read | Write |
---|---|---|---|---|
Information about the branched stores present in this HA cluster member | ||||
| A list of the branched stores | yes | no |
MBean Cache/NodeCache (org.neo4j.management.Cache) Attributes
Name | Description | Type | Read | Write |
---|---|---|---|---|
Information about the caching in Neo4j | ||||
| The size of this cache (nr of entities or total size in bytes) |
| yes | no |
| The type of cache used by Neo4j |
| yes | no |
| The number of times a cache query returned a result |
| yes | no |
| The number of times a cache query did not return a result |
| yes | no |
MBean Cache/NodeCache (org.neo4j.management.Cache) Operations
Name | Description | ReturnType | Signature |
---|---|---|---|
| Clears the Neo4j caches |
|
|
MBean Cache/RelationshipCache (org.neo4j.management.Cache) Attributes
Name | Description | Type | Read | Write |
---|---|---|---|---|
Information about the caching in Neo4j | ||||
| The size of this cache (nr of entities or total size in bytes) |
| yes | no |
| The type of cache used by Neo4j |
| yes | no |
| The number of times a cache query returned a result |
| yes | no |
| The number of times a cache query did not return a result |
| yes | no |
MBean Cache/RelationshipCache (org.neo4j.management.Cache) Operations
Name | Description | ReturnType | Signature |
---|---|---|---|
| Clears the Neo4j caches |
|
|
MBean Configuration (org.neo4j.jmx.impl.ConfigurationBean) Attributes
Name | Description | Type | Read | Write |
---|---|---|---|---|
The configuration parameters used to configure Neo4j | ||||
| Configuration attribute |
| yes | no |
| Configuration attribute |
| yes | no |
| Configuration attribute |
| yes | no |
| Configuration attribute |
| yes | no |
| Configuration attribute |
| yes | no |
| Configuration attribute |
| yes | no |
| Configuration attribute |
| yes | no |
| Configuration attribute |
| yes | no |
| Configuration attribute |
| yes | no |
| Enable support for running online backups |
| yes | no |
| Listening server for online backups |
| yes | no |
| Enable a remote shell server which shell clients can log in to |
| yes | no |
| Configuration attribute |
| yes | no |
MBean Configuration (org.neo4j.jmx.impl.ConfigurationBean) Operations
Name | Description | ReturnType | Signature |
---|---|---|---|
| Apply settings |
|
|
MBean Diagnostics (org.neo4j.management.Diagnostics) Attributes
Name | Description | Type | Read | Write |
---|---|---|---|---|
Diagnostics provided by Neo4j | ||||
| A list of the ids for the registered diagnostics providers. |
| yes | no |
MBean Diagnostics (org.neo4j.management.Diagnostics) Operations
Name | Description | ReturnType | Signature |
---|---|---|---|
| Dump diagnostics information to JMX |
|
|
| Dump diagnostics information to the log. |
|
|
| Dump diagnostics information to the log. |
|
|
| Operation exposed for management |
|
|
MBean High Availability (org.neo4j.management.HighAvailability) Attributes
Name | Description | Type | Read | Write |
---|---|---|---|---|
Information about an instance participating in a HA cluster | ||||
| Whether this instance is alive or not |
| yes | no |
| Whether this instance is available or not |
| yes | no |
| The identifier used to identify this server in the HA cluster |
| yes | no |
| Information about all instances in this cluster | yes | no | |
| The latest transaction id present in this instance’s store |
| yes | no |
| The time when the data on this instance was last updated from the master |
| yes | no |
| The role this instance has in the cluster |
| yes | no |
MBean High Availability (org.neo4j.management.HighAvailability) Operations
Name | Description | ReturnType | Signature |
---|---|---|---|
| (If this is a slave) Update the database on this instance with the latest transactions from the master |
|
|
MBean Kernel (org.neo4j.jmx.Kernel) Attributes
Name | Description | Type | Read | Write |
---|---|---|---|---|
Information about the Neo4j kernel | ||||
| The time from which this Neo4j instance was in operational mode. |
| yes | no |
| The version of Neo4j |
| yes | no |
| An ObjectName that can be used as a query for getting all management beans for this Neo4j instance. |
| yes | no |
| Whether this is a read only instance |
| yes | no |
| The time when this Neo4j graph store was created. |
| yes | no |
| The location where the Neo4j store is located |
| yes | no |
| An identifier that, together with store creation time, uniquely identifies this Neo4j graph store. |
| yes | no |
| The current version of the Neo4j store logical log. |
| yes | no |
MBean Locking (org.neo4j.management.LockManager) Attributes
Name | Description | Type | Read | Write |
---|---|---|---|---|
Information about the Neo4j lock status | ||||
| Information about all locks held by Neo4j |
| yes | no |
| The number of lock sequences that would have lead to a deadlock situation that Neo4j has detected and averted (by throwing DeadlockDetectedException). |
| yes | no |
MBean Locking (org.neo4j.management.LockManager) Operations
Name | Description | ReturnType | Signature |
---|---|---|---|
| getContendedLocks |
|
|
MBean Memory Mapping (org.neo4j.management.MemoryMapping) Attributes
Name | Description | Type | Read | Write |
---|---|---|---|---|
The status of Neo4j memory mapping | ||||
| Get information about each pool of memory mapped regions from store files with memory mapping enabled | 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 | ||||
| An estimation of the number of nodes used in this Neo4j instance |
| yes | no |
| An estimation of the number of properties used in this Neo4j instance |
| yes | no |
| An estimation of the number of relationships used in this Neo4j instance |
| yes | no |
| The number of relationship types used in this Neo4j instance |
| yes | no |
MBean Store file sizes (org.neo4j.jmx.StoreFile) Attributes
Name | Description | Type | Read | Write |
---|---|---|---|---|
Information about the sizes of the different parts of the Neo4j graph store | ||||
| The amount of disk space used to store array properties, in bytes. |
| yes | no |
| The amount of disk space used by the current Neo4j logical log, in bytes. |
| yes | no |
| The amount of disk space used to store nodes, in bytes. |
| yes | no |
| The amount of disk space used to store properties (excluding string values and array values), in bytes. |
| yes | no |
| The amount of disk space used to store relationships, in bytes. |
| yes | no |
| The amount of disk space used to store string properties, in bytes. |
| yes | no |
| The total disk space used by this Neo4j instance, in bytes. |
| yes | no |
MBean Transactions (org.neo4j.management.TransactionManager) Attributes
Name | Description | Type | Read | Write |
---|---|---|---|---|
Information about the Neo4j transaction manager | ||||
| The id of the latest committed transaction |
| yes | no |
| The total number of committed transactions |
| yes | no |
| The total number started transactions |
| yes | no |
| The number of currently open transactions |
| yes | no |
| The total number of rolled back transactions |
| yes | no |
| The highest number of transactions ever opened concurrently |
| yes | no |
MBean XA Resources (org.neo4j.management.XaManager) Attributes
Name | Description | Type | Read | Write |
---|---|---|---|---|
Information about the XA transaction manager | ||||
| Information about all XA resources managed by the transaction manager | yes | no |