Generate a report about the system

The neo4j-admin server report command collects information about the Neo4j deployment and saves it to an archive (ZIP/TAR) for remote assessments.

Syntax

The neo4j-admin server report command has the following syntax:

neo4j-admin server report [-h] [--expand-commands] [--list] [--verbose] [--ignore-disk-space-check
                          [=true|false]] [--obfuscate-query-log[=true|false]] [-a=<address>]
                          [--additional-config=<file>] [--database=<database>] [-p=<password>]
                          [--to-path=<path>] [-u=<username>] [<classifier>...] [COMMAND]

Description

The command collects information about the system and packages everything in an archive. If you specify all, everything is included. You can also fine-tune the selection by passing classifiers to the tool, e.g logs tx threads.

The Neo4j Admin report tool allows you to choose the databases for which you want to include database-specific information. You can generate a report covering all databases in the DBMS, a specific database, or databases that match a specified pattern. For example, if you run the command neo4j-admin server report --database=ne*, a report will be generated for all databases that start with "ne". If not specified, the tool generates a report for all databases in the DBMS.

The --database option determines from which database(s) the database-level information is collected. It does not influence the DBMS-level information, which is gathered based on the specified classifiers.

This tool does not send any information automatically. To share this information with the Neo4j Support organization, you have to send it manually.

Parameters

Table 1. `neo4j-admin server report` parameters
Parameter	Default
`[<classifier>…]`	`[config, logs, metrics, plugins, ps, sysprop, threads, tree, version]`

Table 2. Classifiers
Classifier	Online	Requires authentication Introduced in 2026.08	Description
`all`			Include all of the available classifiers.
`ccstate`			Include the current cluster state.
`databases`			Introduced in 2026.08 Include metadata about the databases.
`graphcounts`			Introduced in 2026.08 Include metadata about node labels, relationship types, indexes, and constraints.
`config`			Include Neo4j configuration files.
`heap`			Include a heap dump.
`indexes`			Introduced in 2026.08 Include detailed information about indexes.
`logs`			Include log files, e.g., debug.log, neo4j.log, etc.
`metrics`			Include the collected metrics.
`plugins`			Include a text view of the plugin directory (no files are collected).
`ps`			Include a list of running processes.
`raft`			Include the raft log.
`servers`			Introduced in 2026.08 Enterprise Edition Include information about the servers comprising the cluster.
`sysprop`			Include a list of Java system properties.
`threads`			Include a thread dump of the running instance.
`tree`			Include a text view of the folder structure of the data directory (no files are collected).
`tx`			Include transaction logs.

The classifiers marked as Online work only when you have a running Neo4j server that the tool can find. The classifiers marked as Requires authentication require you to provide authentication credentials to the running Neo4j server.

If no classifiers are specified, the following classifiers are used: logs, config, plugins, tree, metrics, threads, sysprop, ps, and version.

The reporting tool does not read any data from your database. However, the heap, the raft logs, and the transaction logs may contain data. Additionally, even though the standard neo4j.conf file does not contain password information, for specific configurations, it may have this type of information. Therefore, be aware of your organization’s data security rules before using the classifiers heap, tx, raft, and config.

Authenticated classifiers
Introduced in 2026.08

To provide necessary credentials for the classifiers that require authentication, it is recommended to use the --username option and specify the password interactively when prompted.

By default, the address is derived from the Neo4j configuration, but you can override it using the --address option.

In Neo4j Enterprise Edition, to create a role with the minimum required privileges to run the neo4j-admin server report command with all the authenticated classifiers, use the following Cypher statement:

CREATE ROLE adminReport;
GRANT EXECUTE ADMIN PROCEDURES ON DBMS TO adminReport;
GRANT SHOW SERVERS ON DBMS TO adminReport;
GRANT SHOW INDEXES ON DATABASE * TO adminReport;

Options

The neo4j-admin server report command has the following options:

