Sam Rawlins
cd31d6e158
Also add a bare minimum of documentation for the plugin pages. Also correct some removed and added pages, all with TODOs. Change-Id: I5ca48c9013c47f6fc925c1da1c44055d3884448b Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/487081 Commit-Queue: Samuel Rawlins <srawlins@google.com> Reviewed-by: Brian Wilkerson <brianwilkerson@google.com>
3.2 KiB
Instrumentation
This document explains how to gather instrumentation logs and other diagnostic information from a running Dart Analysis Server (DAS) process.
Collect an instrumentation log
To collect an instrumentation log, DAS needs to be launched with the
--instrumentation-log-file option, specifying a path for the log file. Since
the IDE launches DAS, the steps are different for each IDE.
IntelliJ IDEA and Android Studio
- In IntelliJ IDEA, click Help > Find Action, type "Registry" and open the "Registry..." item.
- Scroll down to the
dart.server.additional.argumentsproperty, and set it's value to--instrumentation-log-file=/some/file.txt. If there are other arguments listed, which you wish to keep, add this new argument to the existing value, separated by whitespace. - In the Dart Analysis panel, click the
Restart Dart Analysis Server button.
After doing those steps, DAS will write an instrumentation log to the specified
file (/some/file.txt above).
VS Code
See the steps outlined at the Dart Code documentation.
Open the analyzer insights (diagnostics) pages
DAS serves a variety of "insights pages" (previously known as the "diagnostics
pages") as a website on localhost. Since the IDE launches DAS, the method of
opening this website is different for each IDE.
IntelliJ IDEA and Android Studio
- In the Dart Analysis panel, click the
Analyzer
Settings button on the left with the gear icon. Note, this is different
from the "Show Options Menu" button at the top, which also has a gear icon. - Click the View analyzer diagnostics link. The analyzer insights website should open in an external browser.
VS Code
- Open the command palette (Ctrl+Shift+P) and type "Dart: Open Analyzer Diagnostics / Insights". The analyzer insights website should open in an external browser.
Using the analyzer insights pages
Status
The first of the analyzer insights pages is the Status page. This page shows general information about the DAS process, including version information.
Analysis performance log
Code Completion
TODO
Communications
TODO
Contexts
TODO
Environment Variables
This page shows all system environment variables as seen from DAS.
Exceptions
TODO
Legacy plugins
This page displays information about each legacy analyzer plugin which is configured for the current workspace.
LSP Capabilities
This page is available when DAS is launched as an LSP server, and shows the current Client and Server LSP Capabilities.
Memory and CPU Usage
This page shows current memory and CPU usage of DAS.
Plugins
This page displays information about each "new" analyzer plugin (which uses the plugin system introduced in Dart 3.10) which is configured for the current workspace.
Session communications log
TODO
Timing
TODO