diff --git a/docs/user/masternodes/maintenance.rst b/docs/user/masternodes/maintenance.rst index c6ba63ef2..92162c1a7 100644 --- a/docs/user/masternodes/maintenance.rst +++ b/docs/user/masternodes/maintenance.rst @@ -240,6 +240,11 @@ Example:: protx revoke 9f5ec7540baeefc4b7581d88d236792851f26b4b754684a31ee35d09bdfb7fb6 565950700d7bdc6a9dbc9963920bc756551b02de6e4711eff9ba6d4af59c0101 0 +Dashmate troubleshooting +======================== + +If you have trouble with a dashmate-based masternode, use the ``dashmate doctor`` command to collect +debug information for troubleshooting. See the :ref:`dashmate page ` for details. Proof of Service Bans ===================== diff --git a/docs/user/network/dashmate/img/dashmate-doctor-details.png b/docs/user/network/dashmate/img/dashmate-doctor-details.png new file mode 100644 index 000000000..537ef4b18 Binary files /dev/null and b/docs/user/network/dashmate/img/dashmate-doctor-details.png differ diff --git a/docs/user/network/dashmate/img/dashmate-doctor-done.png b/docs/user/network/dashmate/img/dashmate-doctor-done.png new file mode 100644 index 000000000..1203f723d Binary files /dev/null and b/docs/user/network/dashmate/img/dashmate-doctor-done.png differ diff --git a/docs/user/network/dashmate/index.rst b/docs/user/network/dashmate/index.rst index c40c2ca0d..25c311dea 100644 --- a/docs/user/network/dashmate/index.rst +++ b/docs/user/network/dashmate/index.rst @@ -368,6 +368,39 @@ existing data is retained. Then, update the dashmate services:: Finally, restart dashmate:: dashmate start + +.. _dashmate-doctor: + +Collecting logs +=============== + +Dashmate includes the doctor command to make troubleshooting and log reporting easier. The dashmate +doctor command collects important debugging data about the masternode and creates a compressed report file +that can be sent to the support team if necessary. This report includes: + +- **Operating System**: Details about the architecture, CPU, memory, and swap +- **Docker**: Status and logs (exit codes, stdout, stderr) for each service +- **Core RPC**: Essential details like the best ChainLock, quorums, blockchain information, peers, and masternode status +- **Tenderdash RPC**: Status, genesis, network information, ABCI details, and a consensus state dump +- **Metrics**: Tenderdash and Drive metrics (if enabled in the configuration) + +To create a report, run ``dashmate doctor`` and select **Yes**:: + + dashmate doctor + +.. figure:: img/dashmate-doctor-details.png + :align: center + :width: 90% + + Run the doctor command + +Upon successful completion, the full path to the report archive is displayed. + +.. figure:: img/dashmate-doctor-done.png + :align: center + :width: 90% + + Doctor output Additional Information ======================