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 | ||||
| The size to allocate for a memory mapping pool to be shared between all stores. |
| yes | no |
| 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. |
| yes | no |
| 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. |
| yes | no |
| Mark this database as a backup slave. |
| yes | no |
| 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. |
| yes | no |
| Enable this to specify a parser other than the default one. |
| yes | no |
| Print out the effective Neo4j configuration after startup. |
| yes | no |
| Configuration attribute |
| yes | no |
| 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. |
| yes | no |
| The amount of time in ms the monitor thread has to be blocked before logging a message it was blocked. |
| yes | no |
| Amount of time in ms the GC monitor thread will wait before taking another measurement. |
| yes | no |
| The minimal time that must pass in between logging statistics from the cache (when using the gcr cache). |
| yes | no |
| Whether to grab locks on files or not. |
| yes | no |
| Whether to allow this instance to create a cluster if unable to join |
| yes | no |
| Policy for how to handle branched data |
| yes | no |
| Timeout for broadcasting values in cluster. Must consider end-to-end duration of Paxos algorithm |
| yes | no |
| The name of a cluster |
| yes | no |
| Host name and port to use for the cluster server |
| yes | no |
| 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 |
| yes | no |
| Timeout for waiting for configuration from an existing cluster member |
| yes | no |
| Default timeout used for clustering timeouts. Override with specific timeouts if necessary |
| yes | no |
| Timeout for waiting for other members to finish a role election |
| yes | no |
| How often heartbeat messages should be sent |
| yes | no |
| Timeout for heartbeats between cluster members. Should be at least twice that of the interval |
| yes | no |
| This is the list of potential cluster members |
| yes | no |
| Timeout for joining a cluster |
| yes | no |
| Timeout for learning values |
| yes | no |
| Timeout for waiting for cluster leave to finish |
| yes | no |
| Timeout for taking locks |
| yes | no |
| Maximum number of connections a slave can have to the master |
| yes | no |
| Default timeout for all Paxos timeouts |
| yes | no |
| Timeout for Paxos phase 1 |
| yes | no |
| Timeout for Paxos phase 2 |
| yes | no |
| Interval of pulling updates from master |
| yes | no |
| Timeout for reading network data |
| yes | no |
| Id for a cluster instance. Must be unique within the cluster |
| yes | no |
| Where to bind High Availability protocol server |
| yes | no |
| Whether this instance should only participate as slave in cluster. If enabled it will never be elected as master |
| yes | no |
| Timeout for waiting for instance to become master or slave |
| yes | no |
| 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. |
| yes | no |
| 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 |
| yes | no |
| ZooKeeper session timeout. Only needed for rolling upgrade from 1.8 to 1.9 |
| yes | no |
| Determines whether any TransactionInterceptors loaded will intercept prepared transactions before they reach the logical log. |
| yes | no |
| 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. |
| yes | no |
| Configuration attribute |
| yes | no |
| 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. |
| yes | no |
| Enable loading kernel extensions |
| yes | no |
| The file where Neo4j will record memory mapping statistics. |
| yes | no |
| The number of records to be loaded between regular logging of memory mapping statistics. |
| yes | no |
| Tell Neo4j to regularly log memory mapping statistics. |
| yes | no |
| Threshold in bytes for when database logs (text logs, for debugging, that is) are rotated. |
| yes | no |
| Specifies at which file size the logical log will auto-rotate. 0 means that no rotation will automatically occur based on file size. Default is 25M |
| yes | no |
| 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. |
| yes | no |
| Target size for pages of mapped memory. |
| yes | no |
| 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. |
| yes | no |
| The size to allocate for memory mapping the node store. |
| yes | no |
| The size to allocate for memory mapping the array property store. |
| yes | no |
| The size to allocate for memory mapping the store for property key strings. |
| yes | no |
| The size to allocate for memory mapping the store for property key indexes. |
| yes | no |
| The size to allocate for memory mapping the property value store. |
| yes | no |
| The size to allocate for memory mapping the string property store. |
| yes | no |
| The size to allocate for memory mapping the relationship store. |
| yes | no |
| 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. |
| yes | no |
| The fraction of the heap (1%-10%) to use for the base array in the node cache (when using the gcr cache). |
| yes | no |
| The amount of memory to use for the node cache (when using the gcr cache). |
| yes | no |
| A list of property names (comma separated) that will be indexed by default. This applies to Nodes only. |
| yes | no |
| Enable support for running online backups |
| yes | no |
| Listening port for online backups. Replaced by online_backup_server |
| yes | no |
| Listening server for online backups |
| yes | no |
| Only allow read operations from this Neo4j instance. This mode still requires write access to the directory for lock purposes |
| yes | no |
| 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. |
| yes | no |
| 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. |
| yes | no |
| The fraction of the heap (1%-10%) to use for the base array in the relationship cache (when using the gcr cache). |
| yes | no |
| The amount of memory to use for the relationship cache (when using the gcr cache). |
| yes | no |
| How many relationships to read at a time during iteration |
| yes | no |
| A list of property names (comma separated) that will be indexed by default. This applies to Relationships only. |
| yes | no |
| Whether to enable logging to a remote server or not. |
| yes | no |
| Host for remote logging using LogBack SocketAppender. |
| yes | no |
| Port for remote logging using LogBack SocketAppender. |
| yes | no |
| Enable a remote shell server which shell clients can log in to |
| yes | no |
| The directory where the database files are located. |
| yes | no |
| 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. |
| yes | no |
| The name of the Transaction Manager service to use as defined in the TM service provider constructor. |
| yes | no |
| Tell Neo4j to use memory mapped buffers for accessing the native storage layer. |
| 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.management.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 on this instance since the database started |
| yes | no |
| The total number started transactions on this instance since the database started |
| yes | no |
| The number of currently open transactions |
| yes | no |
| The total number of rolled back transactions on this instance since the database started |
| yes | no |
| The highest number of transactions ever opened concurrently on this instance since the database started |
| 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 |
Copyright © 2013 Neo Technology