12.1.3. Metrics reference

This section provides a listing of available metrics.

This section describes the following:

12.1.3.1. General-purpose metrics

Table 12.1. Database store size metrics
Name Description

<prefix>.store.size.total

The total size of the database store

Table 12.2. Database checkpointing metrics
Name Description

<prefix>.check_point.events

The total number of check point events executed so far.

<prefix>.check_point.total_time

The total time spent in check pointing so far.

<prefix>.check_point.duration

The duration of the last check point event.

Table 12.3. Database data metrics
Name Description

<prefix>.ids_in_use.relationship_type

The total number of different relationship types stored in the database.

<prefix>.ids_in_use.property

The total number of different property names used in the database.

<prefix>.ids_in_use.relationship

The total number of relationships stored in the database.

<prefix>.ids_in_use.node

The total number of nodes stored in the database.

Table 12.4. Database page cache metrics
Name Description

<prefix>.page_cache.eviction_exceptions

The total number of exceptions seen during the eviction process in the page cache.

<prefix>.page_cache.flushes

The total number of flushes executed by the page cache.

<prefix>.page_cache.unpins

The total number of page unpins executed by the page cache.

<prefix>.page_cache.pins

The total number of page pins executed by the page cache.

<prefix>.page_cache.evictions

The total number of page evictions executed by the page cache.

<prefix>.page_cache.page_faults

The total number of page faults happened in the page cache.

<prefix>.page_cache.hits

The total number of page hits happened in the page cache.

<prefix>.page_cache.hit_ratio

The ratio of hits to the total number of lookups in the page cache.

<prefix>.page_cache.usage_ratio

The ratio of number of used pages to total number of available pages.

Table 12.5. Database transaction metrics
Name Description

<prefix>.transaction.started

The total number of started transactions.

<prefix>.transaction.peak_concurrent

The highest peak of concurrent transactions.

<prefix>.transaction.active

The number of currently active transactions.

<prefix>.transaction.active_read

The number of currently active read transactions.

<prefix>.transaction.active_write

The number of currently active write transactions.

<prefix>.transaction.committed

The total number of committed transactions.

<prefix>.transaction.committed_read

The total number of committed read transactions.

<prefix>.transaction.committed_write

The total number of committed write transactions.

<prefix>.transaction.rollbacks

The total number of rolled back transactions.

<prefix>.transaction.rollbacks_read

The total number of rolled back read transactions.

<prefix>.transaction.rollbacks_write

The total number of rolled back write transactions.

<prefix>.transaction.terminated

The total number of terminated transactions.

<prefix>.transaction.terminated_read

The total number of terminated read transactions.

<prefix>.transaction.terminated_write

The total number of terminated write transactions.

<prefix>.transaction.last_committed_tx_id

The ID of the last committed transaction.

<prefix>.transaction.last_closed_tx_id

The ID of the last closed transaction.

Table 12.6. Cypher metrics
Name Description

<prefix>.cypher.replan_events

The total number of times Cypher has decided to re-plan a query.

<prefix>.cypher.replan_wait_time

The total number of seconds waited between query replans.

Table 12.7. Database transaction log metrics
Name Description

<prefix>.log.rotation_events

The total number of transaction log rotations executed so far.

<prefix>.log.rotation_total_time

The total time spent in rotating transaction logs so far.

<prefix>.log.rotation_duration

The duration of the last log rotation event.

<prefix>.log.appended_bytes

The total number of bytes appended to transaction log.

Table 12.8. Bolt metrics
Name Description

<prefix>.bolt.sessions_started

The total number of Bolt sessions started since this instance started. This includes both succeeded and failed sessions (deprecated, use connections_opened instead).

<prefix>.bolt.connections_opened

The total number of Bolt connections opened since this instance started. This includes both succeeded and failed connections.

<prefix>.bolt.connections_closed

The total number of Bolt connections closed since this instance started. This includes both properly and abnormally ended connections.

<prefix>.bolt.connections_running

The total number of Bolt connections currently being executed.

<prefix>.bolt.connections_idle

The total number of Bolt connections sitting idle.

<prefix>.bolt.messages_received

The total number of messages received via Bolt since this instance started.

<prefix>.bolt.messages_started

The total number of messages that began processing since this instance started. This is different from messages received in that this counter tracks how many of the received messages havebeen taken on by a worker thread.

<prefix>.bolt.messages_done

The total number of messages that completed processing since this instance started. This includes successful, failed and ignored Bolt messages.

