feat: adds device_id, device_os, and coder_desktop_version to telemetry

coder · spikecurtis · Mar 25, 2025 · Mar 25, 2025 · Mar 25, 2025 · Mar 25, 2025
commit 91f5fba3075a153f8c3ce887dba3a4e2b1a9a439
diff --git a/coderd/workspaceagents.go b/coderd/workspaceagents.go
@@ -1652,6 +1652,30 @@ func (api *API) tailnetRPCConn(rw http.ResponseWriter, r *http.Request) {
 		DeviceOS:            nil,
 		CoderDesktopVersion: nil,
 	}
+
+	// Parse desktop telemetry from header if it exists
+	desktopTelemetryHeader := r.Header.Get(codersdk.CoderDesktopTelemetryHeader)
+	if desktopTelemetryHeader != "" {
+		var telemetryData codersdk.CoderDesktopTelemetry
+		if err := telemetryData.FromHeader(desktopTelemetryHeader); err == nil {
+			// Only set fields if they aren't empty
+			if telemetryData.DeviceID != "" {
+				connectionTelemetryEvent.DeviceID = &telemetryData.DeviceID
+			}
+			if telemetryData.DeviceOS != "" {
+				connectionTelemetryEvent.DeviceOS = &telemetryData.DeviceOS
+			}
+			if telemetryData.CoderDesktopVersion != "" {
+				connectionTelemetryEvent.CoderDesktopVersion = &telemetryData.CoderDesktopVersion
+			}
+			api.Logger.Debug(ctx, "received desktop telemetry",
+				slog.F("device_id", telemetryData.DeviceID),
+				slog.F("device_os", telemetryData.DeviceOS),
+				slog.F("desktop_version", telemetryData.CoderDesktopVersion))
+		} else {
+			api.Logger.Warn(ctx, "failed to parse desktop telemetry header", slog.Error(err))
+		}
+	}
 	api.Telemetry.Report(&telemetry.Snapshot{
 		UserTailnetConnections: []telemetry.UserTailnetConnection{connectionTelemetryEvent},
 	})

