src/welcome,README: update welcome docs to discuss telemetry
Change-Id: I2332a946807c05e0dbc7768b7403d7309d03bb1b Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/540035 Run-TryBot: Suzy Mueller <suzmue@golang.org> Commit-Queue: Suzy Mueller <suzmue@golang.org> TryBot-Result: kokoro <noreply+kokoro@google.com> Reviewed-by: Suzy Mueller <suzmue@golang.org> Reviewed-by: Robert Findley <rfindley@google.com>
This commit is contained in:
Родитель
4ea9b2d662
Коммит
1964a4ee4c
44
README.md
44
README.md
|
@ -134,6 +134,50 @@ 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](https://github.com/golang/vscode-go/wiki/nightly).
|
||||
|
||||
## Telemetry
|
||||
|
||||
VS Code Go extension relies on the [Go Telemetry](https://telemetry.go.dev) 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](https://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:
|
||||
|
||||
- Even with [semi-automated crash
|
||||
reports](https://github.com/golang/vscode-go/issues?q=is%3Aissue+is%3Aopen+label%3AautomatedReport)
|
||||
in VS Code, we've seen several crashers go unreported for weeks or months.
|
||||
- Even with [a suite of
|
||||
benchmarks](https://perf.golang.org/dashboard/?benchmark=all&repository=tools&branch=release-branch.go1.20),
|
||||
some performance regressions don't show up in our benchmark environment (such
|
||||
as the [completion bug](https://go.dev/issue/62665) mentioned below!).
|
||||
- Even with [lots of great
|
||||
ideas](https://github.com/golang/go/issues?q=is%3Aissue+is%3Aopen+label%3Agopls+label%3Afeaturerequest)
|
||||
for how to improve gopls, we have limited resources. Telemetry can help us
|
||||
identify which new features are most important, and which existing features
|
||||
aren't being used or aren't working well.
|
||||
|
||||
These are just a few ways that telemetry can improve gopls. The [telemetry blog
|
||||
post series](https://research.swtch.com/telemetry-uses) 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](https://telemetry.go.dev/privacy).
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome your contributions and thank you for working to improve the Go
|
||||
|
|
|
@ -1,14 +1,5 @@
|
|||
Welcome to the VSCode Go Wiki!
|
||||
|
||||
### 📣 News and Upcoming Changes
|
||||
|
||||
[Remote attach debugging](./debugging#connecting-to-headless-delve-with-target-specified-at-server-start-up) is now available via Delve's native DAP implementation with Delve v1.7.3 or newer.
|
||||
We plan to enable this as the default in 2022 H1 to enhance remote debugging with the same
|
||||
[debugging features](./debugging.md) that are already in use for local debugging.
|
||||
We recommend switching your remote attach configurations in `launch.json` to use
|
||||
`"debugAdapter":"dlv-dap"` now to verify that this works for you.
|
||||
Please [file a new issue](https://github.com/golang/vscode-go/issues/new/choose) if you encounter any problems.
|
||||
|
||||
### User Documentation
|
||||
|
||||
* [Overview of Extension Features](features.md)
|
||||
|
|
|
@ -26,16 +26,9 @@
|
|||
}
|
||||
|
||||
.Announcement {
|
||||
display: flex;
|
||||
flex-direction: row;
|
||||
flex-direction: column;
|
||||
align-items: center;
|
||||
font-style: italic;
|
||||
padding: 1rem;
|
||||
}
|
||||
.Announcement-image {
|
||||
height: 2rem;
|
||||
flex: 0;
|
||||
margin-right: 1.5rem;
|
||||
padding: 0.25rem;
|
||||
}
|
||||
|
||||
.Cards {
|
||||
|
|
|
@ -184,22 +184,24 @@ export class WelcomePanel {
|
|||
</div>
|
||||
|
||||
<div class="Announcement">
|
||||
<img src="${announceURI}" alt="announce" class="Announcement-image" />
|
||||
<p>
|
||||
New!
|
||||
We are excited to announce a new
|
||||
<a href="https://github.com/golang/vscode-go/wiki/features#analyze-vulnerabilities-in-dependencies">code analysis feature</a>
|
||||
that surfaces known vulnerabilities in your dependencies.
|
||||
<p>📣 Recent gopls release (v0.14) includes <a href="https://go.dev/issue/58894">opt-in transparent telemetry</a>.
|
||||
</p>
|
||||
<p><b>Telemetry uploading is off by default</b> even when Visual Studio Code's telemetry setting is enabled.
|
||||
Go Telemetry needs to be enabled with the following command:
|
||||
<br>
|
||||
This vulncheck analyzer is backed by <a href="https://go.dev/security/vulndb">
|
||||
Go's vulnerability database</a> and the Go language server's integration of
|
||||
<a href="https://golang.org/x/vuln/cmd/govulncheck"><code>govulncheck</code></a>.
|
||||
Read <a href="https://go.dev/blog/vuln">"Go's support for vulnerability management"</a>
|
||||
to learn about the Go team's approach to helping Go developers secure their open-source dependencies.
|
||||
Please share your feedback at
|
||||
<a href="https://go.dev/s/vsc-vulncheck-feedback">go.dev/s/vsc-vulncheck-feedback</a>,
|
||||
and report a bug in
|
||||
<a href="https://github.com/golang/vscode-go/issues/new">our issue tracker</a>.
|
||||
<code>go run golang.org/x/telemetry/cmd/gotelemetry@latest on</code>
|
||||
</p>
|
||||
<p>
|
||||
After telemetry is enabled, metrics and crash stack traces will be uploaded to <a href="https://telemetry.go.dev">telemetry.go.dev</a> weekly.
|
||||
You can see the preview of the collected data using:
|
||||
<br>
|
||||
<code>go run golang.org/x/telemetry/cmd/gotelemetry@latest view</code>
|
||||
</p>
|
||||
<p>
|
||||
If we get enough adoption, this data can significantly advance the pace of the go plugin development and help us meet a higher standard of reliability.
|
||||
Go telemetry is designed to be transparent and privacy-preserving.
|
||||
If you have concerns about enabling telemetry, you can learn more at
|
||||
<a href="https://telemetry.go.dev/privacy">Go Telemetry Privacy Policy</a>.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
@ -226,7 +228,7 @@ export class WelcomePanel {
|
|||
<div class="Card-inner">
|
||||
<p class="Card-title">Troubleshooting</p>
|
||||
<p class="Card-content">Experiencing problems? Start with our
|
||||
<a href="https://github.com/golang/vscode-go/blob/master/docs/troubleshooting.md">troubleshooting guide</a>. </p> </div>
|
||||
<a href="https://github.com/golang/vscode-go/wiki/troubleshooting">troubleshooting guide</a>. </p> </div>
|
||||
</div>
|
||||
</div>
|
||||
</main>
|
||||
|
@ -259,10 +261,10 @@ function joinPath(uri: vscode.Uri, ...pathFragment: string[]): vscode.Uri {
|
|||
function showGoWelcomePage() {
|
||||
// Update this list of versions when there is a new version where we want to
|
||||
// show the welcome page on update.
|
||||
const showVersions: string[] = ['0.37.0'];
|
||||
const showVersions: string[] = ['0.40.0'];
|
||||
// TODO(hyangah): use the content hash instead of hard-coded string.
|
||||
// https://github.com/golang/vscode-go/issue/1179
|
||||
let goExtensionVersion = '0.37.0';
|
||||
let goExtensionVersion = '0.40.0';
|
||||
let goExtensionVersionKey = 'go.extensionVersion';
|
||||
if (extensionInfo.isPreview) {
|
||||
goExtensionVersion = '0.0.0';
|
||||
|
|
Загрузка…
Ссылка в новой задаче