<prefix>.bolt.messages_failed

The total number of messages that failed processing since this instance started.

<prefix>.bolt.accumulated_queue_time

The accumulated time messages have spent waiting for a worker thread.

<prefix>.bolt.accumulated_processing_time

The accumulated time worker threads have spent processing messages.

Table 12.9. Database data count metrics
Name Description

<prefix>.neo4j.count.relationship

The total number of relationships in the database

<prefix>.neo4j.count.node

The total number of nodes in the database

Table 12.10. Server metrics
Name Description

<prefix>.server.threads.jetty.idle

The total number of idle threads in the jetty pool.

<prefix>.server.threads.jetty.all

The total number of threads (both idle and busy) in the jetty pool.

12.1.3.2. Metrics specific to Causal Clustering

Table 12.11. Core metrics
Name Description

<prefix>.causal_clustering.core.append_index

Append index of the RAFT log.

<prefix>.causal_clustering.core.commit_index

Commit index of the RAFT log.

<prefix>.causal_clustering.core.applied_index

Commit index of the RAFT log.

<prefix>.causal_clustering.core.term

RAFT Term of this server.

<prefix>.causal_clustering.core.tx_retries

Transaction retries.

<prefix>.causal_clustering.core.is_leader

Is this server the leader?

<prefix>.causal_clustering.core.in_flight_cache.total_bytes

In-flight cache total bytes.

<prefix>.causal_clustering.core.in_flight_cache.max_bytes

In-flight cache max bytes.

<prefix>.causal_clustering.core.in_flight_cache.element_count

In-flight cache element count.

<prefix>.causal_clustering.core.in_flight_cache.max_elements

In-flight cache maximum elements.

<prefix>.causal_clustering.core.in_flight_cache.hits

In-flight cache hits.

<prefix>.causal_clustering.core.in_flight_cache.misses

In-flight cache misses.

<prefix>.causal_clustering.core.message_processing_delay

Delay between RAFT message receive and process.

<prefix>.causal_clustering.core.message_processing_timer

Timer for RAFT message processing.

<prefix>.causal_clustering.core.discovery.replicated_data

Size of replicated data structures.

<prefix>.causal_clustering.core.replication_new

Raft replication new request count.

<prefix>.causal_clustering.core.replication_attempt

Raft replication attempt count.

<prefix>.causal_clustering.core.replication_fail

Raft Replication fail count.

<prefix>.causal_clustering.core.replication_maybe

Raft Replication maybe count.

<prefix>.causal_clustering.core.replication_success

Raft Replication success count.

<prefix>.causal_clustering.core.discovery.cluster.members

Discovery cluster member size.

<prefix>.causal_clustering.core.discovery.cluster.unreachable

Discovery cluster unreachable size.

<prefix>.causal_clustering.core.discovery.cluster.converged

Discovery cluster convergence.

Table 12.12. Read Replica Metrics
Name Description

<prefix>.causal_clustering.read_replica.pull_updates

The total number of pull requests made by this instance.

<prefix>.causal_clustering.read_replica.pull_update_highest_tx_id_requested

The highest transaction id requested in a pull update by this instance.

<prefix>.causal_clustering.read_replica.pull_update_highest_tx_id_received

The highest transaction id that has been pulled in the last pull updates by this instance.

12.1.3.3. Java Virtual Machine Metrics

These metrics are environment dependent and they may vary on different hardware and with JVM configurations. Typically these metrics will show information about garbage collections (for example the number of events and time spent collecting), memory pools and buffers, and finally the number of active threads running.

Table 12.13. GC metrics.
Name Description

<prefix>.vm.gc.time.%s

Accumulated garbage collection time in milliseconds.

<prefix>.vm.gc.count.%s

Total number of garbage collections.

Table 12.14. JVM memory buffers metrics.
Name Description

<prefix>.vm.memory.buffer.%s.count

Estimated number of buffers in the pool.

<prefix>.vm.memory.buffer.%s.used

Estimated amount of memory used by the pool.

<prefix>.vm.memory.buffer.%s.capacity

Estimated total capacity of buffers in the pool.

Table 12.15. JVM memory pools metrics.
Name Description

<prefix>.vm.memory.pool.%s

Estimated number of buffers in the pool.

Table 12.16. JVM threads metrics.
Name Description

<prefix>.vm.thread.count

Estimated number of active threads in the current thread group.

<prefix>.vm.thread.total

The total number of live threads including daemon and non-daemon threads.