Skip to content

chore: remove removed debugging endpoint, toggle #949

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 0 additions & 18 deletions rest/debug.rst
Original file line number Diff line number Diff line change
@@ -1,24 +1,6 @@
Debug Endpoints
================

These endpoints require the :stconf:opt:`gui.debugging` configuration option to
be enabled and yield an access denied error code otherwise.


GET /rest/debug/peerCompletion
------------------------------

Summarizes the completion percentage for each remote device. Returns an object
with device IDs as keys and an integer percentage as values.


GET /rest/debug/httpmetrics
---------------------------

Returns statistics about each served REST API endpoint, to diagnose how much
time was spent generating the responses.


GET /rest/debug/cpuprof
-----------------------

Expand Down
1 change: 0 additions & 1 deletion rest/system-config-get.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,6 @@ Returns the current configuration.
"apiKey": "k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1",
"insecureAdminAccess": false,
"theme": "default",
"debugging": false,
"insecureSkipHostcheck": false,
"insecureAllowFrameLoading": false
},
Expand Down
9 changes: 2 additions & 7 deletions users/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ The following shows an example of a default configuration file (IDs will differ)
<untrusted>false</untrusted>
<remoteGUIPort>0</remoteGUIPort>
</device>
<gui enabled="true" tls="false" debugging="false">
<gui enabled="true" tls="false">
<address>127.0.0.1:8384</address>
<apikey>k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1</apikey>
<theme>default</theme>
Expand Down Expand Up @@ -814,7 +814,7 @@ GUI Element

.. code-block:: xml

<gui enabled="true" tls="false" debugging="false">
<gui enabled="true" tls="false">
<address>127.0.0.1:8384</address>
<apikey>k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1</apikey>
<theme>default</theme>
Expand All @@ -836,11 +836,6 @@ set on the ``gui`` element:
be redirected to HTTPS. When set to ``false``, TLS connections are
still possible but not required.

.. option:: gui.debugging

This enables :doc:`/users/profiling` and additional endpoints in the REST
API, see :doc:`/rest/debug`.

The following child elements may be present:

.. option:: gui.address
Expand Down
2 changes: 1 addition & 1 deletion users/faq-parts/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ For example, the two emphasized lines below would be removed from the file.
.. code-block:: text
:emphasize-lines: 3,4

<gui enabled="true" tls="false" debugging="false">
<gui enabled="true" tls="false">
<address>127.0.0.1:8384</address>
<user>syncguy</user>
<password>$2a$10$s9wWHOQe...Cq7GPye69</password>
Expand Down
13 changes: 0 additions & 13 deletions users/profiling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,6 @@ have caused most memory to be allocated.
Neither of the profiles contain any private data about your setup - only
what parts of the program are using resources.

Enable Debugging
----------------

Debugging must be enabled to be able to capture profiles. To enable
debugging, open the advanced settings:

.. image:: advanced-settings.png

Enable the "debugging" setting under "GUI", and then scroll down and **Save**.
No restart is necessary.

.. image:: gui-debugging.png

Capture a CPU profile
---------------------

Expand Down