roachprod: remove Side-Eye support

Epic: none
Release note: None

Author: andreimatei

pkg/cmd/roachprod/cli/commands.go

@@ -2054,70 +2054,6 @@ func (cr *commandRegistry) buildJaegerURLCmd() *cobra.Command {
 	return jaegerURLCmd
 }
 
-func (cr *commandRegistry) buildSideEyeRootCmd() *cobra.Command {
-	sideEyeRootCmd := &cobra.Command{
-		Use:   "side-eye",
-		Short: "interact with side-eye.io functionality",
-		Long: `Interact with side-eye.io functionality
-
-Side-Eye (app.side-eye.io) is a distributed debugger that can be used to capture
-snapshots of a CockroachDB cluster.
-`,
-		Args: cobra.MinimumNArgs(1),
-	}
-	sideEyeRootCmd.AddCommand(buildSideEyeInstallCmd())
-	sideEyeRootCmd.AddCommand(buildSideEyeSnapCmd())
-	return sideEyeRootCmd
-}
-
-func buildSideEyeInstallCmd() *cobra.Command {
-	return &cobra.Command{
-		Use:   "install <cluster>",
-		Short: "install and start the Side-Eye agents on all nodes in the cluster",
-		Long: `Install and start the Side-Eye agents on all nodes in the cluster
-
-` + "`roachprod side-eye snapshot <cluster>`" + ` can then be used to capture cluster snapshots.
-`,
-		Args: cobra.ExactArgs(1),
-		Run: wrap(func(cmd *cobra.Command, args []string) error {
-			cluster := args[0]
-
-			ctx := context.Background()
-			l := config.Logger
-			sideEyeToken, ok := roachprod.GetSideEyeTokenFromEnv()
-			if !ok {
-				return errors.New("Side-Eye token is not configured via SIDE_EYE_API_TOKEN or gcloud secret")
-			}
-
-			return roachprod.StartSideEyeAgents(ctx, l, cluster, cluster /* envName */, sideEyeToken)
-		}),
-	}
-}
-
-func buildSideEyeSnapCmd() *cobra.Command {
-	return &cobra.Command{
-		Use:     "snapshot <cluster/Side-Eye environment>",
-		Aliases: []string{"snap"},
-		Short:   "capture a cluster snapshot",
-		Long: `Capture a cluster snapshot using Side-Eye
-
-The command will print an app.side-eye.io URL where the snapshot can be viewed.
-`,
-		Args: cobra.ExactArgs(1),
-		Run: wrap(func(cmd *cobra.Command, args []string) error {
-			cluster := args[0]
-			ctx := context.Background()
-			l := config.Logger
-			l.PrintfCtx(ctx, "capturing snapshot of the cluster with Side-Eye...")
-			snapURL, ok := roachprod.CaptureSideEyeSnapshot(context.Background(), config.Logger, cluster, nil /* client */)
-			if ok {
-				l.PrintfCtx(ctx, "captured Side-Eye snapshot: %s", snapURL)
-			}
-			return nil
-		}),
-	}
-}
-
 func (cr *commandRegistry) buildFluentBitStartCmd() *cobra.Command {
 	fluentBitStartCmd := &cobra.Command{
 		Use:   "fluent-bit-start <cluster>",

pkg/cmd/roachprod/cli/resgistry.go

@@ -64,7 +64,6 @@ func (cr *commandRegistry) register() {
 		cr.buildJaegerStartCmd(),
 		cr.buildJaegerStopCmd(),
 		cr.buildJaegerURLCmd(),
-		cr.buildSideEyeRootCmd(),
 		cr.buildFluentBitStartCmd(),
 		cr.buildFluentBitStopCmd(),
 		cr.buildOpentelemetryStartCmd(),

pkg/roachprod/BUILD.bazel

@@ -39,7 +39,6 @@ go_library(
         "//pkg/util/timeutil",
         "@com_github_cockroachdb_errors//:errors",
         "@com_github_cockroachdb_errors//oserror",
-        "@com_github_dataexmachina_dev_side_eye_go//sideeyeclient",
         "@org_golang_x_sys//unix",
     ],
 )

pkg/roachprod/install/install.go

@@ -10,14 +10,11 @@ import (
 	"context"
 	"fmt"
 	"io"
-	"os"
-	"os/exec"
 	"sort"
 	"strings"
 
 	rperrors "github.com/cockroachdb/cockroach/pkg/roachprod/errors"
 	"github.com/cockroachdb/cockroach/pkg/roachprod/logger"
-	"github.com/cockroachdb/errors"
 )
 
 var installCmds = map[string]string{
@@ -101,10 +98,6 @@ sudo apt-get install -y /tmp/otelcol-contrib.deb;
 rm /tmp/otelcol-contrib.deb;
 `,
 
-	"side-eye": `
-	curl https://sh.side-eye.io/ | SIDE_EYE_API_TOKEN=%API_KEY% SIDE_EYE_ENVIRONMENT="%ROACHPROD_CLUSTER_NAME%" sh
-	`,
-
 	"bzip2": `
 sudo apt-get update;
 sudo apt-get install -y bzip2;
@@ -121,19 +114,6 @@ sudo apt-get install -y vmtouch;
 `,
 }
 
-// installLocalCmds is a map from software name to a map of strings that
-// are replaced in the installCmd for that software with the stdout of executing
-// a command locally.
-var installLocalCmds = map[string]map[string]*exec.Cmd{
-	"side-eye": {
-		"%API_KEY%": sideEyeSecretCmd,
-	},
-}
-
-var sideEyeSecretCmd = exec.Command("gcloud",
-	"--project", "cockroach-ephemeral",
-	"secrets", "versions", "access", "latest", "--secret", "side-eye-key")
-
 // SortedCmds TODO(peter): document
 func SortedCmds() []string {
 	cmds := make([]string, 0, len(installCmds))
@@ -170,16 +150,6 @@ func InstallTool(
 	}
 	cmd = strings.ReplaceAll(cmd, "%ROACHPROD_CLUSTER_NAME%", c.Name)
 
-	for replace, localCmd := range installLocalCmds[softwareName] {
-		copy := *localCmd
-		copy.Stderr = os.Stderr
-		out, err := copy.Output()
-		if err != nil {
-			return errors.Wrapf(err, "running local command to derive install argument %s, command %s, failed", replace, copy.String())
-		}
-		cmd = strings.ReplaceAll(cmd, replace, string(out))
-	}
-
 	// Ensure that we early exit if any of the shell statements fail.
 	cmd = "set -exuo pipefail;" + cmd
 	if err := c.Run(ctx, l, stdout, stderr, WithNodes(nodes), "installing "+softwareName, cmd); err != nil {
@@ -188,13 +158,3 @@ func InstallTool(
 
 	return nil
 }
-
-func GetGcloudSideEyeSecret() string {
-	c := *sideEyeSecretCmd
-	c.Stderr = os.Stderr
-	out, err := c.Output()
-	if err != nil {
-		return ""
-	}
-	return string(out)
-}

pkg/roachprod/roachprod.go

@@ -28,7 +28,6 @@ import (
 	"sync"
 	"time"
 
-	"github.com/DataExMachina-dev/side-eye-go/sideeyeclient"
 	"github.com/cockroachdb/cockroach/pkg/build"
 	"github.com/cockroachdb/cockroach/pkg/cli/exit"
 	"github.com/cockroachdb/cockroach/pkg/cmd/roachprod/grafana"
@@ -2565,68 +2564,6 @@ func StopOpenTelemetry(ctx context.Context, l *logger.Logger, clusterName string
 	return opentelemetry.Stop(ctx, l, c)
 }
 
-// StartSideEyeAgents starts the Side-Eye agent on all the nodes in the given
-// cluster.
-//
-// envName is the name of the Side-Eye environment that the agents will register
-// with.
-//
-// apiToken is the token that the agents will use to identify their organization
-// (i.e. usually cockroachlabs.com) to the Side-Eye service.
-//
-// See CaptureSideEyeSnapshot() for using these agents to capture cluster
-// snapshots.
-func StartSideEyeAgents(
-	ctx context.Context, l *logger.Logger, clusterName string, envName string, apiToken string,
-) error {
-	c, err := GetClusterFromCache(l, clusterName)
-	if err != nil {
-		return err
-	}
-
-	// Note that this command is similar to the one used by `roachprod install
-	// side-eye`. We could use that through install.InstallTool(), but that code
-	// looks up the API token in `gcloud secrets`; we already know the token, so
-	// let's just use it directly.
-	cmd := fmt.Sprintf(
-		`curl https://sh.side-eye.io/ | SIDE_EYE_API_TOKEN="%s" SIDE_EYE_ENVIRONMENT="%s" sh`,
-		apiToken, envName)
-	allNodes := c.TargetNodes()
-	err = c.Run(
-		ctx, l, l.Stdout, l.Stderr, install.WithNodes(allNodes), "installing Side-Eye agent", cmd)
-	if err != nil {
-		return err
-	}
-
-	l.PrintfCtx(ctx, "installed the Side-Eye agent on all nodes. Access this cluster at https://app.side-eye.io")
-	return nil
-}
-
-// UpdateSideEyeEnvironmentName updates the environment name used by the
-// Side-Eye agents running on the given cluster.
-func UpdateSideEyeEnvironmentName(
-	ctx context.Context, l *logger.Logger, clusterName string, newEnvName string,
-) error {
-	c, err := GetClusterFromCache(l, clusterName)
-	if err != nil {
-		return err
-	}
-
-	cmd := fmt.Sprintf(
-		`sudo snap set side-eye-agent environment='%s' && sudo snap restart side-eye-agent`,
-		newEnvName)
-	allNodes := c.TargetNodes()
-	err = c.Run(
-		ctx, l, l.Stdout, l.Stderr, install.WithNodes(allNodes),
-		"updating Side-Eye agents with new environment name", cmd)
-	if err != nil {
-		return err
-	}
-
-	l.PrintfCtx(ctx, "updated Side-Eye environment name to %q", newEnvName)
-	return nil
-}
-
 // DestroyDNS destroys the DNS records for the given cluster.
 func DestroyDNS(ctx context.Context, l *logger.Logger, clusterName string) error {
 	c, err := GetClusterFromCache(l, clusterName)
@@ -3027,77 +2964,6 @@ func Deploy(
 	return nil
 }
 
-var sideEyeEnvToken, _ = os.LookupEnv("SIDE_EYE_API_TOKEN")
-
-// GetSideEyeTokenFromEnv returns the Side-Eye API token from either an
-// environment variable or gcloud secrets. The second return value is false if
-// the key is not found in either place.
-func GetSideEyeTokenFromEnv() (string, bool) {
-	sideEyeToken := sideEyeEnvToken
-	if sideEyeToken == "" {
-		sideEyeToken = install.GetGcloudSideEyeSecret()
-	}
-	if sideEyeToken == "" {
-		return "", false
-	}
-	return sideEyeToken, true
-}
-
-// CaptureSideEyeSnapshot asks the Side-Eye service to take a snapshot of the
-// cockroach processes of the specified cluster/environment. All errors are
-// logged and swallowed. The agents must previously have been installed
-// through StartSideEyeAgents().
-//
-// sideEyeEnv should generally be the cluster name, unless the agents have been
-// explicitly configured to use a different name.
-//
-// If client is specified, it will be used to communicate with the Side-Eye
-// service. If nil, a client is created and initialized based on the API key
-// form the environment; if the key is not found in the environment, the call is
-// a no-op.
-//
-// On success returns <the snapshot URL>, true. On failure returns "", false.
-func CaptureSideEyeSnapshot(
-	ctx context.Context, l *logger.Logger, sideEyeEnv string, client *sideeyeclient.SideEyeClient,
-) (string, bool) {
-	if client == nil {
-		sideEyeToken, ok := GetSideEyeTokenFromEnv()
-		if !ok {
-			l.Printf("Side-Eye token is not configured via SIDE_EYE_API_TOKEN or gcloud secret, skipping snapshot")
-			return "", false
-		}
-
-		var err error
-		client, err = sideeyeclient.NewSideEyeClient(sideeyeclient.WithApiToken(sideEyeToken))
-		if err != nil {
-			l.Errorf("failed to create Side-Eye client: %s", err)
-			return "", false
-		}
-		defer client.Close()
-	}
-
-	// Protect against the snapshot taking too long.
-	snapCtx, cancel := context.WithTimeout(ctx, time.Minute)
-	defer cancel()
-	snapRes, err := client.CaptureSnapshot(snapCtx, sideEyeEnv)
-	if err != nil {
-		msg := "failed to capture cluster snapshot"
-		if errors.Is(err, sideeyeclient.NoProcessesError{}) {
-			msg += "; is cockroach running?"
-		}
-		l.PrintfCtx(ctx, "Side-Eye failed to capture cluster snapshot: %s", msg)
-		return "", false
-	}
-
-	// Handle partial errors.
-	for _, pe := range snapRes.ProcessErrors {
-		l.PrintfCtx(ctx, "partial failure: error snapshotting one of the processes: %s: %s (%d): %s",
-			pe.Hostname, pe.Program, pe.Pid, pe.Error)
-	}
-
-	return snapRes.SnapshotURL, true
-}
-
 // GetClusterFromCache finds and returns a SyncedCluster from
 // the local cluster cache.
 //