Add troubleshooting section for NSight Compute (#2442)

[skip tests]

Co-authored-by: Tim Besard <tim.besard@gmail.com>

Author: efaulhaber

docs/src/development/profiling.md

@@ -277,6 +277,74 @@ the API calls that have been made:
 !["NVIDIA Nsight Compute - API inspection"](nsight_compute-api.png)
 
 
+#### Troubleshooting NSight Compute
+
+If you're running into issues, make sure you're using the same version of NSight Compute on
+the host and the device, and make sure it's the latest version available. You do not need
+administrative permissions to install NSight Compute, the `runfile` downloaded from the
+NVIDIA home page can be executed as a regular user.
+
+##### `Could not load library "libpcre2-8`
+
+This is caused by an incompatibility between Julia and NSight Compute, and should be fixed
+in the latest versions of NSight Compute. If it's not possible to upgrade, the following
+workaround may help:
+
+```
+LD_LIBRARY_PATH=$(/path/to/julia -e 'println(joinpath(Sys.BINDIR, Base.LIBDIR, "julia"))') ncu --mode=launch /path/to/julia
+```
+
+##### The Julia process is not listed in the "Attach" tab
+
+Make sure that the port that is used by NSight Compute (49152 by default) is accessible via
+ssh. To verify this, you can also try forwarding the port manually:
+
+```
+ssh user@host.com -L 49152:localhost:49152
+```
+
+Then, in the "Connect to process" window of NSight Compute, add a connection to `localhost`
+instead of the remote host.
+
+If SSH complains with `Address already in use`, that means the port is already in use. If
+you're using VSCode, try closing all instances as VSCode might automatically forward the
+port when launching NSight Compute in a terminal within VSCode.
+
+##### Julia in NSight Compute only shows the Julia logo, not the REPL prompt
+
+In some versions of NSight Compute, you might have to start Julia without the `--project`
+option and switch the environment from inside Julia.
+
+##### "Disconnected from the application" once I click "Resume"
+
+Make sure that everything is precompiled before starting Julia with NSight Compute,
+otherwise you end up profiling the precompilation process instead of your actual
+application.
+
+Alternatively, disable auto profiling, resume, wait until the precompilation is finished,
+and then enable auto profiling again.
+
+##### I only see the "API Stream" tab and no tab with details on my kernel on the right
+
+Scroll down in the "API Stream" tab and look for errors in the "Details" column.
+If it says "The user does not have permission to access NVIDIA GPU Performance Counters
+on the target device", add this config:
+
+```
+# cat /etc/modprobe.d/nvprof.conf
+options nvidia NVreg_RestrictProfilingToAdminUsers=0
+```
+
+The `nvidia.ko` kernel module needs to be reloaded after changing this configuration, and
+your system may require regenerating the initramfs or even a reboot. Refer to your
+distribution's documentation for details.
+
+##### NSight Compute breaks on various API calls
+
+Make sure `Break On API Error` is disabled in the `Debug` menu, as CUDA.jl purposefully
+triggers some API errors as part of its normal operation.
+
+
 ## Source-code annotations
 
 If you want to put additional information in the profile, e.g. phases of your application,