Knowledge Base

How to collect Neo4j logs

When raising Neo4j Support cases, it is important to upload Neo4j logs.

This allows the Neo4j Support Engineers to efficiently begin working on the support case.

If clustering is used, logs and configurations should be collected from all nodes in the cluster.

The following log files are usually required to troubleshoot support issues:

- debug.log.*
- neo4j.conf
- query.log.*

These log files should cover the time frame that issues or errors were observed.

The files are located by default within the folders ''$NEO4J_HOME/logs'' and ''$NEO4J_HOME/conf'' .

These files should be zipped and added to the support case.

In the case of large files above 25MB, notify the Neo4j Support Engineer and a secure location will be provided.

Other logs may be required during the course of a support case, since some files may be rotated by Neo4j it’s a good idea to store a copy of the following folders for further analysis:

- $NEO4J_HOME/data/cluster-state
- $NEO4J_HOME/data/transactions
- $NEO4J_HOME/metrics

These will be requested as required by Neo4j Support.

Deployment specific collection

There are many logging configurations in Neo4j, below are some options for locating logging configurations by deployment type.

Neo4j Standalone instance (Server / Container)

The default location for logs is $NEO4J_HOME/logs

Neo4j Embedded instance

The default location for logs is $NEO4J_HOME/logs, the same as the standalone deployment.

The log options mentioned under the standalone section apply for embedded as well, but the value of $NEO4J_HOME is defined within your application source code, and is usually the home directory provided to the Java class used to handle the Neo4j instance (for example Java class “DatabaseManagementServiceBuilder”).

Below is a list of files you can provide (the actual file location depends on the app configuration):

- Application logs (replacing the standard neo4j.log file)
- debug.log
- query.log