STPROFILER missing from Syncthing 2.0 documentation?

Development
1

In the Docs, before Syncthing 2.0, there was an environment variable called STPROFILER (e.g. see https://docs.syncthing.net/v1.30.0/dev/debugging).

image
image974×181 31.3 KB

However, in the current version of the Docs, there is no mention of STPROFILER at all, even though the instructions themselves do still apply and work:

image
image2034×918 114 KB

On the page, it is possible to grab a full goroutine stack dump. Is this no longer relevant or useful?

2

Probably removed by mistake.

3

Hmm, the whole page looks kind of broken, e.g.

v1.30

image
image972×858 97.2 KB

vs

v2.0

image
image988×889 172 KB

It seems that STPROFILER (together with a lot of other environment variables) was removed in chore: updates for v2 changes (#901) · syncthing/docs@a86f6a1 · GitHub.

4

Mostly because most of these are now on the command line flags, including STPROFILER in fact:

      --debug-gui-assets-dir=PATH              Directory to load GUI assets from ($STGUIASSETS)
      --debug-perf-stats                       Write running performance statistics to perf-$pid.csv (Unix only) ($STPERFSTATS)
      --debug-profile-block                    Write block profiles to block-$pid-$timestamp.pprof every 20 seconds
                                               ($STBLOCKPROFILE)
      --debug-profile-cpu                      Write a CPU profile to cpu-$pid.pprof on exit ($STCPUPROFILE)
      --debug-profile-heap                     Write heap profiles to heap-$pid-$timestamp.pprof each time heap usage increases
                                               ($STHEAPPROFILE)
      --debug-profiler-listen=ADDR             Network profiler listen address ($STPROFILER)
5

Ah, now it’s clear. I think all those could be added to https://docs.syncthing.net/users/syncthing.html, right? At the moment, there seems to be no documentation available at all (and wrappers like the Android app only allow setting environment variables).

In the case of STPROFILER specifically, you still need to know the URL to access the debug page (which is different than the CPU and heap profiling URLs, i.e. there is no /rest/ in it).

6

Sure