Neo4j is an enterprise-strength graph database that combines native graph storage, advanced security, scalable speed-optimized architecture, and ACID compliance to ensure predictability and integrity of relationship-based queries. Neo4j stores and manages data in its more natural, connected state, maintaining data relationships that deliver lightning-fast queries, deeper context for analytics, and a pain-free modifiable data model.
Neo4j metrics enable database administrators to monitor their Neo4j deployments. DBAs want to understand the memory usage (heap and page cache), number of transactions, cluster status, database size (including number of nodes, relationsihps and properties), and query performance.
With this integration, visualize important Neo4j metrics in our out-of-the-box dashboards and enable your DBAs to troubleshoot and monitor the health of your Neo4j databases.
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.yamlfile, in theconf.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. -
Datadog listens on port 5000 for the dogstatsd_stats_port and expvar_port. In your neo4j.conf file, you will need to change the server.discovery.listen_address and the server.discovery.advertised_address to use a port other than 5000.
Run the Agent's status subcommand and look for neo4j under the Checks section.
The integration collects metrics through the neo4j prometheus endpoint. Ensure your neo4j edition supports the prometheus endpoint.
Neo4j Version 4 Neo4j 4 metrics are collected as documented here. The most commonly monitored metrics are provided in the out-of-the-box dashboards.
Neo4j Version 5 Neo4j 5 metrics are collected as documented here. The most commonly monitored metrics are provided in the out-of-the-box dashboards.
Please note each version collects a different set of metrics. The versions are listed in the description of the metric.
See metadata.csv for the full list of metrics provided by this check.
Service check neo4j.prometheus.health is submitted in the base check
Neo4j does not include any events.
Need help? Contact Neo4j support.