Arangoinspect

Arangoinspect is a command-line client tool that collects information of anyArangoDB server setup to facilitate troubleshooting for the ArangoDB support.

The tool is available starting from ArangoDB v3.3.11.

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

The resulting JSON file is a collection of meta data acquired from allinvolved 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 arenot 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, thereis only one. You can connect to any node in case of a cluster (DBServer,Coordinator, Agent).

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

This will start the tool with a prompt for the JWT secret and try to connectto the specified ArangoDB server. You have to type the secret as is used forthe arangod option —server.jwt-secret. For non-cluster deployments,you may authenticate with a user name and password instead:

  1. 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 informationand writes the result to arangodb-inspector.json, then exits:

  1. arangoinspect --server.endpoint tcp://127.0.0.1:8629
  3. Please specify the JWT secret: 
  4. Connected to ArangoDB 'http+tcp://127.0.0.1:8629' version: 3.4.devel [server], database: '_system', username: 'root'
  6.     _                                  ___                           _
  7.    / \   _ __ __ _ _ __   __ _  ___   |_ _|_ __  ___ _ __   ___  ___| |_ ___  _ __
  8.   / _ \ | '__/ _` | '_ \ / _` |/ _ \   | || '_ \/ __| '_ \ / _ \/ __| __/ _ \| '__|
  9.  / ___ \| | | (_| | | | | (_| | (_) |  | || | | \__ \ |_) |  __/ (__| || (_) | |
  10. /_/   \_\_|  \__,_|_| |_|\__, |\___/  |___|_| |_|___/ .__/ \___|\___|\__\___/|_|
  11.                          |___/                      |_|                         
  13. 2018-06-05T19:40:10Z [19858] INFO Connected to ArangoDB 'http+tcp://[::1]:4001', version 3.4.devel [server], database '_system', username: 'root'
  14. 2018-06-05T19:40:10Z [19858] INFO Connected to ArangoDB 'http+tcp://[::1]:4001', version 3.4.devel [server], database '_system', username: 'root'
  15. INFO changing endpoint for AGNT-01e83a4b-8a51-4919-9f50-ff640accb9fa from http+tcp://[::1]:4001 to tcp://[::1]:4001
  16. INFO changing endpoint for PRMR-9f5b337e-c1de-4b7d-986a-d6ad2eb8f857 from tcp://127.0.0.1:8629 to tcp://[::1]:8629
  17. INFO Analysing agency dump ...
  18. INFO Plan (version 22)
  19. INFO   Databases
  20. INFO     _system
  21. INFO   Collections
  22. INFO     _system
  23. INFO       _graphs
  24. INFO       _users
  25. INFO       _modules
  26. INFO       _iresearch_analyzers
  27. INFO       _routing
  28. INFO       _aqlfunctions
  29. INFO       _frontend
  30. INFO       _queues
  31. INFO       _jobs
  32. INFO       _apps
  33. INFO       _appbundles
  34. INFO       _statisticsRaw
  35. INFO       _statistics
  36. INFO       _statistics15
  37. INFO Server health
  38. INFO   DB Servers
  39. INFO     PRMR-9f5b337e-c1de-4b7d-986a-d6ad2eb8f857(DBServer0001)
  40. INFO     PRMR-90ff8c20-b0f3-49c5-a5dd-7b186bb7db33(DBServer0002)
  41. INFO   Coordinators
  42. INFO     CRDN-0dbf16ec-8a06-4203-9359-447d97757b4e(Coordinator0001)
  43. INFO Supervision activity
  44. INFO   Jobs: undefined(To do: 0, Pending: 0, Finished: 0, Failed: 0)
  45. INFO Summary
  46. INFO   1 databases
  47. INFO   14 collections 
  48. INFO   14 shards 
  49. INFO ... agency analysis finished.
  50. INFO Collecting diagnostics from all servers ... 
  51. 2018-06-05T19:40:10Z [19858] INFO Connected to ArangoDB 'http+tcp://[::1]:8629', version 3.4.devel [server], database '_system', username: 'root'
  52. 2018-06-05T19:40:11Z [19858] INFO Connected to ArangoDB 'http+tcp://[::1]:4001', version 3.4.devel [server], database '_system', username: 'root'
  53. 2018-06-05T19:40:11Z [19858] INFO Connected to ArangoDB 'http+tcp://[::1]:8630', version 3.4.devel [server], database '_system', username: 'root'
  54. 2018-06-05T19:40:11Z [19858] INFO Connected to ArangoDB 'http+tcp://[::1]:8530', version 3.4.devel [server], database '_system', username: 'root'
  55. 2018-06-05T19:40:11Z [19858] INFO Connected to ArangoDB 'http+tcp://[::1]:4001', version 3.4.devel [server], database '_system', username: 'root'
  56. INFO ... dignostics collected.
  57. INFO Report written to arango-inspector.json.

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

  1. Could not connect to endpoint 'http+tcp://127.0.0.1:8529', database: '_system', username: 'root'
  2. Error message: '401: Unauthorized'
  4.     _                                  ___                           _
  5.    / \   _ __ __ _ _ __   __ _  ___   |_ _|_ __  ___ _ __   ___  ___| |_ ___  _ __
  6.   / _ \ | '__/ _` | '_ \ / _` |/ _ \   | || '_ \/ __| '_ \ / _ \/ __| __/ _ \| '__|
  7.  / ___ \| | | (_| | | | | (_| | (_) |  | || | | \__ \ |_) |  __/ (__| || (_) | |
  8. /_/   \_\_|  \__,_|_| |_|\__, |\___/  |___|_| |_|___/ .__/ \___|\___|\__\___/|_|
  9.                          |___/                      |_|                         
  11. FATAL cannot connect to server 'http+tcp://127.0.0.1:8529': 401: Unauthorized