Neo4j performance monitor plugin for Newrelic
The plugin monitors various metrics of your Neo4J database like hits, transactions, storage and cache.
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
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
};
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
For bugs and/or feature requests please refer to the Github page.
newrelic-neo4j
plugin reporter is offered under MIT license. Please refer to this page for more info.