Skip to content

Commit

Permalink
Merge pull request #725 from CherryDT/639-faq-remote-debug-info
Browse files Browse the repository at this point in the history
Add info to docs about remote debugging
  • Loading branch information
Domiii authored Apr 29, 2022
2 parents a17cdb0 + da2367d commit 48a334c
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
13 changes: 13 additions & 0 deletions docs_site/content/08-faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,19 @@ You can bind commands to keys. [This official documentation explains how to easi
If you are certain that a file executed in a [Dbux-enabled application](./dynamic-analysis/02-enable-dbux.mdx), make sure your [configuration is set up to include](./guides/01-runtime-trace-filtering.mdx) the file in that specific package or path.


## How can I debug code remotely?

While Dbux currently doesn't have native remote debugging capabilities on its own, it does work with VSCode remote sessions.

1. If not already done, set up remote development with VSCode on your server via the "Remote: SSH" extension, as described [in this guide](https://code.visualstudio.com/docs/remote/ssh).
2. In a VSCode remote session, install the dbux extension, in the same way you would do locally (going to "Extensions" in the sidebar, searching for "Dbux" and clicking "Install").
3. Use Dbux normally!

:::note
Using VSCode's remote capabilities will result in the installation of a headless VSCode server complete with extension host and a copy of the Dbux extension on the remote server (in `~/.vscode-server`).
:::


## It Just Won't Work!

While technically not a question, this is certainly a frustrating experience to encounter.
Expand Down
4 changes: 2 additions & 2 deletions docs_site/content/advanced/02-future-work.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ NOTE: The code should still work fine, but some of Dbux's analysis tools (especi
* This was tracked in: https://github.com/Domiii/dbux/issues/201.


## Remote Analysis
## Remote Analysis without VSCode server

`@dbux/runtime` is currently hard-coded to connect to a `localhost` server (see <CodeLink path="dbux-runtime/src/client/Client.js" />). You thus cannot use Dbux remotely. However, one can [export + import trace log files](./05-data-analysis.mdx#art-vandelay) on different machines.
`@dbux/runtime` is currently hard-coded to connect to a `localhost` server (see <CodeLink path="dbux-runtime/src/client/Client.js" />), and additionally the extension expects to be able to access the file paths reported in the execution trace locally. Thus, the only way to use Dbux remotely is currently [using a VSCode remote session](../08-faq.mdx#how-can-i-debug-code-remotely). However, one can [export + import trace log files](./05-data-analysis.mdx#art-vandelay) on different machines.

Tracked in: https://github.com/Domiii/dbux/issues/639.

Expand Down

0 comments on commit 48a334c

Please sign in to comment.