10.1.2. Metrics reference

This section provides a listing of available metrics.

This section describes the following:

10.1.2.1. General-purpose metrics

Table 10.1. Database checkpointing metrics
Name Description

neo4j.check_point.events

The total number of check point events executed so far

neo4j.check_point.total_time

The total time spent in check pointing so far

neo4j.check_point.check_point_duration

The duration of the check point event

Table 10.2. Database data metrics
Name Description

neo4j.ids_in_use.relationship_type

The total number of different relationship types stored in the database

neo4j.ids_in_use.property

The total number of different property names used in the database

neo4j.ids_in_use.relationship

The total number of relationships stored in the database

neo4j.ids_in_use.node

The total number of nodes stored in the database

Table 10.3. Database page cache metrics
Name Description

neo4j.page_cache.eviction_exceptions

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

neo4j.page_cache.flushes

The total number of flushes executed by the page cache

neo4j.page_cache.unpins

The total number of page unpins executed by the page cache

neo4j.page_cache.pins

The total number of page pins executed by the page cache

neo4j.page_cache.evictions

The total number of page evictions executed by the page cache

neo4j.page_cache.page_faults

The total number of page faults happened in the page cache

neo4j.page_cache.hits

The total number of page hits happened in the page cache

neo4j.page_cache.hit_ratio

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

neo4j.page_cache.usage_ratio

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

Table 10.4. Database transaction metrics
Name Description

neo4j.transaction.started

The total number of started transactions

neo4j.transaction.peak_concurrent

The highest peak of concurrent transactions

neo4j.transaction.active

The number of currently active transactions

neo4j.transaction.active_read

The number of currently active read transactions

neo4j.transaction.active_write

The number of currently active write transactions

neo4j.transaction.committed

The total number of committed transactions

neo4j.transaction.committed_read

The total number of committed read transactions

neo4j.transaction.committed_write

The total number of committed write transactions

neo4j.transaction.rollbacks

The total number of rolled back transactions

neo4j.transaction.rollbacks_read

The total number of rolled back read transactions

neo4j.transaction.rollbacks_write

The total number of rolled back write transactions

neo4j.transaction.terminated

The total number of terminated transactions

neo4j.transaction.terminated_read

The total number of terminated read transactions

neo4j.transaction.terminated_write

The total number of terminated write transactions

neo4j.transaction.last_committed_tx_id

The ID of the last committed transaction

neo4j.transaction.last_closed_tx_id

The ID of the last closed transaction

Table 10.5. Cypher metrics
Name Description

neo4j.cypher.replan_events

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

neo4j.cypher.replan_wait_time

The total number of seconds waited between query replans

Table 10.6. Database log rotation metrics
Name Description

neo4j.log_rotation.events

The total number of transaction log rotations executed so far

neo4j.log_rotation.total_time

The total time spent in rotating transaction logs so far

neo4j.log_rotation.log_rotation_duration

The duration of the log rotation event

Table 10.7. Bolt metrics
Name Description

neo4j.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).

neo4j.bolt.connections_opened

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

neo4j.bolt.connections_closed

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

neo4j.bolt.connections_running

The total number of Bolt connections currently being executed.

neo4j.bolt.connections_idle

The total number of Bolt connections sitting idle.

neo4j.bolt.messages_received

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

neo4j.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.

neo4j.bolt.messages_done

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

neo4j.bolt.messages_failed

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

neo4j.bolt.accumulated_queue_time

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

neo4j.bolt.accumulated_processing_time

The accumulated time worker threads have spent processing messages.

Table 10.8. Server metrics
Name Description

neo4j.server.threads.jetty.idle

The total number of idle threads in the jetty pool

neo4j.server.threads.jetty.all

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

10.1.2.2. Metrics specific to Causal Clustering

Table 10.9. Core metrics
Name Description

neo4j.causal_clustering.core.append_index

Append index of the RAFT log

neo4j.causal_clustering.core.commit_index

Commit index of the RAFT log

neo4j.causal_clustering.core.term

RAFT Term of this server

neo4j.causal_clustering.core.tx_retries

Transaction retries

neo4j.causal_clustering.core.is_leader

Is this server the leader?

neo4j.causal_clustering.core.in_flight_cache.total_bytes

In-flight cache total bytes

neo4j.causal_clustering.core.in_flight_cache.max_bytes

In-flight cache max bytes

neo4j.causal_clustering.core.in_flight_cache.element_count

In-flight cache element count

neo4j.causal_clustering.core.in_flight_cache.max_elements

In-flight cache maximum elements

neo4j.causal_clustering.core.in_flight_cache.hits

In-flight cache hits

neo4j.causal_clustering.core.in_flight_cache.misses

In-flight cache misses

neo4j.causal_clustering.core.message_processing_delay

Delay between RAFT message receive and process

neo4j.causal_clustering.core.message_processing_timer

Timer for RAFT message processing

neo4j.causal_clustering.core.replication_new

Raft replication new request count

neo4j.causal_clustering.core.replication_attempt

Raft replication attempt count

neo4j.causal_clustering.core.replication_success

Raft Replication success count

neo4j.causal_clustering.core.replication_fail

Raft Replication fail count

Table 10.10. Read Replica Metrics
Name Description

neo4j.causal_clustering.read_replica.pull_updates

The total number of pull requests made by this instance

neo4j.causal_clustering.read_replica.pull_update_highest_tx_id_requested

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

neo4j.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

10.1.2.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.