Ensure telemetry is tracked prior to exit

coder · kylecarbs · Jun 17, 2022 · Jun 12, 2022 · Jun 12, 2022 · Jun 13, 2022
commit 35aac55308635f95fa798b617f6a45ec75b32f32
diff --git a/cli/server.go b/cli/server.go
@@ -83,7 +83,6 @@ func server() *cobra.Command {
 		oauth2GithubClientSecret         string
 		oauth2GithubAllowedOrganizations []string
 		oauth2GithubAllowSignups         bool
-		telemetryEnable                  bool
 		telemetryURL                     string
 		tlsCertFile                      string
 		tlsClientCAFile                  string
@@ -312,11 +311,7 @@ func server() *cobra.Command {
 			if err != nil {
 				return xerrors.Errorf("parse telemetry url: %w", err)
 			}
-			// Disable telemetry if the in-memory database is used unless explicitly defined!
-			if inMemoryDatabase && !cmd.Flags().Changed("telemetry") {
-				telemetryEnable = false
-			}
-			if telemetryEnable {
+			if !inMemoryDatabase || cmd.Flags().Changed("telemetry-url") {
 				options.Telemetry, err = telemetry.New(telemetry.Options{
 					BuiltinPostgres: builtinPostgres,
 					DeploymentID:    deploymentID,
@@ -487,6 +482,8 @@ func server() *cobra.Command {
 				<-devTunnelErrChan
 			}
 
+			// Ensures a last report can be sent before exit!
+			options.Telemetry.Close()
 			cmd.Println("Waiting for WebSocket connections to close...")
 			shutdownConns()
 			coderAPI.Close()
@@ -534,7 +531,6 @@ func server() *cobra.Command {
 		"Specifies organizations the user must be a member of to authenticate with GitHub.")
 	cliflag.BoolVarP(root.Flags(), &oauth2GithubAllowSignups, "oauth2-github-allow-signups", "", "CODER_OAUTH2_GITHUB_ALLOW_SIGNUPS", false,
 		"Specifies whether new users can sign up with GitHub.")
-	cliflag.BoolVarP(root.Flags(), &telemetryEnable, "telemetry", "", "CODER_TELEMETRY", true, "Specifies whether telemetry is enabled or not. Coder collects anonymized usage data to help improve our product!")
 	cliflag.StringVarP(root.Flags(), &telemetryURL, "telemetry-url", "", "CODER_TELEMETRY_URL", "https://telemetry.coder.com", "Specifies a URL to send telemetry to.")
 	_ = root.Flags().MarkHidden("telemetry-url")
 	cliflag.BoolVarP(root.Flags(), &tlsEnable, "tls-enable", "", "CODER_TLS_ENABLE", false, "Specifies if TLS will be enabled")

diff --git a/cli/server_test.go b/cli/server_test.go
@@ -259,7 +259,7 @@ func TestServer(t *testing.T) {
 		server := httptest.NewServer(r)
 		t.Cleanup(server.Close)
 
-		root, _ := clitest.New(t, "server", "--in-memory", "--address", ":0", "--telemetry", "--telemetry-url", server.URL)
+		root, _ := clitest.New(t, "server", "--in-memory", "--address", ":0", "--telemetry-url", server.URL)
 		errC := make(chan error)
 		go func() {
 			errC <- root.ExecuteContext(ctx)

diff --git a/coderd/provisionerdaemons.go b/coderd/provisionerdaemons.go
@@ -493,21 +493,28 @@ func (server *provisionerdServer) FailJob(ctx context.Context, failJob *proto.Fa
 	if job.CompletedAt.Valid {
 		return nil, xerrors.Errorf("job already completed")
 	}
+	job.CompletedAt = sql.NullTime{
+		Time:  database.Now(),
+		Valid: true,
+	}
+	job.Error = sql.NullString{
+		String: failJob.Error,
+		Valid:  failJob.Error != "",
+	}
+
 	err = server.Database.UpdateProvisionerJobWithCompleteByID(ctx, database.UpdateProvisionerJobWithCompleteByIDParams{
-		ID: jobID,
-		CompletedAt: sql.NullTime{
-			Time:  database.Now(),
-			Valid: true,
-		},
-		UpdatedAt: database.Now(),
-		Error: sql.NullString{
-			String: failJob.Error,
-			Valid:  failJob.Error != "",
-		},
+		ID:          jobID,
+		CompletedAt: job.CompletedAt,
+		UpdatedAt:   database.Now(),
+		Error:       job.Error,
 	})
 	if err != nil {
 		return nil, xerrors.Errorf("update provisioner job: %w", err)
 	}
+	server.Telemetry.Report(&telemetry.Snapshot{
+		ProvisionerJobs: []telemetry.ProvisionerJob{telemetry.ConvertProvisionerJob(job)},
+	})
+
 	switch jobType := failJob.Type.(type) {
 	case *proto.FailedJob_WorkspaceBuild_:
 		if jobType.WorkspaceBuild.State == nil {

diff --git a/coderd/telemetry/telemetry.go b/coderd/telemetry/telemetry.go
@@ -106,34 +106,34 @@ type remoteReporter struct {
 }
 
 func (r *remoteReporter) Report(snapshot *Snapshot) {
-	snapshot.DeploymentID = r.options.DeploymentID
+	go r.reportSync(snapshot)
+}
 
-	// Runs in a goroutine so it's non-blocking to callers!
-	go func() {
-		data, err := json.Marshal(snapshot)
-		if err != nil {
-			r.options.Logger.Error(r.ctx, "marshal snapshot: %w", slog.Error(err))
-			return
-		}
-		req, err := http.NewRequestWithContext(r.ctx, "POST", r.snapshotURL.String(), bytes.NewReader(data))
-		if err != nil {
-			r.options.Logger.Error(r.ctx, "create request", slog.Error(err))
-			return
-		}
-		req.Header.Set(VersionHeader, buildinfo.Version())
-		resp, err := http.DefaultClient.Do(req)
-		if err != nil {
-			// If the request fails it's not necessarily an error.
-			// In an airgapped environment, it's fine if this fails!
-			r.options.Logger.Debug(r.ctx, "submit", slog.Error(err))
-			return
-		}
-		if resp.StatusCode != http.StatusAccepted {
-			r.options.Logger.Debug(r.ctx, "bad response from telemetry server", slog.F("status", resp.StatusCode))
-			return
-		}
-		r.options.Logger.Debug(r.ctx, "submitted snapshot")
-	}()
+func (r *remoteReporter) reportSync(snapshot *Snapshot) {
+	snapshot.DeploymentID = r.options.DeploymentID
+	data, err := json.Marshal(snapshot)
+	if err != nil {
+		r.options.Logger.Error(r.ctx, "marshal snapshot: %w", slog.Error(err))
+		return
+	}
+	req, err := http.NewRequestWithContext(r.ctx, "POST", r.snapshotURL.String(), bytes.NewReader(data))
+	if err != nil {
+		r.options.Logger.Error(r.ctx, "create request", slog.Error(err))
+		return
+	}
+	req.Header.Set(VersionHeader, buildinfo.Version())
+	resp, err := http.DefaultClient.Do(req)
+	if err != nil {
+		// If the request fails it's not necessarily an error.
+		// In an airgapped environment, it's fine if this fails!
+		r.options.Logger.Debug(r.ctx, "submit", slog.Error(err))
+		return
+	}
+	if resp.StatusCode != http.StatusAccepted {
+		r.options.Logger.Debug(r.ctx, "bad response from telemetry server", slog.F("status", resp.StatusCode))
+		return
+	}
+	r.options.Logger.Debug(r.ctx, "submitted snapshot")
 }
 
 func (r *remoteReporter) Close() {
@@ -203,7 +203,7 @@ func (r *remoteReporter) reportWithDeployment() {
 		r.options.Logger.Error(r.ctx, "create snapshot", slog.Error(err))
 		return
 	}
-	r.Report(snapshot)
+	r.reportSync(snapshot)
 }
 
 // deployment collects host information and reports it to the telemetry server.
@@ -446,6 +446,7 @@ func ConvertWorkspace(workspace database.Workspace) Workspace {
 		TemplateID:        workspace.TemplateID,
 		CreatedAt:         workspace.CreatedAt,
 		Deleted:           workspace.Deleted,
+		Name:              workspace.Name,
 		AutostartSchedule: workspace.AutostartSchedule.String,
 	}
 }
@@ -670,6 +671,7 @@ type Workspace struct {
 	TemplateID        uuid.UUID `json:"template_id"`
 	CreatedAt         time.Time `json:"created_at"`
 	Deleted           bool      `json:"deleted"`
+	Name              string    `json:"name"`
 	AutostartSchedule string    `json:"autostart_schedule"`
 }