Jun 18, 2024 · Jun 18, 2024
diff --git a/cli/ssh.go b/cli/ssh.go

 "cdr.dev/slog"
 "cdr.dev/slog/sloggers/sloghuman"
 "github.com/coder/coder/v2/agent/agentssh"
 "github.com/coder/coder/v2/cli/cliui"
 "github.com/coder/coder/v2/cli/cliutil"
 "github.com/coder/coder/v2/coderd/autobuild/notify"
 remoteForwards   []string
 env              []string
 disableAutostart bool
 noUsageTracking  bool
 )
 client := new(codersdk.Client)
 cmd := &serpent.Command{
 return xerrors.Errorf("start shell: %w", err)
 }

 // track workspace usage while connection is open
 closeUsage := client.UpdateWorkspaceUsageWithBodyContext(ctx, workspace.ID, codersdk.PostWorkspaceUsageRequest{
 AgentID: workspaceAgent.ID,
 AppName: codersdk.UsageAppNameSSH,
 })
 defer closeUsage()
 if !noUsageTracking {
 // check env for magic variable to determine the session type
 appName := codersdk.UsageAppNameSSH
 for _, kv := range parsedEnv {
 if kv[0] == agentssh.MagicSessionTypeEnvironmentVariable {
 switch kv[1] {
 case agentssh.MagicSessionTypeJetBrains:
 appName = codersdk.UsageAppNameJetbrains
 case agentssh.MagicSessionTypeVSCode:
 appName = codersdk.UsageAppNameVscode
 }
 }
 }

 // track workspace usage while connection is open
 closeUsage := client.UpdateWorkspaceUsageWithBodyContext(ctx, workspace.ID, codersdk.PostWorkspaceUsageRequest{
 AgentID: workspaceAgent.ID,
 AppName: appName,
 })
 defer closeUsage()
 }

 // Put cancel at the top of the defer stack to initiate
 // shutdown of services.
 Value:         serpent.StringArrayOf(&env),
 },
 sshDisableAutostartOption(serpent.BoolOf(&disableAutostart)),
 {
 Flag:        "no-usage-tracking",
 Description: "Disables tracking of workspace usage.",
 Env:         "CODER_SSH_NO_USAGE_TRACKING",
 Value:       serpent.BoolOf(&noUsageTracking),
 },
 }
 return cmd
 }
diff --git a/cli/testdata/coder_ssh_--help.golden b/cli/testdata/coder_ssh_--help.golden
  -l, --log-dir string, $CODER_SSH_LOG_DIR
          Specify the directory containing SSH diagnostic log files.

      --no-usage-tracking bool, $CODER_SSH_NO_USAGE_TRACKING
          Disables tracking of workspace usage.

      --no-wait bool, $CODER_SSH_NO_WAIT
          Enter workspace immediately after the agent has connected. This is the
          default if the template has configured the agent startup script
diff --git a/docs/cli/ssh.md b/docs/cli/ssh.md
Original file line number	Diff line number	Diff line change
Expand Up		@@ -28,6 +28,7 @@ import (

		"cdr.dev/slog"
		"cdr.dev/slog/sloggers/sloghuman"
		"github.com/coder/coder/v2/agent/agentssh"
		"github.com/coder/coder/v2/cli/cliui"
		"github.com/coder/coder/v2/cli/cliutil"
		"github.com/coder/coder/v2/coderd/autobuild/notify"
Expand DownExpand Up		@@ -58,6 +59,7 @@ func (r RootCmd) ssh() serpent.Command {
		remoteForwards []string
		env []string
		disableAutostart bool
		noUsageTracking bool
		)
		client := new(codersdk.Client)
		cmd := &serpent.Command{
Expand DownExpand Up		@@ -408,12 +410,27 @@ func (r RootCmd) ssh() serpent.Command {
		return xerrors.Errorf("start shell: %w", err)
		}

		// track workspace usage while connection is open
		closeUsage := client.UpdateWorkspaceUsageWithBodyContext(ctx, workspace.ID, codersdk.PostWorkspaceUsageRequest{
		AgentID: workspaceAgent.ID,
		AppName: codersdk.UsageAppNameSSH,
		})
		defer closeUsage()
		if !noUsageTracking {
		// check env for magic variable to determine the session type
		appName := codersdk.UsageAppNameSSH
		for _, kv := range parsedEnv {
		if kv[0] == agentssh.MagicSessionTypeEnvironmentVariable {
		switch kv[1] {
		case agentssh.MagicSessionTypeJetBrains:
		appName = codersdk.UsageAppNameJetbrains
		case agentssh.MagicSessionTypeVSCode:
		appName = codersdk.UsageAppNameVscode
		}
		}
		}

		// track workspace usage while connection is open
		closeUsage := client.UpdateWorkspaceUsageWithBodyContext(ctx, workspace.ID, codersdk.PostWorkspaceUsageRequest{
		AgentID: workspaceAgent.ID,
		AppName: appName,
		})
		defer closeUsage()
		}

		// Put cancel at the top of the defer stack to initiate
		// shutdown of services.
Expand DownExpand Up		@@ -517,6 +534,12 @@ func (r RootCmd) ssh() serpent.Command {
		Value: serpent.StringArrayOf(&env),
		},
		sshDisableAutostartOption(serpent.BoolOf(&disableAutostart)),
		{
		Flag: "no-usage-tracking",
		Description: "Disables tracking of workspace usage.",
		Env: "CODER_SSH_NO_USAGE_TRACKING",
		Value: serpent.BoolOf(&noUsageTracking),
		},
		}
		return cmd
		}
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -30,6 +30,9 @@ OPTIONS:
		-l, --log-dir string, $CODER_SSH_LOG_DIR
		Specify the directory containing SSH diagnostic log files.

		--no-usage-tracking bool, $CODER_SSH_NO_USAGE_TRACKING
		Disables tracking of workspace usage.

		--no-wait bool, $CODER_SSH_NO_WAIT
		Enter workspace immediately after the agent has connected. This is the
		default if the template has configured the agent startup script
Expand Down