all: remove the "local" mode in favor of just "off" and "on"

Per discussion, "local" mode does not offer much long term benefit: it
just exists to have a bail-out in case of e.g. performance problems with
telemetry collection. But such problems should be unlikely, and it's not
worth the more complicated state: revert to just on/off.

Fixes golang/go#63143

Change-Id: I416fd511742207336d73ce9c00ba19743e6d9694
Reviewed-on: https://go-review.googlesource.com/c/telemetry/+/530436
Auto-Submit: Robert Findley <[email protected]>
Reviewed-by: Hyang-Ah Hana Kim <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>

Author: findleyr

cmd/gotelemetry/main.go

@@ -71,7 +71,7 @@ func usage() {
 	w := flag.CommandLine.Output()
 	fmt.Fprintln(w, "Usage:")
 	fmt.Fprintln(w, "\tgotelemetry")
-	fmt.Fprintln(w, "\tgotelemetry set <on|off|local>")
+	fmt.Fprintln(w, "\tgotelemetry set <on|off>")
 	fmt.Fprintln(w, "\tgotelemetry dump [file1 file2 ...]")
 	fmt.Fprintln(w, "\tgotelemetry view (runs web server)")
 	fmt.Fprintln(w, "\tgotelemetry csv (prints all known counters)")

internal/counter/file.go

@@ -111,9 +111,6 @@ func (f *file) lookup(name string) counterPtr {
 	return counterPtr{current, ptr}
 }
 
-// ErrDisabled is the error returned when telemetry is disabled.
-var ErrDisabled = errors.New("counter: disabled by GOTELEMETRY=off")
-
 var (
 	errNoBuildInfo = errors.New("counter: missing build info")
 	errCorrupt     = errors.New("counter: corrupt counter file")
@@ -125,10 +122,6 @@ func (f *file) init(begin, end time.Time) {
 		f.err = errNoBuildInfo
 		return
 	}
-	if telemetry.Mode() == "off" {
-		f.err = ErrDisabled
-		return
-	}
 	dir := telemetry.LocalDir
 
 	if err := os.MkdirAll(dir, 0777); err != nil {

internal/telemetry/mode.go

@@ -41,15 +41,15 @@ func init() {
 }
 
 // SetMode updates the telemetry mode with the given mode.
-// Acceptable values for mode are "on", "off", or "local".
+// Acceptable values for mode are "on" or "off".
 func SetMode(mode string) error {
 	return ModeFile.SetMode(mode)
 }
 
 func (m ModeFilePath) SetMode(mode string) error {
 	mode = strings.TrimSpace(mode)
 	switch mode {
-	case "on", "off", "local":
+	case "on", "off":
 	default:
 		return fmt.Errorf("invalid telemetry mode: %q", mode)
 	}
@@ -76,7 +76,7 @@ func (m ModeFilePath) Mode() string {
 	}
 	data, err := os.ReadFile(fname)
 	if err != nil {
-		return "local" // default
+		return "off" // default
 	}
 	mode := string(data)
 	mode = strings.TrimSpace(mode)

internal/telemetry/mode_test.go

@@ -33,7 +33,7 @@ func TestTelemetryModeWithNoModeConfig(t *testing.T) {
 		modefile ModeFilePath
 		want     string
 	}{
-		{ModeFilePath(filepath.Join(tmp, "mode")), "local"},
+		{ModeFilePath(filepath.Join(tmp, "mode")), "off"},
 		{"", "off"},
 	}
 	for _, tt := range tests {
@@ -51,7 +51,7 @@ func TestTelemetryMode(t *testing.T) {
 	}{
 		{"on", false},
 		{"off", false},
-		{"local", false},
+		{"local", true}, // golang/go#63143: local mode is no longer supported
 		{"https://mytelemetry.com", true},
 		{"http://insecure.com", true},
 		{"bogus", true},

internal/upload/reports.go

@@ -27,9 +27,6 @@ var (
 
 // reports generates reports from inactive count files
 func reports(todo *work) ([]string, error) {
-	if it.Mode() == "off" {
-		return nil, nil // no reports
-	}
 	today := thisInstant.Format("2006-01-02")
 	lastWeek := latestReport(todo.uploaded)
 	if lastWeek >= today { //should never happen
@@ -113,7 +110,7 @@ func createReport(date string, files []string, lastWeek string) (string, error)
 		configVersion = v
 	}
 	uploadOK := true
-	if uploadConfig == nil || it.Mode() == "local" {
+	if uploadConfig == nil || it.Mode() != "on" {
 		uploadOK = false // no config, nothing to upload
 	}
 	if tooOld(date) {

mode.go

@@ -10,19 +10,16 @@ import (
 
 // Mode returns the current telemetry mode.
 //
-// The telemetry mode is a global value that controls both the collection and
-// uploading of telemetry data. When collection is enabled, telemetry counters
-// and stack information are written to the local file system and may be
-// inspected with the [gotelemetry] command. When uploading is enabled, this
-// anonymous data is periodically uploaded to remote servers.
+// The telemetry mode is a global value that controls the
+// uploading of telemetry data. Possible mode values are:
+//   - "on":    uploading is enabled
+//   - "off":   uploading is disabled
 //
-// Possible mode values are:
-//   - "on":    both collection and uploading are enabled
-//   - "local": telemetry collection is enabled, but uploading is disabled
-//   - "off":   both collection and uploading are disabled
+// When mode is "off", local data is still written to the local file system and
+// may be inspected with the [gotelemetry] command.
 //
 // If an error occurs while reading the telemetry mode from the file system,
-// Mode returns the default value "local".
+// Mode returns the default value "off".
 //
 // [gotelemetry]: https://pkg.go.dev/golang.org/x/telemetry/cmd/gotelemetry
 func Mode() string {