A Technical Healthcheck is an analysis of your Neo4j DBMS environment to highlight insights and actionable recommendations to improve the health and efficiency of your system.

 

It processes diagnostic reports generated by the Neo4j application, presenting the data in a way that facilitates analysis and decision-making.

 

What You Need to Do:

Step 1:

In order to get us the information we need to produce the Healthcheck Report, you simply need to run a command (from your terminal window):

$NEO4J_HOME/bin/neo4j-admin server report

This will create a zipped file with logs, metrics, thread dumps, configurations, etc, from your instance (if you are running a cluster, we need reports from all instances)*.

 

Notes:

• On Neo4j versions < 5, the command is : $NEO4J_HOME/bin/neo4j-admin report
• On Neo4j versions >= 2026.08 (or v5 versions >= 5.26.30), you can optionally collect additional information with the following command: $NEO4J_HOME/bin/neo4j-admin server report -u <user> -p <password> config logs metrics plugins ps sysprop threads tree version graphcounts databases indexes servers
  • This queries additional meta-data by connecting to the database, which is why it requires credentials.
  • It allows us to provide more detailed schema & query analysis in the Health Check report.

• With the options listed here, the neo4j-admin report tool only collects logs, metrics, configs & schema information ; no actual data is included. Depending on your configuration, query logs may include query parameters and hard-coded literal values. You can read more about this tool, as well as log obfuscation settings in our Operations Manual..

Step 2:

Upload each ZIP file produced by the neo4j-admin report command to sftp.healthcheck.neo4j.com, using the SFTP protocol & your Support Portal email + password to logon.  Do not encapsulate the report files in their own zip archive, please.

You can use any FTP client, like FileZilla or WinSCP...

... or the following command line :

sftp your.username@your.company.com@sftp.healthcheck.neo4j.com <<< $'put FILENAME'

Once this is uploaded, we will review and share the resulting report. 

Note: The SFTP server key fingerprint is SHA256:4tEakEubcurWB50oXJq1QIATiIkemdmVOSZUM9OJXZM

 

What You Will Get:

The report is quite extensive, and will provide a summary of insights in several areas, including:

• Configuration
• DBMS Analysis
• Database Analysis
• Query Analysis
• Metrics Analysis

It will look something like this:

 

If this is something you'd like to request, please email your dedicated account team!