Your data. Anywhere you go.

New Relic for iOS or Android


Download on the App Store    Android App on Google play


New Relic Insights App for iOS


Download on the App Store


Learn more

Close icon

newrelic-neo4j

Neo4j performance monitor plugin for Newrelic


Description

The plugin monitors various metrics of your Neo4J database like hits, transactions, storage and cache.


Requirements

  • Neo4j Enterprise (Community edition also works but only reports database size)
  • NodeJS 4+

Installation

NodeJS

There are a number of ways to install node. Please look into NVM or N for a simple process

newrelic-neo4j

After installing Nodejs you run npm i -g newrelic-neo4j and it will install the plugin


Configuration

Please make sure that metrics options are turned on in Neo4j:

// default setting for enabling all supported metrics metrics.enabled=true

// default setting for enabling all Neo4j specific metrics metrics.neo4j.enabled=true

// setting for exposing metrics about transactions; number of transactions started, committed, etc. metrics.neo4j.tx.enabled=true

// setting for exposing metrics about the Neo4j page cache; page faults, evictions, flushes and exceptions, etc. metrics.neo4j.pagecache.enabled=true

// setting for exposing metrics about approximately entities are in the database; nodes, relationships, properties, etc. metrics.neo4j.counts.enabled=true

// setting for exposing metrics about the network usage of the HA cluster component metrics.neo4j.network.enabled=true

More info about Neo4j metrics here


When installing, the plugin will attempt to copy a config file to /etc/newrelic/newrelic-neo4j.js. In the file you will find:

module.exports = {

// This is where you enter your license key
license: "LICENSE KEY",

// This is the name of the reporter
name: "Database Name",

// The database REST URL (usually http://domain.tld:7474 or https://domain.tld:7473)
url: "Database URL",

// OPTIONAL Set if the database requires an username and a password
auth: {
    user: "neo4j",
    pass: "neo4j"
},

// Reporitng interval
interval: 60

};


Usage

After installing and configuring you can simply run:

newrelic-neo4j

and it will attempt to read the config file from /etc/newrelic/newrelic-neo4j.js.

The options are:

-h, --help      To see the options
-c, --config    To point to another config file
-f, --fork      To start the process as a daemon
-o, --out       To write log to an output file besides stdout stream

Support

For bugs and/or feature requests please refer to the Github page.


Sources

Sources can be found here


License

newrelic-neo4j plugin reporter is offered under MIT license. Please refer to this page for more info.

The Neo4j plugin extends the power of New Relic's monitoring capabilities.


Get This Plugin

Already have a New Relic account? Log in and begin using this plugin.

If you don't have a New Relic account, follow these three simple steps:

How To Install A Plugin

Installing a plugin is simple and fast.

Installing
a Plugin
  1. Step One

    Sign in to your New Relic account

  2. Step Two

    Select and install plugin

  3. Step Three

    Start seeing data

That’s it. You’re done. Simple.

Sign Up for New Relic

Back to top icon