@@ -257,6 +257,64 @@ via Toolbox App Menu > About > Show log files.
257
257
Alternatively, you can generate a ZIP file using the Workspace action menu, available either on the main
258
258
Workspaces page in Coder or within the individual workspace view, under the option labeled _ Collect logs_ .
259
259
260
+ ### HTTP Request Logging
261
+
262
+ The Coder Toolbox plugin includes comprehensive HTTP request logging capabilities to help diagnose API communication
263
+ issues with Coder deployments.
264
+ This feature allows you to monitor all HTTP requests and responses made by the plugin.
265
+
266
+ #### Configuring HTTP Logging
267
+
268
+ You can configure HTTP logging verbosity through the Coder Settings page:
269
+
270
+ 1 . Navigate to the Coder Workspaces page
271
+ 2 . Click on the deployment action menu (three dots)
272
+ 3 . Select "Settings"
273
+ 4 . Find the "HTTP logging level" dropdown
274
+
275
+ #### Available Logging Levels
276
+
277
+ The plugin supports four levels of HTTP logging verbosity:
278
+
279
+ - ** None** : No HTTP request/response logging (default)
280
+ - ** Basic** : Logs HTTP method, URL, and response status code
281
+ - ** Headers** : Logs basic information plus sanitized request and response headers
282
+ - ** Body** : Logs headers plus request and response body content
283
+
284
+ #### Log Output Format
285
+
286
+ HTTP logs follow this format:
287
+
288
+ ```
289
+ request --> GET https://your-coder-deployment.com/api/v2/users/me
290
+ User-Agent: Coder Toolbox/1.0.0 (darwin; amd64)
291
+ Coder-Session-Token: <redacted>
292
+
293
+ response <-- 200 https://your-coder-deployment.com/api/v2/users/me
294
+ Content-Type: application/json
295
+ Content-Length: 245
296
+
297
+ {"id":"12345678-1234-1234-1234-123456789012","username":"coder","email":"[email protected] "}
298
+ ```
299
+
300
+ #### Use Cases
301
+
302
+ HTTP logging is particularly useful for:
303
+
304
+ - ** API Debugging** : Diagnosing issues with Coder API communication
305
+ - ** Authentication Problems** : Troubleshooting token or certificate authentication issues
306
+ - ** Network Issues** : Identifying connectivity problems with Coder deployments
307
+ - ** Performance Analysis** : Monitoring request/response times and payload sizes
308
+
309
+ #### Troubleshooting with HTTP Logs
310
+
311
+ When reporting issues, include HTTP logs to help diagnose:
312
+
313
+ 1 . ** Authentication Failures** : Check for 401/403 responses and token headers
314
+ 2 . ** Network Connectivity** : Look for connection timeouts or DNS resolution issues
315
+ 3 . ** API Compatibility** : Verify request/response formats match expected API versions
316
+ 4 . ** Proxy Issues** : Monitor proxy authentication and routing problems
317
+
260
318
## Coder Settings
261
319
262
320
The Coder Settings allows users to control CLI download behavior, SSH configuration, TLS parameters, and data
0 commit comments