neo4j-health-check-plugin

Health Check Plugin for Neo4j

License	GNU General Public License (GPL) version 3.0
Categories	Neo4J Data Databases
GroupId	com.brinkus.labs
ArtifactId	neo4j-health-check-plugin
Last Version	1.0.0
Release Date	Sep 29, 2016
Type	jar
Description	neo4j-health-check-plugin Health Check Plugin for Neo4j
Project URL	https://github.com/bbrinkus/neo4j-health-check-plugin.git
Source Code Management	https://github.com/bbrinkus/neo4j-health-check-plugin

Download neo4j-health-check-plugin

Filename	Size
neo4j-health-check-plugin-1.0.0.pom
neo4j-health-check-plugin-1.0.0.jar	1 MB
neo4j-health-check-plugin-1.0.0-sources.jar	8 KB
neo4j-health-check-plugin-1.0.0-javadoc.jar	55 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.brinkus.labs/neo4j-health-check-plugin/ -->
<dependency>
    <groupId>com.brinkus.labs</groupId>
    <artifactId>neo4j-health-check-plugin</artifactId>
    <version>1.0.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.brinkus.labs/neo4j-health-check-plugin/
implementation 'com.brinkus.labs:neo4j-health-check-plugin:1.0.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.brinkus.labs/neo4j-health-check-plugin/
implementation ("com.brinkus.labs:neo4j-health-check-plugin:1.0.0")

Apache Buildr

'com.brinkus.labs:neo4j-health-check-plugin:jar:1.0.0'

Apache Ivy

<dependency org="com.brinkus.labs" name="neo4j-health-check-plugin" rev="1.0.0">
  <artifact name="neo4j-health-check-plugin" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.brinkus.labs', module='neo4j-health-check-plugin', version='1.0.0')
)

Scala SBT

libraryDependencies += "com.brinkus.labs" % "neo4j-health-check-plugin" % "1.0.0"

Leiningen

[com.brinkus.labs/neo4j-health-check-plugin "1.0.0"]

Dependencies

compile (1)

Group / Artifact	Type	Version
com.fasterxml.jackson.core : jackson-databind	jar	2.7.4

provided (1)

Group / Artifact	Type	Version
org.neo4j : server-api	jar	3.0.4

test (4)

Group / Artifact	Type	Version
junit : junit	jar	4.12
org.hamcrest : hamcrest-library	jar	1.3
org.mockito : mockito-all	jar	1.10.19
org.neo4j.test : neo4j-harness	jar	3.0.4

Project Modules

There are no modules declared in this project.

Health Check Plugin for Neo4j

Query result

The health check has 4 different results depending from the server's state:

• UP
  • The server is up and running. Also the server has nodes.
  • {"status":"UP","description":"Neo4j health check was success."}
• OUT_OF_SERVICE
  • The server is up and running but it has 0 nodes.
  • {"status":"OUT_OF_SERVICE","description":"Neo4j has no available node!"}
• DOWN
  • The server is not available.
  • {"status":"DOWN","description":"Neo4j health check result was invalid!"}
• OUT_OF_SERVICE
  • An error occurred during the query state.
  • {"status":"OUT_OF_SERVICE","description":"Neo4j health check failed!","error":"java.lang.NullPointerException: detail"}

Installation

Neo4j (3.0+)

NEO4J_HOME/conf/neo4j.conf

dbms.security.auth_enabled=false
dbms.unmanaged_extension_classes=com.brinkus.labs.neo4j.health.unmanaged=/labs

Neo4j (<3.0)

NEO4J_HOME/conf/neo4j-server.properties

dbms.security.auth_enabled=false
org.neo4j.server.thirdparty_jaxrs_classes=com.brinkus.labs.neo4j.health.unmanaged=/labs

Versions

Version
1.0.0 Sep 29, 2016