Skip to content

Commit 9cd9698

Browse files
committed
docs: update docs to include information about the new settings
1 parent 89e5c33 commit 9cd9698

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -388,6 +388,10 @@ If you need to report an issue attach these to give the most detailed informatio
388388
5. Now you should see additional `[debug]` prefixed logs in the output.
389389
- ![](./docs/images/logsDebugLog.png)
390390
391+
#### Language Server Logs
392+
393+
For information related to configuring the logs produced by the AmazonQ language server, see [Language Server Logging](./docs/lsp.md#language-server-logging).
394+
391395
### Telemetry
392396
393397
- See [docs/telemetry.md](./docs/telemetry.md) for guidelines on developing telemetry in this project.

docs/lsp.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,14 @@ sequenceDiagram
5353
```
5454
4. Uncomment the `__AMAZONQLSP_PATH` and `__AMAZONQLSP_UI` variables in the `amazonq/.vscode/launch.json` extension configuration
5555
5. Use the `Launch LSP with Debugging` configuration and set breakpoints in VSCode or the language server
56-
6. (Optional): Enable `"amazonq.lsp.traceChannel": "on"` in your VSCode settings to view detailed log messages sent to/from the language server. These log messages will show up in the "Amazon Q Language Server" output channel. `"amazonq.lsp.logLevel"` can be used to configure the log level for the language server.
56+
6. (Optional): To customize logging options, see [Language Server Logging](#language-server-logging)
57+
58+
## Language Server Logging
59+
60+
There are two settings that allow us to configure the language server logging.
61+
62+
- `amazonq.lsp.logLevel`: the logging level the language server should use. Options include `'error'`, `'warn'`, `'info'`, `'log'`, and `'debug'`. The default level is info. See the [implementation](<(https://github.com/aws/language-server-runtimes/blob/main/runtimes/runtimes/util/loggingUtil.ts#L4-L10)>) on the lanaguage server side for more information.
63+
- `amazonq.lsp.traceChannel`: View detailed log messages sent to/from the language server in a seperate output channel named 'Amazon Q Language Server'. All language server logs will be routed to this output channel instead. (Requires reloading to take effect).
5764
5865
## Amazon Q Inline Activation
5966

0 commit comments

Comments
 (0)