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