From e26457095c503880a84d3f0064bc220a30184ee4 Mon Sep 17 00:00:00 2001 From: Rob Findley Date: Tue, 3 Sep 2024 20:14:39 +0000 Subject: [PATCH] _content/doc: update telemetry documentation now that 1.23 is released Update the telemetry documentation to suggest the `go telemetry` subcommand for managing telemetry configuration, rather than the `gotelemetry` command. Also make it a little more prominent how to revert to local mode. Change-Id: I6e2353223fe9ef49002eda953ad8d3c277196891 Reviewed-on: https://go-review.googlesource.com/c/website/+/610315 Reviewed-by: Hyang-Ah Hana Kim Auto-Submit: Robert Findley LUCI-TryBot-Result: Go LUCI --- _content/doc/telemetry.md | 40 ++++++++++++++++++++------------------- 1 file changed, 21 insertions(+), 19 deletions(-) diff --git a/_content/doc/telemetry.md b/_content/doc/telemetry.md index ddb5617f5f..e07e150d62 100644 --- a/_content/doc/telemetry.md +++ b/_content/doc/telemetry.md @@ -62,16 +62,22 @@ This page explains how Go telemetry works, in some detail. For quick answers to frequently asked questions, see the [FAQ](#faq).
-To opt in to uploading telemetry data to the Go team, run: +Using Go 1.23 or later, to opt in to uploading telemetry data +to the Go team, run:
-go run golang.org/x/telemetry/cmd/gotelemetry@latest on
+go telemetry on
 
To completely disable telemetry, including local collection, run:
-go run golang.org/x/telemetry/cmd/gotelemetry@latest off
+go telemetry off
 
-Starting with Go 1.23, this can also be done with the go telemetry -subcommand. See Configuration for more details. +To revert to the default mode of local-only telemetry, run: +
+go telemetry local
+
+Prior to Go 1.23, this can also be done with the +golang.org/x/telemetry/cmd/gotelemetry command. See Configuration for more details.
## Overview {#overview} @@ -116,28 +122,24 @@ _mode_. The possible values for `mode` are `local` (the default), `on`, or [sampling](#uploads). - When `mode` is `off`, data is neither collected nor uploaded. -The [`gotelemetry`](/pkg/golang.org/x/telemetry/cmd/gotelemetry) command -configures the telemetry mode and manages local telemetry data. Use this -command to install it: +With Go 1.23 or later, the following commands interact with the telemetry mode: + +- `go telemetry`: see the current mode. +- `go telemetry on`: set the mode to `on`. +- `go telemetry off`: set the mode to `off`. +- `go telemetry local`: set the mode to `local`. + +The [`gotelemetry`](/pkg/golang.org/x/telemetry/cmd/gotelemetry) command can +also be used to configure the telemetry mode, as well as to inspect local +telemetry data. Use this command to install it: ``` go install golang.org/x/telemetry/cmd/gotelemetry@latest ``` -The following commands interact with the telemetry mode: - -- `gotelemetry local`: set the mode to `local`. -- `gotelemetry on`: set the mode to `on`. -- `gotelemetry off`: set the mode to `off`. -- `gotelemetry env`: see the current mode. - For the complete usage information of the `gotelemetry` command line tool, see its [package documentation](/pkg/golang.org/x/telemetry/cmd/gotelemetry). -Starting with Go 1.23, the telemetry mode can also be managed with the -`go telemetry` subcommand. Telemetry may also be enabled by accepting an -[IDE prompt](#ide). - ## Counters {#counters} As mentioned above, Go telemetry is instrumented via _counters_. Counters come