Get metrics from Neo4j service in real time to:
- Visualize and monitor Neo4j states.
- Be notified about Neo4j failovers and events.
The Neo4j check is NOT included in the Datadog Agent package.
If you are using Agent v6.8+ follow the instructions below to install the Neo4j check on your host. See our dedicated Agent guide for installing community integrations to install checks with the Agent prior v6.8 or the Docker Agent:
-
Install the developer toolkit.
-
Clone the integrations-extras repository:
git clone https://github.com/DataDog/integrations-extras.git.
-
Update your
ddev
config with theintegrations-extras/
path:ddev config set extras ./integrations-extras
-
To build the
neo4j
package, run:ddev -e release build neo4j
-
Run the following command to install the integrations wheel with the Agent:
datadog-agent integration install -w <PATH_OF_NEO4J_ARTIFACT_>/<NEO4J_ARTIFACT_NAME>.whl
-
Configure your integration like any other packaged integration.
-
Edit the
neo4j.d/conf.yaml
file in theconf.d/
folder at the root of your Agent's configuration directory to start collecting your Neo4j metrics. See the sample neo4j.d/conf.yaml for all available configuration options.
Run the Agent's status
subcommand and look for neo4j
under the Checks section.
See metadata.csv for a list of metrics provided by this check.
The Neo4j check does not include any events.
This Neo4j check tags all service checks it collects with:
server_name:<server_name_in_yaml>
url:<neo4j_url_in_yaml>
neo4j.can_connect
:
Returns CRITICAL
if the Agent fails to receive a 200 from the monitoring endpoint, otherwise returns OK
.
Need help? Contact Datadog support.