ArangoDB v4.x is under development and not released yet.

This documentation is not final and potentially incomplete.

arangoinspect Examples

How to use the arangoinspect tool to collection information for troubleshooting

If you are asked by Arango support to provide an inspector output, run the arangoinspect binary to generate a file in the current working folder.

The resulting JSON file is a collection of meta data acquired from all involved instances. The data includes relevant operating system parameters, ArangoDB process parameters, local database information etc.

Please open the file locally and check if it contains anything that you are not allowed/willing to share and obfuscate it before sharing (user names, files paths etc.).

Invoking arangoinspect

Point the tool to an ArangoDB endpoint. In case of a single server, there is only one. You can connect to any node in case of a cluster (DB-Server, Coordinator, Agent).

arangoinspect --server.endpoint tcp://127.0.0.1:8529

This starts the tool with a prompt for the JWT secret and tries to connect to the specified ArangoDB server. You have to type the secret as is used for the arangod option --server.jwt-secret. For non-cluster deployments, you may authenticate with a user name and password (or access token) instead:

arangoinspect --server.ask-jwt-secret false --server.username "root" --server.password "foobar"

The password can be omitted and entered interactively.

Example outputs

If arangoinspect succeeds to authenticate, it starts to gather information and writes the result to arangodb-inspector.json, then exits:

arangoinspect --server.endpoint tcp://127.0.0.1:9730

Please specify the JWT secret: 
Connected to ArangoDB 'http+tcp://localhost:9730, version: 4.0.0 [COORDINATOR, unknown mode], database: '_system', username: 'root'

    _                                  ___                           _
   / \   _ __ __ _ _ __   __ _  ___   |_ _|_ __  ___ _ __   ___  ___| |_ ___  _ __
  / _ \ | '__/ _` | '_ \ / _` |/ _ \   | || '_ \/ __| '_ \ / _ \/ __| __/ _ \| '__|
 / ___ \| | | (_| | | | | (_| | (_) |  | || | | \__ \ |_) |  __/ (__| || (_) | |
/_/   \_\_|  \__,_|_| |_|\__, |\___/  |___|_| |_|___/ .__/ \___|\___|\__\___/|_|
                         |___/                      |_|

INFO changing endpoint for CRDN-803fd418-f44e-4e7e-8e1e-5e3c0b6c5a0e from undefined to tcp://localhost:9730
INFO Analysing agency dump ...
INFO Plan (version 10)
INFO   Databases
INFO     _system
INFO   Collections
INFO     _system
INFO       _users
INFO       _graphs
INFO       _analyzers
INFO Server health
INFO   DB Servers
INFO     PRMR-933e8aaf-0e07-4379-a38e-735f100fe4f7(DBServer0003)
INFO     PRMR-0e53c515-d46e-46dd-8e2a-84be01727ec2(DBServer0002)
INFO     PRMR-3b6d09c4-8975-43e9-8648-cf9fe5fbefaa(DBServer0001)
INFO   Coordinators
INFO     CRDN-803fd418-f44e-4e7e-8e1e-5e3c0b6c5a0e(Coordinator0002)
INFO Supervision activity
INFO   Jobs: undefined(To do: 0, Pending: 0, Finished: 0, Failed: 0)
INFO Summary
INFO   1 databases
INFO   3 collections
INFO   3 shards
INFO ... agency analysis finished.
INFO Collecting diagnostics from all servers ...
INFO ... diagnostics collected.
INFO Report written to arango-inspector.json.

If arangoinspect cannot connect or authentication/authorization fails, then a fatal error is raised and the tool shuts down:

Could not connect to endpoint 'http+tcp://127.0.0.1:8529', database: '_system', username: 'root'
Error message: '401: Unauthorized'

    _                                  ___                           _
   / \   _ __ __ _ _ __   __ _  ___   |_ _|_ __  ___ _ __   ___  ___| |_ ___  _ __
  / _ \ | '__/ _` | '_ \ / _` |/ _ \   | || '_ \/ __| '_ \ / _ \/ __| __/ _ \| '__|
 / ___ \| | | (_| | | | | (_| | (_) |  | || | | \__ \ |_) |  __/ (__| || (_) | |
/_/   \_\_|  \__,_|_| |_|\__, |\___/  |___|_| |_|___/ .__/ \___|\___|\__\___/|_|
                         |___/                      |_|                         

FATAL cannot connect to server 'http+tcp://127.0.0.1:8529': 401: Unauthorized