| commit | bb6f0ead80fdb12dc6a068ba4f57db1399d41dd5 | [log] [tgz] |
|---|---|---|
| author | Hana (Hyang-Ah) Kim <hyangah@gmail.com> | Tue Dec 12 10:56:32 2023 -0500 |
| committer | Hyang-Ah Hana Kim <hyangah@gmail.com> | Wed Dec 27 22:31:11 2023 +0000 |
| tree | 354d4108c6958a190d819f3da7b970c5a1de1f16 | |
| parent | 0f48c2f6e47595b20fcb6eae1aff280b13e8039b [diff] |
src/goInstallTools,goTelemetry: add TelemetryReporter TelemetryReporter buffers counter updates and periodically invokes a go program (vscgo) that writes the counter to the disk. installVCSGO in goInstallTools.ts installs vscgo. If vscgo installation fails, TelemetryReporter will keep holding the counter in memory. The buffer is a set keyed by the counter and we expect there is a finite set of counters. That installs the vscgo binary in the extension path. The location was chosen so that when users update the extension, a new version can be installed. VS Code will manage the extension path and delete the directory when the extension is uninstalled or the version is no longer used. The extension operates in four different modes and we need to choose how to build the vscgo. The extension includes the vscgo main package source file in it. 1) golang.go, stable/rc releases: PRODUCTION mode. try to install from the remote source (proxy) so its checksum is verified and build version and telemetry counter file matches the extension version. The source repo needs to be tagged. In case of failure, we attempt to fallback to the build with the source code included in the extension. 2) golang.go-nightly, preview release: PRODUCTION mode. Nightly is released daily automatically. Tagging the repo everyday is not practical. Moreover, the nightly extension does not use semver but encodes the release timestamp, so it is not compatible with go commands. Installing from @master or @latest isn't ideal either since vscgo functionality is tied with the extension version. The telemetry data will be labeled with `devel` version. 3) golang.go, preview release: PRODUCTION mode. Used for local testing during development (e.g. npm run package & code --install-extension). The version will include `-dev`. We want to build from the local source included in the extension since there is no usable tag in the remote origin. The telemetry data will be labeled with `devel` version. 4) golang.go, preview release: DEVELOPMENT mode. Used for local testing using the launch.json configuration. VS Code will use the project source code as the extension path. Build vscgo from the project repo on disk. The telemetry data will be labeled with `devel` version. 5) golang.go, preview release: TEST mode. Currently same as 4. No telemetry data is materialized. Tests that are designed for telemetry testing write test data in temporary text file for inspection during tests. For golang/vscode-go#3023 Change-Id: Ic408e7b296fdcb9ed33b68293ea82f5e29a81515 Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/549244 Commit-Queue: Hyang-Ah Hana Kim <hyangah@gmail.com> Reviewed-by: Suzy Mueller <suzmue@golang.org> TryBot-Result: kokoro <noreply+kokoro@google.com>
The VS Code Go extension provides rich language support for the Go programming language.
Welcome! 👋🏻
Whether you are new to Go or an experienced Go developer, we hope this extension fits your needs and enhances your development experience.
Install Go 1.18 or newer if you haven't already.
Install the VS Code Go extension.
Open any directory or workspace containing Go code to automatically activate the extension. The Go status bar appears in the bottom left corner of the window and displays your Go version.
The extension depends on go, gopls, dlv and other optional tools. If any of the dependencies are missing, the ⚠️ Analysis Tools Missing warning is displayed. Click on the warning to download dependencies.
See the tools documentation for a complete list of tools the extension depends on.
You are ready to Go :-) 🎉🎉🎉
If you are new to Go, this article provides the overview on Go code organization and basic go commands. Watch “Getting started with VS Code Go” for an explanation of how to build your first Go application using VS Code Go.
See the full feature breakdown for more details.
In addition to integrated editing features, the extension provides several commands for working with Go files. You can access any of these by opening the Command Palette (Ctrl+Shift+P on Linux/Windows and Cmd+Shift+P on Mac), and then typing in the command name. See the full list of commands provided by this extension.
⚠️ Note: the default syntax highlighting for Go files is provided by a TextMate rule embedded in VS Code, not by this extension.
For better syntax highlighting, we recommend enabling semantic highlighting by turning on Gopls' ui.semanticTokens setting. "gopls": { "ui.semanticTokens": true }
The VS Code Go extension supports both GOPATH and Go modules modes.
Go modules are used to manage dependencies in recent versions of Go. Modules replace the GOPATH-based approach to specifying which source files are used in a given build, and they are the default build mode in go1.16+. We highly recommend Go development in module mode. If you are working on existing projects, please consider migrating to modules.
Unlike the traditional GOPATH mode, module mode does not require the workspace to be located under GOPATH nor to use a specific structure. A module is defined by a directory tree of Go source files with a go.mod file in the tree's root directory.
Your project may involve one or more modules. If you are working with multiple modules or uncommon project layouts, you will need to configure your workspace by using Workspace Folders. See the Supported workspace layouts documentation for more information.
If you'd like to get early access to new features and bug fixes, you can use the nightly build of this extension. Learn how to install it in by reading the Go Nightly documentation.
VS Code Go extension relies on the Go Telemetry to learn insights about the performance and stability of the extension and the language server (`gopls``). Go Telemetry data uploading is disabled by default and can be enabled with the following command:
go run golang.org/x/telemetry/cmd/gotelemetry@latest on
After telemetry is enabled, the language server will upload metrics and stack traces to telemetry.go.dev. You can inspect what data is collected and can be uploaded by running:
go run golang.org/x/telemetry/cmdgotelemetry@latest view
If we get enough adoption, this data can significantly advance the pace of the Go extension development, and help us meet a higher standard of reliability. For example:
These are just a few ways that telemetry can improve gopls. The telemetry blog post series contains many more.
Go telemetry is designed to be transparent and privacy-preserving. If you have concerns about enabling telemetry, you can learn more at https://telemetry.go.dev/privacy.
We welcome your contributions and thank you for working to improve the Go development experience in VS Code. If you would like to help work on the VS Code Go extension, see our contribution guide to learn how to build and run the VS Code Go extension locally and contribute to the project.
This project follows the Go Community Code of Conduct. If you encounter a conduct-related issue, please mail conduct@golang.org.