From 681c6eeeebce1745f42c0e2937cb7b6be1ea9f85 Mon Sep 17 00:00:00 2001
From: Aleksey Kladov <aleksey.kladov@gmail.com>
Date: Tue, 24 Mar 2020 10:31:52 +0100
Subject: Add troubleshooting secion

---
 docs/user/readme.adoc | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'docs/user/readme.adoc')

diff --git a/docs/user/readme.adoc b/docs/user/readme.adoc
index 0dfc12b52..e00d14dfb 100644
--- a/docs/user/readme.adoc
+++ b/docs/user/readme.adoc
@@ -98,6 +98,16 @@ You'll need Cargo, nodejs and npm for this.
 
 Note that installing via `xtask install` does not work for VS Code Remote, instead you'll need to install the `.vsix` manually.
 
+==== Troubleshooting
+
+Here are some useful self-diagnostic commands:
+
+* **Rust Analyzer: Show RA Version** shows the version of `rust-analyzer` binary
+* **Rust Analyzer: Status** prints some statistics about the server, like the few latest LSP requests
+* To enable server-side logging, run with `env RUST_LOG=info` and see `Output > Rust Analyzer Language Server` in VS Code's panel.
+* To log all LSP requests, add `"rust-analyzer.trace.server": "verbose"` to the settings and look for `Server Trace` in the panel.
+* To enable client-side logging, add `"rust-analyzer.trace.extension": true` to the settings and open the `Console` tab of VS Code developer tools.
+
 === Language Server Binary
 
 Other editors generally require `rust-analyzer` binary to be in `$PATH`.
-- 
cgit v1.2.3

