Skip to content

Files

Latest commit

36029c4 · Feb 12, 2020

History

History
This branch is 2120 commits behind DataDog/integrations-extras:master.

neo4j

Neo4j Integration

Overview

Get metrics from Neo4j service in real time to:

  • Visualize and monitor Neo4j states.
  • Be notified about Neo4j failovers and events.

Setup

The Neo4j check is NOT included in the Datadog Agent package.

Installation

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:

  1. Install the developer toolkit.

  2. Clone the integrations-extras repository:

    git clone https://github.com/DataDog/integrations-extras.git.
  3. Update your ddev config with the integrations-extras/ path:

    ddev config set extras ./integrations-extras
  4. To build the neo4j package, run:

    ddev -e release build neo4j
  5. Download and launch the Datadog Agent.

  6. 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
  7. Configure your integration like any other packaged integration.

Configuration

  1. 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 metrics. See the sample neo4j.d/conf.yaml for all available configuration options.

  2. Restart the Agent

Validation

Run the Agent's status subcommand and look for neo4j under the Checks section.

Data Collected

Metrics

See metadata.csv for a list of metrics provided by this check.

Events

The Neo4j check does not include any events.

Service Checks

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.

Troubleshooting

Need help? Contact Datadog support.