Skip to content

Commit a0d0e0e

Browse files
authored
docs: add coder ping example for troubleshooting (#8133)
1 parent 1faed63 commit a0d0e0e

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/networking/index.md

+15
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,21 @@ With browser-only connections, developers can only connect to their workspaces v
113113

114114
## Troubleshooting
115115

116+
The `coder ping -v <workspace>` will ping a workspace and return debug logs for
117+
the connection. We recommend running this command and inspecting the output when
118+
debugging SSH connections to a workspace. For example:
119+
120+
```console
121+
$ coder ping -v my-workspace
122+
123+
2023-06-21 17:50:22.412 [debu] wgengine: ping(fd7a:115c:a1e0:49d6:b259:b7ac:b1b2:48f4): sending disco ping to [cFYPo] ...
124+
pong from my-workspace proxied via DERP(Denver) in 90ms
125+
2023-06-21 17:50:22.503 [debu] wgengine: magicsock: closing connection to derp-13 (conn-close), age 5s
126+
2023-06-21 17:50:22.503 [debu] wgengine: magicsock: 0 active derp conns
127+
2023-06-21 17:50:22.504 [debu] wgengine: wg: [v2] Routine: receive incoming v6 - stopped
128+
2023-06-21 17:50:22.504 [debu] wgengine: wg: [v2] Device closed
129+
```
130+
116131
The `coder speedtest <workspace>` command measures user <-> workspace throughput.
117132
E.g.:
118133

0 commit comments

Comments
 (0)