ws-daemon: Plant some traces around the hooks

Author: utam0k

components/ws-daemon/pkg/content/hooks.go

@@ -11,12 +11,14 @@ import (
 	"os"
 
 	"github.com/gitpod-io/gitpod/common-go/log"
+	"github.com/gitpod-io/gitpod/common-go/tracing"
 	"github.com/gitpod-io/gitpod/content-service/pkg/initializer"
 	"github.com/gitpod-io/gitpod/content-service/pkg/storage"
 	"github.com/gitpod-io/gitpod/ws-daemon/api"
 	"github.com/gitpod-io/gitpod/ws-daemon/pkg/internal/session"
 	"github.com/gitpod-io/gitpod/ws-daemon/pkg/iws"
 	"github.com/gitpod-io/gitpod/ws-daemon/pkg/quota"
+	"github.com/opentracing/opentracing-go"
 	"golang.org/x/xerrors"
 )
 
@@ -50,7 +52,10 @@ func workspaceLifecycleHooks(cfg Config, kubernetesNamespace string, workspaceEx
 
 // hookSetupRemoteStorage configures the remote storage for a workspace
 func hookSetupRemoteStorage(cfg Config) session.WorkspaceLivecycleHook {
-	return func(ctx context.Context, ws *session.Workspace) error {
+	return func(ctx context.Context, ws *session.Workspace) (err error) {
+		span, ctx := opentracing.StartSpanFromContext(ctx, "hook.SetupRemoteStorage")
+		defer tracing.FinishSpan(span, &err)
+
 		if _, ok := ws.NonPersistentAttrs[session.AttrRemoteStorage]; !ws.RemoteStorageDisabled && !ok {
 			remoteStorage, err := storage.NewDirectAccess(&cfg.Storage)
 			if err != nil {
@@ -75,7 +80,10 @@ func hookSetupRemoteStorage(cfg Config) session.WorkspaceLivecycleHook {
 }
 
 // hookSetupWorkspaceLocation recreates the workspace location
-func hookSetupWorkspaceLocation(ctx context.Context, ws *session.Workspace) error {
+func hookSetupWorkspaceLocation(ctx context.Context, ws *session.Workspace) (err error) {
+	//nolint:ineffassign
+	span, _ := opentracing.StartSpanFromContext(ctx, "hook.SetupWorkspaceLocation")
+	defer tracing.FinishSpan(span, &err)
 	location := ws.Location
 
 	// 1. Clean out the workspace directory
@@ -90,7 +98,7 @@ func hookSetupWorkspaceLocation(ctx context.Context, ws *session.Workspace) erro
 	}
 
 	// Chown the workspace directory
-	err := os.Chown(location, initializer.GitpodUID, initializer.GitpodGID)
+	err = os.Chown(location, initializer.GitpodUID, initializer.GitpodGID)
 	if err != nil {
 		return xerrors.Errorf("cannot create workspace: %w", err)
 	}
@@ -99,7 +107,10 @@ func hookSetupWorkspaceLocation(ctx context.Context, ws *session.Workspace) erro
 
 // hookInstallQuota enforces filesystem quota on the workspace location (if the filesystem supports it)
 func hookInstallQuota(xfs *quota.XFS, isHard bool) session.WorkspaceLivecycleHook {
-	return func(ctx context.Context, ws *session.Workspace) error {
+	return func(ctx context.Context, ws *session.Workspace) (err error) {
+		span, _ := opentracing.StartSpanFromContext(ctx, "hook.InstallQuota")
+		defer tracing.FinishSpan(span, &err)
+
 		if xfs == nil {
 			return nil
 		}
@@ -114,7 +125,6 @@ func hookInstallQuota(xfs *quota.XFS, isHard bool) session.WorkspaceLivecycleHoo
 
 		var (
 			prj int
-			err error
 		)
 		if ws.XFSProjectID != 0 {
 			xfs.RegisterProject(ws.XFSProjectID)
@@ -134,7 +144,10 @@ func hookInstallQuota(xfs *quota.XFS, isHard bool) session.WorkspaceLivecycleHoo
 
 // hookRemoveQuota removes the filesystem quota, freeing up resources if need be
 func hookRemoveQuota(xfs *quota.XFS) session.WorkspaceLivecycleHook {
-	return func(ctx context.Context, ws *session.Workspace) error {
+	return func(ctx context.Context, ws *session.Workspace) (err error) {
+		span, _ := opentracing.StartSpanFromContext(ctx, "hook.RemoveQuota")
+		defer tracing.FinishSpan(span, &err)
+
 		if xfs == nil {
 			return nil
 		}

components/ws-daemon/pkg/iws/iws.go

@@ -87,27 +87,26 @@ var (
 // ServeWorkspace establishes the IWS server for a workspace
 func ServeWorkspace(uidmapper *Uidmapper, fsshift api.FSShiftMethod, cgroupMountPoint string) func(ctx context.Context, ws *session.Workspace) error {
 	return func(ctx context.Context, ws *session.Workspace) (err error) {
+		span, _ := opentracing.StartSpanFromContext(ctx, "iws.ServeWorkspace")
+		defer tracing.FinishSpan(span, &err)
 		if _, running := ws.NonPersistentAttrs[session.AttrWorkspaceServer]; running {
+			span.SetTag("alreadyRunning", true)
 			return nil
 		}
 
-		//nolint:ineffassign
-		span, ctx := opentracing.StartSpanFromContext(ctx, "iws.ServeWorkspace")
-		defer tracing.FinishSpan(span, &err)
-
-		helper := &InWorkspaceServiceServer{
+		iws := &InWorkspaceServiceServer{
 			Uidmapper:        uidmapper,
 			Session:          ws,
 			FSShift:          fsshift,
 			CGroupMountPoint: cgroupMountPoint,
 		}
-		err = helper.Start()
+		err = iws.Start()
 		if err != nil {
 			return xerrors.Errorf("cannot start in-workspace-helper server: %w", err)
 		}
 
 		log.WithFields(ws.OWI()).Debug("established IWS server")
-		ws.NonPersistentAttrs[session.AttrWorkspaceServer] = helper.Stop
+		ws.NonPersistentAttrs[session.AttrWorkspaceServer] = iws.Stop
 
 		return nil
 	}
@@ -116,7 +115,7 @@ func ServeWorkspace(uidmapper *Uidmapper, fsshift api.FSShiftMethod, cgroupMount
 // StopServingWorkspace stops a previously started workspace server
 func StopServingWorkspace(ctx context.Context, ws *session.Workspace) (err error) {
 	//nolint:ineffassign
-	span, ctx := opentracing.StartSpanFromContext(ctx, "iws.StopServingWorkspace")
+	span, _ := opentracing.StartSpanFromContext(ctx, "iws.StopServingWorkspace")
 	defer tracing.FinishSpan(span, &err)
 
 	rawStop, ok := ws.NonPersistentAttrs[session.AttrWorkspaceServer]