Supported OS
This check monitors neo4j through the Datadog Agent. Please verify the metrics and checks that are submitted through this agent. Since Neo4j 4.0 and onward supports multiple databases, some metrics and checks are no longer published.
Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the Autodiscovery Integration Templates for guidance on applying these instructions.
To install the neo4j check on your host:
Download and install the Datadog Agent.
To install the neo4j check on your host:
datadog-agent integration install -t datadog-neo4j==<INTEGRATION_VERSION>
Edit the neo4j.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your neo4j performance data. See the sample neo4j.d/conf.yaml for all available configuration options.
The neo4j_url has been replaced by host. Please ensure any updates use host.
Run the Agent’s status subcommand and look for neo4j under the Checks section.
| neo4j.bolt.accumulated_processing_time (gauge) | The accumulated time worker threads have spent processing messages. |
| neo4j.bolt.accumulated_queue_time (gauge) | The accumulated time messages have spent waiting for a worker thread. |
| neo4j.bolt.connections_closed (gauge) | The total number of Bolt connections closed since this instance started. This includes both properly and abnormally ended connections |
| neo4j.bolt.connections_idle (gauge) | The total number of Bolt connections sitting idle |
| neo4j.bolt.connections_opened (gauge) | The total number of Bolt connections opened since this instance started. This includes both succeeded and failed connections |
| neo4j.bolt.connections_running (gauge) | The total number of Bolt connections currently being executed |
| neo4j.bolt.messages_done (gauge) | The total number of messages that completed processing since this instance started. This includes successful and failed and ignored Bolt messages |
| neo4j.bolt.messages_failed (gauge) | The total number of messages that failed processing since this instance started |
| neo4j.bolt.messages_received (gauge) | The total number of messages received via Bolt since this instance started |
| neo4j.bolt.messages_started (gauge) | 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 have been taken on by a worker thread |
| neo4j.causal_clustering.catchup_tx_pull_requests_received (gauge) | Total number of received transaction pull requests. |
| neo4j.causal_clustering.core.append_index (gauge) | Append index of the RAFT log. |
| neo4j.causal_clustering.core.commit_index (gauge) | Commit index of the RAFT log. |
| neo4j.causal_clustering.core.discovery.cluster.converged (gauge) | Discovery cluster convergence. |
| neo4j.causal_clustering.core.discovery.cluster.members (gauge) | Discovery cluster member size. |
| neo4j.causal_clustering.core.discovery.cluster.unreachable (gauge) | Discovery cluster unreachable size. |
| neo4j.causal_clustering.core.discovery.replicated_data.member_data.invisible (gauge) | Invisible data structure containing metadata about cluster mem,bers. |
| neo4j.causal_clustering.core.discovery.replicated_data.member_data.visible (gauge) | Visible data structure containing metadata about cluster mem,bers. |
| neo4j.causal_clustering.core.discovery.replicated_data.member_db_state.invisible (gauge) | The hidden part of the data structure used for internal purposes. |
| neo4j.causal_clustering.core.discovery.replicated_data.member_db_state.visible (gauge) | The visible part of the data structure used for internal purpose,s. |
| neo4j.causal_clustering.core.discovery.replicated_data.per_db.leader_name.invisible (gauge) | The total number of leadership changes. |
| neo4j.causal_clustering.core.discovery.replicated_data.per_db.leader_name.visible (gauge) | Number of leaders in the cluster. |
| neo4j.causal_clustering.core.discovery.replicated_data.raft_id.published_by_member.invisible (gauge) | Visible Raft ID published by member. |
| neo4j.causal_clustering.core.discovery.replicated_data.raft_id.published_by_member.visible (gauge) | Hidden Raft ID published by member. |
| neo4j.causal_clustering.core.discovery.replicated_data.cluster_id.per_db_name.invisible (gauge) | Hidden identifier for the cluster. |
| neo4j.causal_clustering.core.discovery.replicated_data.cluster_id.per_db_name.visible (gauge) | Shared identifier for the cluster. |
| neo4j.causal_clustering.core.in_flight_cache_element_count (gauge) | In-flight cache element count. |
| neo4j.causal_clustering.core.in_flight_cache.hits (gauge) | In-flight cache hits. |
| neo4j.causal_clustering.core.in_flight_cache.max_bytes (gauge) | In-flight cache max bytes. |
| neo4j.causal_clustering.core.in_flight_cache.max_elements (gauge) | In-flight cache maximum elements. |
| neo4j.causal_clustering.core.in_flight_cache.misses (gauge) | In-flight cache misses. |
| neo4j.causal_clustering.core.in_flight_cache.total_bytes (gauge) | In-flight cache total bytes. |
| neo4j.causal_clustering.core.is_leader (gauge) | Is this server the leader? |
| neo4j.causal_clustering.core.message_processing_delay (gauge) | Delay between RAFT message receive and process. |
| neo4j.causal_clustering.core.message_processing_timer (gauge) | Timer for RAFT message processing. |
| neo4j.causal_clustering.core.message_processing_timer.append_entries_request (gauge) | Requests invoked by the RAFT leader to replicate log entries. |
| neo4j.causal_clustering.core.message_processing_timer.append_entries_response (gauge) | Responses from followers to the RAFT leader's requests to replicate log entries. |
| neo4j.causal_clustering.core.message_processing_timer.election_timeout (gauge) | Timeout events for processing of RAFT messages. |
| neo4j.causal_clustering.core.message_processing_timer.heartbeat (gauge) | Heartbeat requests received by followers in the RAFT cluster. |
| neo4j.causal_clustering.core.message_processing_timer.heartbeat_response (gauge) | Heartbeat responses received by the leader in the RAFT cluster. |
| neo4j.causal_clustering.core.message_processing_timer.heartbeat_timeout (gauge) | Timeout events for heartbeat requests. |
| neo4j.causal_clustering.core.message_processing_timer.log_compaction_info (gauge) | Log compaction |
| neo4j.causal_clustering.core.message_processing_timer.new_batch_request (gauge) | New batch requests |
| neo4j.causal_clustering.core.message_processing_timer.new_entry_request (gauge) | New entry requests |
| neo4j.causal_clustering.core.message_processing_timer.pre_vote_request (gauge) | Pre vote requests |
| neo4j.causal_clustering.core.message_processing_timer.pre_vote_response (gauge) | Pre vote responses |
| neo4j.causal_clustering.core.message_processing_timer.prune_request (gauge) | Prune requests |
| neo4j.causal_clustering.core.message_processing_timer.vote_request (gauge) | Vote requests |
| neo4j.causal_clustering.core.message_processing_timer.vote_response (gauge) | Vote responses |
| neo4j.causal_clustering.core.replication_attempt (gauge) | Raft replication attempt count. |
| neo4j.causal_clustering.core.replication_fail (gauge) | Raft Replication fail count. |
| neo4j.causal_clustering.core.replication_new (gauge) | Raft replication new request count. |
| neo4j.causal_clustering.core.replication_success (gauge) | Raft Replication success count. |
| neo4j.causal_clustering.core.term (gauge) | RAFT Term of this server |
| neo4j.causal_clustering.core.tx_retries (gauge) | Transaction retries. |
| neo4j.causal_clustering.read_replica.pull_updates (gauge) | The total number of pull requests made by this instance. |
| neo4j.causal_clustering.read_replica.pull_update_highest_tx_id_requested (gauge) | The highest transaction id requested in a pull update by this instance. |
| neo4j.causal_clustering.read_replica.pull_update_highest_tx_id_received (gauge) | The highest transaction id that has been pulled in the last pull update by this instance. |
| neo4j.check_point.events (gauge) | The total number of check point events executed so far. |
| neo4j.check_point.total_time (gauge) | The total time spent in check pointing so far. |
| neo4j.check_point.duration (gauge) | The duration of the last check point event. |
| neo4j.cypher.replan_events (gauge) | The total number of times Cypher has decided to re-plan a query. |
| neo4j.cypher.replan_wait_time (gauge) | The total number of seconds waited between query replans. |
| neo4j.node_count (gauge) | The total number of nodes. |
| neo4j.relationship_count (gauge) | The total number of relationships. |
| neo4j.ids_in_use.node (gauge) | The total number of nodes stored in the database. |
| neo4j.ids_in_use.property (gauge) | The total number of different property names used in the database. |
| neo4j.ids_in_use.relationship (gauge) | The total number of relationships stored in the database. |
| neo4j.ids_in_use.relationship_type (gauge) | The total number of different relationship types stored in the database. |
| neo4j.store.size.total (gauge) | The total size of the database and transaction logs. |
| neo4j.store.size.database (gauge) | The on disk size of the database. |
| neo4j.log.appended_bytes (gauge) | The total number of bytes appended to transaction log. |
| neo4j.log.rotation_events (gauge) | The total number of transaction log rotations executed so far. |
| neo4j.log.rotation_total_time (gauge) | The total time spent in rotating transaction logs so far. |
| neo4j.log.rotation_duration (gauge) | The duration of the last log rotation event. |
| neo4j.page_cache.eviction_exceptions (gauge) | The total number of exceptions seen during the eviction process in the page cache. |
| neo4j.page_cache.evictions (gauge) | The total number of page evictions executed by the page cache. |
| neo4j.page_cache.flushes (gauge) | The total number of flushes executed by the page cache. |
| neo4j.page_cache.hits (gauge) | The total number of page hits happened in the page cache. |
| neo4j.page_cache_hits_total (gauge) | The total number of page hits happened in the page cache. |
| neo4j.page_cache.page_faults (gauge) | The total number of page faults happened in the page cache. |
| neo4j.page_cache.pins (gauge) | The total number of page pins executed by the page cache. |
| neo4j.page_cache.unpins (gauge) | The total number of page unpins executed by the page cache. |
| neo4j.server.threads.jetty.all (gauge) | The total number of threads (both idle and busy) in the jetty pool. |
| neo4j.server.threads.jetty.idle (gauge) | The total number of idle threads in the jetty pool. |
| neo4j.transaction.active (gauge) | The number of currently active transactions. |
| neo4j.transaction.active_read (gauge) | The number of currently active read transactions. |
| neo4j.transaction.active_write (gauge) | The number of currently active write transactions. |
| neo4j.transaction.committed_read (gauge) | The total number of committed transactions. |
| neo4j.transaction.committed (gauge) | The total number of committed read transactions. |
| neo4j.transaction.committed_write (gauge) | The total number of committed write transactions. |
| neo4j.transaction.last_closed_tx_id (gauge) | The ID of the last closed transaction. |
| neo4j.transaction.last_committed_tx_id (gauge) | The ID of the last committed transaction. |
| neo4j.transaction.peak_concurrent (gauge) | The highest peak of concurrent transactions. |
| neo4j.transaction.rollbacks_read (gauge) | The total number of rolled back read transactions. |
| neo4j.transaction.rollbacks (gauge) | The total number of rolled back transactions. |
| neo4j.transaction.rollbacks_write (gauge) | The total number of rolled back write transactions. |
| neo4j.transaction.started (gauge) | The total number of started transactions. |
| neo4j.transaction.terminated_read (gauge) | The total number of terminated read transactions. |
| neo4j.transaction.terminated (gauge) | The total number of terminated transactions. |
| neo4j.transaction.terminated_write (gauge) | The total number of terminated write transactions. |
| neo4j.vm.gc.count.g1_old_generation (gauge) | Total number of garbage collections for old generation. |
| neo4j.vm.gc.count.g1_young_generation (gauge) | Total number of garbage collections for young generation. |
| neo4j.vm.gc.time.g1_old_generation (gauge) | Accumulated garbage collection time in milliseconds for old generation. |
| neo4j.vm.gc.time.g1_young_generation (gauge) | Accumulated garbage collection time in milliseconds for young generation. |
| neo4j.vm.memory.buffer.direct_capacity (gauge) | Estimated total capacity of direct buffers in the pool. |
| neo4j.vm.memory.buffer.direct_count (gauge) | Estimated number of direct buffers in the pool. |
| neo4j.vm.memory.buffer.direct_used (gauge) | Estimated amount of direct memory used by the pool. |
| neo4j.vm.memory.buffer.mapped_capacity (gauge) | Estimated total capacity of mapped buffers in the pool. |
| neo4j.vm.memory.buffer.mapped_count (gauge) | Estimated number of mapped buffers in the pool. |
| neo4j.vm.memory.buffer.mapped_used (gauge) | Estimated amount of mapped memory used by the pool. |
| neo4j.vm.memory.pool.compressed_class_space (gauge) | Estimated number of buffers in the compressed class space pool. |
| neo4j.vm.memory.pool.g1_eden_space (gauge) | Estimated number of buffers in the g1 eden space pool. |
| neo4j.vm.memory.pool.g1_old_gen (gauge) | Estimated number of buffers in the g1 old generation pool. |
| neo4j.vm.memory.pool.g1_survivor_space (gauge) | Estimated number of buffers in the g1 survivor space pool. |
| neo4j.vm.memory.pool.metaspace (gauge) | Estimated number of buffers in the metaspace pool. |
| neo4j.vm.thread.count (gauge) | Estimated number of active threads in the current thread group. |
| neo4j.vm.thread.total (gauge) | The total number of live threads including daemon and non-daemon threads. |
Service check neo4j.prometheus.health is submitted in the base check
neo4j does not include any events.
Need help? Contact Datadog support.