diff --git a/coderd/workspaceagents_test.go b/coderd/workspaceagents_test.go
@@ -51,6 +51,7 @@ import (
 	"github.com/coder/coder/v2/coderd/jwtutils"
 	"github.com/coder/coder/v2/coderd/rbac"
 	"github.com/coder/coder/v2/coderd/telemetry"
+	"github.com/coder/coder/v2/coderd/util/ptr"
 	"github.com/coder/coder/v2/codersdk"
 	"github.com/coder/coder/v2/codersdk/agentsdk"
 	"github.com/coder/coder/v2/codersdk/workspacesdk"
@@ -2135,30 +2136,21 @@ func TestOwnedWorkspacesCoordinate(t *testing.T) {
 
 	ctx := testutil.Context(t, testutil.WaitLong)
 	logger := testutil.Logger(t)
-
-	fTelemetry := newFakeTelemetryReporter(ctx, t, 200)
-	fTelemetry.enabled = false
 	firstClient, _, api := coderdtest.NewWithAPI(t, &coderdtest.Options{
-		Coordinator:       tailnet.NewCoordinator(logger),
-		TelemetryReporter: fTelemetry,
+		Coordinator: tailnet.NewCoordinator(logger),
 	})
 	firstUser := coderdtest.CreateFirstUser(t, firstClient)
 	member, memberUser := coderdtest.CreateAnotherUser(t, firstClient, firstUser.OrganizationID, rbac.RoleTemplateAdmin())
 
 	// Create a workspace with an agent
 	firstWorkspace := buildWorkspaceWithAgent(t, member, firstUser.OrganizationID, memberUser.ID, api.Database, api.Pubsub)
 
-	// enable telemetry now that workspace is built; we don't care about snapshots before this.
-	fTelemetry.enabled = true
-
 	u, err := member.URL.Parse("/api/v2/tailnet")
 	require.NoError(t, err)
 	q := u.Query()
 	q.Set("version", "2.0")
 	u.RawQuery = q.Encode()
 
-	predialTime := time.Now()
-
 	//nolint:bodyclose // websocket package closes this for you
 	wsConn, resp, err := websocket.Dial(ctx, u.String(), &websocket.DialOptions{
 		HTTPHeader: http.Header{
@@ -2173,15 +2165,6 @@ func TestOwnedWorkspacesCoordinate(t *testing.T) {
 	}
 	defer wsConn.Close(websocket.StatusNormalClosure, "done")
 
-	// Check telemetry
-	snapshot := testutil.RequireRecvCtx(ctx, t, fTelemetry.snapshots)
-	require.Len(t, snapshot.UserTailnetConnections, 1)
-	telemetryConnection := snapshot.UserTailnetConnections[0]
-	require.Equal(t, memberUser.ID.String(), telemetryConnection.UserID)
-	require.GreaterOrEqual(t, telemetryConnection.ConnectedAt, predialTime)
-	require.LessOrEqual(t, telemetryConnection.ConnectedAt, time.Now())
-	require.NotEmpty(t, telemetryConnection.PeerID)
-
 	rpcClient, err := tailnet.NewDRPCClient(
 		websocket.NetConn(ctx, wsConn, websocket.MessageBinary),
 		logger,
@@ -2229,23 +2212,135 @@ func TestOwnedWorkspacesCoordinate(t *testing.T) {
 			NumAgents: 0,
 		},
 	})
-	err = stream.Close()
-	require.NoError(t, err)
+}
 
-	beforeDisconnectTime := time.Now()
-	err = wsConn.Close(websocket.StatusNormalClosure, "done")
+func TestUserTailnetTelemetry(t *testing.T) {
+	t.Parallel()
+
+	telemetryData := &codersdk.CoderDesktopTelemetry{
+		DeviceOS:            "Windows",
+		DeviceID:            "device001",
+		CoderDesktopVersion: "0.22.1",
+	}
+	fullHeader, err := json.Marshal(telemetryData)
 	require.NoError(t, err)
 
-	snapshot = testutil.RequireRecvCtx(ctx, t, fTelemetry.snapshots)
-	require.Len(t, snapshot.UserTailnetConnections, 1)
-	telemetryDisconnection := snapshot.UserTailnetConnections[0]
-	require.Equal(t, memberUser.ID.String(), telemetryDisconnection.UserID)
-	require.Equal(t, telemetryConnection.ConnectedAt, telemetryDisconnection.ConnectedAt)
-	require.Equal(t, telemetryConnection.UserID, telemetryDisconnection.UserID)
-	require.Equal(t, telemetryConnection.PeerID, telemetryDisconnection.PeerID)
-	require.NotNil(t, telemetryDisconnection.DisconnectedAt)
-	require.GreaterOrEqual(t, *telemetryDisconnection.DisconnectedAt, beforeDisconnectTime)
-	require.LessOrEqual(t, *telemetryDisconnection.DisconnectedAt, time.Now())
+	testCases := []struct {
+		name    string
+		headers map[string]string
+		// only used for DeviceID, DeviceOS, CoderDesktopVersion
+		expected telemetry.UserTailnetConnection
+	}{
+		{
+			name:     "no header",
+			headers:  map[string]string{},
+			expected: telemetry.UserTailnetConnection{},
+		},
+		{
+			name: "full header",
+			headers: map[string]string{
+				codersdk.CoderDesktopTelemetryHeader: string(fullHeader),
+			},
+			expected: telemetry.UserTailnetConnection{
+				DeviceOS:            ptr.Ref("Windows"),
+				DeviceID:            ptr.Ref("device001"),
+				CoderDesktopVersion: ptr.Ref("0.22.1"),
+			},
+		},
+		{
+			name: "empty header",
+			headers: map[string]string{
+				codersdk.CoderDesktopTelemetryHeader: "",
+			},
+			expected: telemetry.UserTailnetConnection{},
+		},
+		{
+			name: "invalid header",
+			headers: map[string]string{
+				codersdk.CoderDesktopTelemetryHeader: "{\"device_os",
+			},
+			expected: telemetry.UserTailnetConnection{},
+		},
+	}
+
+	// nolint: paralleltest // no longer need to reinitialize loop vars in go 1.22
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			t.Parallel()
+
+			ctx := testutil.Context(t, testutil.WaitLong)
+			logger := testutil.Logger(t)
+
+			fTelemetry := newFakeTelemetryReporter(ctx, t, 200)
+			fTelemetry.enabled = false
+			firstClient := coderdtest.New(t, &coderdtest.Options{
+				Logger:            &logger,
+				TelemetryReporter: fTelemetry,
+			})
+			firstUser := coderdtest.CreateFirstUser(t, firstClient)
+			member, memberUser := coderdtest.CreateAnotherUser(t, firstClient, firstUser.OrganizationID, rbac.RoleTemplateAdmin())
+
+			headers := http.Header{
+				"Coder-Session-Token": []string{member.SessionToken()},
+			}
+			for k, v := range tc.headers {
+				headers.Add(k, v)
+			}
+
+			// enable telemetry now that user is created.
+			fTelemetry.enabled = true
+
+			u, err := member.URL.Parse("/api/v2/tailnet")
+			require.NoError(t, err)
+			q := u.Query()
+			q.Set("version", "2.0")
+			u.RawQuery = q.Encode()
+
+			predialTime := time.Now()
+
+			//nolint:bodyclose // websocket package closes this for you
+			wsConn, resp, err := websocket.Dial(ctx, u.String(), &websocket.DialOptions{
+				HTTPHeader: headers,
+			})
+			if err != nil {
+				if resp != nil && resp.StatusCode != http.StatusSwitchingProtocols {
+					err = codersdk.ReadBodyAsError(resp)
+				}
+				require.NoError(t, err)
+			}
+			defer wsConn.Close(websocket.StatusNormalClosure, "done")
+
+			// Check telemetry
+			snapshot := testutil.RequireRecvCtx(ctx, t, fTelemetry.snapshots)
+			require.Len(t, snapshot.UserTailnetConnections, 1)
+			telemetryConnection := snapshot.UserTailnetConnections[0]
+			require.Equal(t, memberUser.ID.String(), telemetryConnection.UserID)
+			require.GreaterOrEqual(t, telemetryConnection.ConnectedAt, predialTime)
+			require.LessOrEqual(t, telemetryConnection.ConnectedAt, time.Now())
+			require.NotEmpty(t, telemetryConnection.PeerID)
+			requireEqualOrBothNil(t, telemetryConnection.DeviceID, tc.expected.DeviceID)
+			requireEqualOrBothNil(t, telemetryConnection.DeviceOS, tc.expected.DeviceOS)
+			requireEqualOrBothNil(t, telemetryConnection.CoderDesktopVersion, tc.expected.CoderDesktopVersion)
+
+			beforeDisconnectTime := time.Now()
+			err = wsConn.Close(websocket.StatusNormalClosure, "done")
+			require.NoError(t, err)
+
+			snapshot = testutil.RequireRecvCtx(ctx, t, fTelemetry.snapshots)
+			require.Len(t, snapshot.UserTailnetConnections, 1)
+			telemetryDisconnection := snapshot.UserTailnetConnections[0]
+			require.Equal(t, memberUser.ID.String(), telemetryDisconnection.UserID)
+			require.Equal(t, telemetryConnection.ConnectedAt, telemetryDisconnection.ConnectedAt)
+			require.Equal(t, telemetryConnection.UserID, telemetryDisconnection.UserID)
+			require.Equal(t, telemetryConnection.PeerID, telemetryDisconnection.PeerID)
+			require.NotNil(t, telemetryDisconnection.DisconnectedAt)
+			require.GreaterOrEqual(t, *telemetryDisconnection.DisconnectedAt, beforeDisconnectTime)
+			require.LessOrEqual(t, *telemetryDisconnection.DisconnectedAt, time.Now())
+			requireEqualOrBothNil(t, telemetryConnection.DeviceID, tc.expected.DeviceID)
+			requireEqualOrBothNil(t, telemetryConnection.DeviceOS, tc.expected.DeviceOS)
+			requireEqualOrBothNil(t, telemetryConnection.CoderDesktopVersion, tc.expected.CoderDesktopVersion)
+		})
+	}
 }
 
 func buildWorkspaceWithAgent(
@@ -2414,3 +2509,12 @@ func (f *fakeTelemetryReporter) Enabled() bool {
 
 // Close implements the telemetry.Reporter interface.
 func (*fakeTelemetryReporter) Close() {}
+
+func requireEqualOrBothNil[T any](t testing.TB, a, b *T) {
+	t.Helper()
+	if a != nil && b != nil {
+		require.Equal(t, *a, *b)
+		return
+	}
+	require.Equal(t, a, b)
+}
diff --git a/codersdk/client.go b/codersdk/client.go
@@ -76,6 +76,10 @@ const (
 	// only.
 	CLITelemetryHeader = "Coder-CLI-Telemetry"
 
+	// CoderDesktopTelemetryHeader contains a JSON-encoded representation of Desktop telemetry
+	// fields, including device ID, OS, and Desktop version.
+	CoderDesktopTelemetryHeader = "Coder-Desktop-Telemetry"
+
 	// ProvisionerDaemonPSK contains the authentication pre-shared key for an external provisioner daemon
 	ProvisionerDaemonPSK = "Coder-Provisioner-Daemon-PSK"
 
@@ -523,6 +527,28 @@ func (e ValidationError) Error() string {
 
 var _ error = (*ValidationError)(nil)
 
+// CoderDesktopTelemetry represents the telemetry data sent from Coder Desktop clients.
+// @typescript-ignore CoderDesktopTelemetry
+type CoderDesktopTelemetry struct {
+	DeviceID            string `json:"device_id"`
+	DeviceOS            string `json:"device_os"`
+	CoderDesktopVersion string `json:"coder_desktop_version"`
+}
+
+// FromHeader parses the desktop telemetry from the provided header value.
+// Returns nil if the header is empty or if parsing fails.
+func (t *CoderDesktopTelemetry) FromHeader(headerValue string) error {
+	if headerValue == "" {
+		return nil
+	}
+	return json.Unmarshal([]byte(headerValue), t)
+}
+
+// IsEmpty returns true if all fields in the telemetry data are empty.
+func (t *CoderDesktopTelemetry) IsEmpty() bool {
+	return t.DeviceID == "" && t.DeviceOS == "" && t.CoderDesktopVersion == ""
+}
+
 // IsConnectionError is a convenience function for checking if the source of an
 // error is due to a 'connection refused', 'no such host', etc.
 func IsConnectionError(err error) bool {

diff --git a/codersdk/client_internal_test.go b/codersdk/client_internal_test.go
@@ -27,6 +27,7 @@ import (
 
 	"cdr.dev/slog"
 	"cdr.dev/slog/sloggers/sloghuman"
+
 	"github.com/coder/coder/v2/testutil"
 )
 

diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
diff --git a/vpn/speaker_internal_test.go b/vpn/speaker_internal_test.go
@@ -15,6 +15,7 @@ import (
 
 	"cdr.dev/slog"
 	"cdr.dev/slog/sloggers/slogtest"
+
 	"github.com/coder/coder/v2/testutil"
 )
 
@@ -47,7 +48,7 @@ func TestSpeaker_RawPeer(t *testing.T) {
 		errCh <- err
 	}()
 
-	expectedHandshake := "codervpn tunnel 1.0\n"
+	expectedHandshake := "codervpn tunnel 1.1\n"
 
 	b := make([]byte, 256)
 	n, err := mp.Read(b)
@@ -155,7 +156,7 @@ func TestSpeaker_OversizeHandshake(t *testing.T) {
 		errCh <- err
 	}()
 
-	expectedHandshake := "codervpn tunnel 1.0\n"
+	expectedHandshake := "codervpn tunnel 1.1\n"
 
 	b := make([]byte, 256)
 	n, err := mp.Read(b)
@@ -177,12 +178,12 @@ func TestSpeaker_HandshakeInvalid(t *testing.T) {
 	for _, tc := range []struct {
 		name, handshake string
 	}{
-		{name: "preamble", handshake: "ssh manager 1.0\n"},
+		{name: "preamble", handshake: "ssh manager 1.1\n"},
 		{name: "2components", handshake: "ssh manager\n"},
 		{name: "newmajors", handshake: "codervpn manager 2.0,3.0\n"},
 		{name: "0version", handshake: "codervpn 0.1 manager\n"},
-		{name: "unknown_role", handshake: "codervpn 1.0 supervisor\n"},
-		{name: "unexpected_role", handshake: "codervpn 1.0 tunnel\n"},
+		{name: "unknown_role", handshake: "codervpn 1.1 supervisor\n"},
+		{name: "unexpected_role", handshake: "codervpn 1.1 tunnel\n"},
 	} {
 		t.Run(tc.name, func(t *testing.T) {
 			t.Parallel()
@@ -208,7 +209,7 @@ func TestSpeaker_HandshakeInvalid(t *testing.T) {
 			_, err = mp.Write([]byte(tc.handshake))
 			require.NoError(t, err)
 
-			expectedHandshake := "codervpn tunnel 1.0\n"
+			expectedHandshake := "codervpn tunnel 1.1\n"
 			b := make([]byte, 256)
 			n, err := mp.Read(b)
 			require.NoError(t, err)
@@ -246,7 +247,7 @@ func TestSpeaker_CorruptMessage(t *testing.T) {
 		errCh <- err
 	}()
 
-	expectedHandshake := "codervpn tunnel 1.0\n"
+	expectedHandshake := "codervpn tunnel 1.1\n"
 
 	b := make([]byte, 256)
 	n, err := mp.Read(b)
-Original file line number
+Diff line change
@@ Expand Up / @@ -27,6 +27,7 @@ import ( @@
     	"cdr.dev/slog"
     	"cdr.dev/slog/sloggers/sloghuman"
     	"github.com/coder/coder/v2/testutil"
     )
@@ Expand Down @@