Table 3. `neo4j-admin server report` options
Option	Description	Default
`-a, --uri, --address=<address>`	Introduced in 2026.08 Address of the DBMS to connect to, including the scheme (e.g. bolt://localhost:7687 or bolt+ssc://localhost:7687). Defaults to an address derived from the Neo4j configuration.
`--additional-config=<file>^[1]`	Configuration file with additional configuration.
`--database=<database>`	Name of the database to report for. Can contain * and ? for globbing. Note that * and ? have special meaning in some shells and might need to be escaped or used with quotes.	`*`
`--expand-commands`	Allow command expansion in config value evaluation.
`-h, --help`	Show this help message and exit.
`--ignore-disk-space-check[=true\|false]`	Ignore disk full warning.	`false`
`--list`	List all available classifiers.
`--obfuscate-query-log[=true\|false]`	Introduced in 2026.08 Obfuscate the literals of queries in the collected (JSON) query log.	`false`
`-p, --password=<password>`	Introduced in 2026.08 Password for connecting to the running DBMS. Required when a classifier that needs a connection to a live database is selected. Can be specified as the `NEO4J_PASSWORD` environment variable.
`--to-path=<path>`	Destination directory for reports. Defaults to a system tmp directory.
`-u, --username=<username>`	Introduced in 2026.08 Username for connecting to the running DBMS. Required when a classifier that needs a connection to a live database is selected. Can be specified as the `NEO4J_USERNAME` environment variable.
`--verbose`	Enable verbose output.
1. See Neo4j Admin and Neo4j CLI → Configuration for details.

By default, the tool tries to estimate the final size of the report and uses that to assert that there is enough disk space available for it. If there is not enough available space, the tool aborts. However, this estimation is pessimistic and does not consider compression. Therefore, if you are confident that you do have enough disk space, you can disable this check with the option --ignore-disk-space-check.

Usage

This tool uses the Java Attach API to gather data from a running Neo4j server. Therefore, it requires the Java JDK to run properly.

Invoke `neo4j-admin server report` using the default classifiers

The following command gathers information about the Neo4j server using the default classifiers and saves it to the default location:

bin/neo4j-admin server report

Invoke `neo4j-admin server report` using all classifiers

The following command interactively prompts for the password for user neo4j, gathers information about the Neo4j server using all classifiers, and saves it to a specified location:

bin/neo4j-admin server report --username=neo4j --to-path=./report all

Invoke `neo4j-admin server report` to gather only logs and thread dumps

The following command gathers only logs and thread dumps from the running Neo4j server and saves it to a specified location:

bin/neo4j-admin server report --to-path=./report threads logs

Obfuscate the query log
Enterprise EditionIntroduced in 2026.08

In Neo4j, it is possible to obfuscate sensitive literal values in the query log by setting db.logs.query.obfuscate_literals to true. However, there may be situations where you need the original query text, including literal values, to be available in your local query log. In such cases, you may choose not to enable query log obfuscation.

This introduces a potential risk when diagnostic data is shared outside your organization. For example, when creating a support package with neo4j-admin server report, the query log can be included in the collected data. If the query log contains unobfuscated literal values, sensitive information may be included in the support package.

To prevent this, use the --obfuscate-query-log option to mask the query log as part of data collection in neo4j-admin server report. This allows you to retain the original query text in your local query log while ensuring that sensitive literal values are obfuscated in the query log included in the support report.

Glossary

allocator: A component in the cluster that allocates databases to servers according to the topology constraints specified and an allocation strategy.
asynchronous replication: Asynchronous replication is used by secondary copies to poll for new transactions, which means they cannot be guaranteed to have received the most recent transactions. This enables efficient scale-out of read-performance.
Aura instance: A fully-managed DBMS represented by a single instance ID, that is running in the Neo4j Aura cloud.
auto-commit transaction: An automatically committed transaction that contains a single query.
Bolt protocol: Bolt is a protocol used for interaction between Neo4j instances and drivers.
bookmark: A marker the client can request from the cluster to ensure that it is able to read its own writes so that the application’s state is consistent and only databases that have a copy of the bookmark are permitted to respond.
category (Bloom): A category is based on a node label and is defined in a Perspective as a way of visually distinguishing nodes with the same label(s).
causal consistency: All servers in a cluster agree on the order in which transactions take place. The position of a server on the causal chain can be guaranteed using a bookmark.
cluster: A Neo4j DBMS that spans multiple servers working together to increase fault tolerance and/or read scalability. Databases on a cluster may be configured to replicate across servers in the cluster thus achieving read scalability or high availability.
client application: Software that interacts with a Neo4j server.
commit: A commit is the successful completion of a transaction, which ensures durability of any changes made. For more details, visit Operations Manual → Transaction management.
composite database: Composite databases are the means to access partitioned graph data with a single Cypher query.
constraint: Constraints are sets of data modeling rules that ensure the data is consistent and reliable.
Cypher®: Neo4j’s graph query language.
data model: A data model defines how information is organized in a database. A good data model will make querying and understanding your data easier. In Neo4j, the data models have a graph structure.
database: A database is a container used by the DBMS to manage and store graph data. The physical structure of data is controlled by the database.
database vs graph: Databases are the physical containers of graph data. Graphs are the logical structure of data in Neo4j.
Database Management System: Database Management System, or DBMS, capable of managing multiple databases. A DBMS may run on a single server, or span several servers configured as a cluster.
database schema: The prescribed property existence and datatypes for nodes and relationships.
deallocate: An act of removing a database from a server or a server from a cluster without loss of data or reduced fault tolerance.
degree (of a node): The number of relationships of a specific node; loops are counted twice.
disaster recovery: A manual intervention to restore availability of a cluster, or databases within a cluster.
driver: A software library that provides access to Neo4j from a particular programming language.
election: In the event that the Raft leader becomes unresponsive, followers automatically trigger an election and vote for a new leader.
entity: A node or a relationship.
expression (Cypher): A component of a Cypher query which produces values. It may be used in projections, as a predicate, or when setting properties on graph elements.
fabric: Fabric is the architectural design of a unified system that provides a single access point to local or distributed graph data.
fault tolerance: A guarantee that a cluster can maintain a database’s persistence and availability in the event of one or more servers failing.
follower: A primary copy of a database acting as a follower, receives and acknowledges synchronous writes from the leader.
Generative AI (GenAI): A type of artificial intelligence (AI) system that generates text, images, or other media in response to prompts.
graph: A logical representation of a set of nodes where some pairs are connected by relationships.
index: Data structure that improves read performance of a database.
knowledge graph: A specific type of graph that has an organizing principle so that a user (or a computer system) can reason about the underlying data. The organizing principle provides an additional layer of structure that adds context to support knowledge discovery.
label: Marks a node as a member of a named and indexed subset. A node may be assigned zero or more labels.
leader: A single primary copy of a database is designated as the leader. It receives all write transactions from clients and replicates writes synchronously to followers and asynchronously to secondary copies of the database.
main database: In terms of Neo4j Enterprise Studio, the database(s) containing the user’s data. Can exist in the same Neo4j deployment as the tool asset database.
motif: A description of a specific pattern within a graph.
node: A node represents an entity or discrete object in your graph data model. Nodes can be connected by relationships, hold data in properties, and are classified by labels.
operator: A symbol representing a mathematical or logical operation.
parameter: Named value provided when running a Cypher statement.
path: A sequence of nodes and the relationships connecting them, that does not contain duplicate relationships. Several paths can match a pattern.
pattern: A specific arrangement of nodes and relationships that can be matched in a graph. A pattern follows a motif.
perspective (Bloom): A Perspective defines a certain business view or domain that can be found in the target Neo4j graph. A single Neo4j graph can be viewed through different Perspectives, each tailored for a different business purpose.
primary: A copy of the database that is able to process write transactions and is eligible to be elected as a leader. It participates in fault tolerant writes as it is part of the majority required to acknowledge and commit write transactions.
primary vs secondary: In a cluster, databases can operate in either primary or secondary mode. Primary databases are able to process write and read transactions, ensuring fault tolerance. Secondary databases are replicated asynchronously from primaries, and their main purpose is to provide read scaling within the cluster.
project (Aura): An isolated environment in the unified Aura console that contains its own database instances, configurations, and resources. Preceded by tenant in the classic Aura console.
property: Properties are key-value pairs that are used for storing data on nodes and relationships.
query (Cypher): A statement that retrieves or writes information to a database.
Raft group: A group of servers that are participating in hosting a particular database in primary mode.
Raft group member: A server that is participating in a Raft group. A server can be a member of one or more groups.
Raft log: A shared log between all Raft group members that is guaranteed to be consistently updated and viewed by those members. The log contains both database data and operational state of the Raft group.
Raft protocol: The networking mechanism that enables a database to replicate its data across multiple servers to give high availability for accessing the data and high durability to the data stored.
read scaling: Distributing query load by creating additional database copies hosted in secondary mode (read-only).
relationship: A relationship represents a connection between nodes in your graph data model. Relationships connect a source node to a target node, hold data in properties, and are classified by type.
secondary: An asynchronously replicated copy of the database that provides read scaling within the cluster.
seed: A seed is a database dump or a full backup used to create a database on a cluster. This is sometimes called seeding.
server: A physical machine, a virtual machine, or a container running an instance of Neo4j. Servers can be standalone or part of a cluster.
session: A causally linked sequence of transactions.
session consistency: An alternative name for Neo4j’s causal consistency.
standalone: A single server running Neo4j and not part of a cluster.
synchronous replication: Synchronous replication requires the leader primary to replicate a transaction and block the commit until a quorum of the follower primaries acknowledges that the transaction is successfully replicated. Once the transaction is replicated, the commit is allowed to proceed. This ensures data durability and consistency within the cluster.
system database: A database used by Neo4j to store system information.
tenant (Aura): An isolated environment in the classic Aura console that contains its own database instances, configurations, and resources. Replaced by project in the unified Aura console.
tool asset database: In terms of Neo4j Enterprise Studio, the database where tools' assets are stored. This can be in the same Neo4j deployment as the main database(s) or in a separate deployment.
topology: A configuration that describes how the copies of a database should be spread across the servers in a cluster, see primary mode and secondary mode.
transaction: A transaction comprises a unit of work performed against a database. It is treated in a coherent and reliable way, independent of other transactions. Transactions comply with the ACID consistency model (atomic, consistent, isolated, and durable).