Neo4j takes advantage of Datadog's monitoring capabilities, allowing users to effectively analyze and assess database performance. By integrating Neo4j metrics with Datadog, users gain valuable insights into their database's health and performance. This article provides step-by-step instructions for installing and configuring the Datadog Agent and Neo4j integration on various operating systems.

Datadog Agent Installation

Redhat Linux:

1. Log in to your Datadog App Console. The user interface will present navigation on the left side of the screen.

   

2. Click Integrations. To install the agent from the command line, click on the Agent tab at the top of the screen.

3. Open a command line and enter the one-step command line agent installation. Example -

   • DD_API_KEY=<KEY-STRING> DD_SITE="YourSite" DD_APM_INSTRUMENTATION_ENABLED=host bash -c "$(curl -L https://s3.amazonaws.com/dd-agent/scripts/install_script_agent7.sh)"

   • Replace KEY-STRING with your Datadog API key.
4. Start the Datadog Agent:

   • sudo systemctl start datadog-agent

macOS:

1. You can download the DMG package and install it (you will have to add your API key and the Datadog site in /opt/datadog-agent/etc/datadog.yaml):

   • api_key: <YOUR_API_KEY>
     site: <YOUR_DATADOG_SITE>

Neo4j Integration Installation and Configuration

Download and install the Datadog Agent as outlined in the previous section.

1. Install the Neo4j check on your host using the following command:

   • datadog-agent integration install -t datadog-neo4j==<INTEGRATION_VERSION>

   • Replace <INTEGRATION_VERSION> with the version available here.
   • 
2. Edit the /opt/datadog-agent/etc/conf.d/neo4j.d/conf.yaml file located in the conf.d/ folder at the root of your Agent's configuration directory. Refer to the attached conf.yaml for available configuration options.
3. 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.
4. Restart the Datadog Agent.

Dashboard Configuration

Datadog provides a default dashboard for Neo4j 4.x and several dashboards for 5.x. Utilize these dashboards to kickstart your monitoring efforts. Additionally, feel free to create your own dashboards to tailor the visualization of Neo4j metrics according to your specific needs.

Congratulations! You have successfully set up monitoring for Neo4j metrics using Datadog. Explore Datadog's dashboards and alerts to gain valuable insights into your Neo4j database's performance.

References

• Datadog-Neo4j Integration
• Datadog agent commands

You may also like

• How to monitor Neo4j with Prometheus