From 822132964e8b5c72f8abc15a4543e74e006339a9 Mon Sep 17 00:00:00 2001 From: Rob Findley Date: Tue, 16 Jul 2024 18:47:20 +0000 Subject: [PATCH] _content/doc: improve visibility of configuration in telemetry documentation A common use-case for reading the telemetry documentation is to discover how to enable or disable telemetry, yet the configuration section is somewhat far down the page. Add a new info callout with quick commands to enable or disable telemetry. For golang/go#68204 Change-Id: I6efc366401e626ed436905bda35fe75ae1c4bc57 Reviewed-on: https://go-review.googlesource.com/c/website/+/598695 LUCI-TryBot-Result: Go LUCI Reviewed-by: Hyang-Ah Hana Kim --- _content/doc/telemetry.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/_content/doc/telemetry.md b/_content/doc/telemetry.md index 648f3edc..71c899c5 100644 --- a/_content/doc/telemetry.md +++ b/_content/doc/telemetry.md @@ -5,6 +5,22 @@ breadcrumb: true date: 2024-02-07:00:00Z --- + + Table of Contents: [Background](#background)\ @@ -45,6 +61,19 @@ To learn more about telemetry and privacy, please see the 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: +
+go run golang.org/x/telemetry/cmd/gotelemetry@latest on
+
+To completely disable telemetry, including local collection, run: +
+go run golang.org/x/telemetry/cmd/gotelemetry@latest off
+
+Starting with Go 1.23, this can also be done with the go telemetry +subcommand. See Configuration for more details. +
+ ## Overview {#overview} Go telemetry uses three core data types: @@ -105,7 +134,9 @@ The following commands interact with the telemetry mode: For the complete usage information of the `gotelemetry` command line tool, see its [package documentation](/pkg/golang.org/x/telemetry/cmd/gotelemetry). -Telemetry may also be enabled by accepting an [IDE prompt](#ide). +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}