New announcements for Serverless, Network, RUM, and more from Dash! New announcements from Dash!

Neo4j

Agent Check Agent Check

Supported OS: Linux Mac OS Windows

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

neo4j.arraystore.size
(gauge)
The size of the array store
shown as unit
neo4j.bytes.read
(gauge)
The total number of bytes read
shown as unit
neo4j.bytes.written
(gauge)
The total number of bytes written
shown as unit
neo4j.dbms.memory.pagecache.size
(gauge)
Memory Pagecache Size
shown as unit
neo4j.page.cache.evictionexceptions
(gauge)
The total number of eviction exceptions
shown as unit
neo4j.page.cache.evictions
(gauge)
The total number of page evictions executed by the page cache.
shown as unit
neo4j.page.cache.faults
(gauge)
The total number of faults.
shown as unit
neo4j.page.cache.filemappings
(gauge)
The total number of file mappings.
shown as unit
neo4j.page.cache.fileunmappings
(gauge)
The total number of file unmappings.
shown as unit
neo4j.page.cache.flushes
(gauge)
The total number of flushes executed by the page cache.
shown as unit
neo4j.ha.pull_interval
(gauge)
The HA Pull Time Interval
shown as unit
neo4j.kernel.starttime
(gauge)
Time when the kernel started
shown as second
neo4j.kernel.version
(gauge)
The kernel version
shown as unit
neo4j.last.committed.transaction.id
(gauge)
The last committed transaction id.
shown as unit
neo4j.locks
(gauge)
The total number of locks.
shown as unit
neo4j.logicallog.size
(gauge)
The logical log size setting.
shown as unit
neo4j.memorypools
(gauge)
The size of memory pools.
shown as unit
neo4j.node.store.size
(gauge)
The size of the node store.
shown as unit
neo4j.averteddeadlocks
(gauge)
The total number of averted deadlocks.
shown as unit
neo4j.committedtransactions
(gauge)
The total number of committed transactions.
shown as unit
neo4j.nodeidsinuse
(gauge)
The total number of node ids in use.
shown as unit
neo4j.opened.transactions
(gauge)
The total number of opened transactions.
shown as unit
neo4j.open.transactions
(gauge)
The total number of open transactions.
shown as unit
neo4j.property.ids.inuse
(gauge)
The total number of property ids in use.
shown as unit
neo4j.relationship.ids.inuse
(gauge)
The total number of relationship ids in use.
shown as unit
neo4j.relationshiptype.ids.inuse
(gauge)
The total number of relationship type ides in use.
shown as unit
neo4j.peak.rolledback.transactions
(gauge)
The total number of rolled back transactions.
shown as unit
neo4j.peak.concurrenttransactions
(gauge)
The peak number of concurrent transactions.
shown as unit
neo4j.pins
(gauge)
The total number of page pins executed by the page cache.
shown as unit
neo4j.property.store.size
(gauge)
The poperty store size.
shown as unit
neo4j.relationship.store.size
(gauge)
The relationship store size.
shown as unit
neo4j.store.creationdate
(gauge)
The store creation date.
shown as unit
neo4j.storeid
(gauge)
The store id.
shown as unit
neo4j.store.log.version
(gauge)
The store log version.
shown as unit
neo4j.string.store.size
(gauge)
The string store size.
shown as unit
neo4j.total.store.size
(gauge)
The total store size.
shown as unit

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.


Mistake in the docs? Feel free to contribute!