runtime: add spans and attributes for agent/mount

Add more spans and attributes for agent setup, add devices,
and mount volumes.

Fixes: #1968

Signed-off-by: bin <bin@hyper.sh>

src/runtime/virtcontainers/agent.go

@@ -163,7 +163,7 @@ type agent interface {
 	configure(ctx context.Context, h hypervisor, id, sharePath string, config KataAgentConfig) error
 
 	// configureFromGrpc will update agent settings based on provided arguments which from Grpc
-	configureFromGrpc(h hypervisor, id string, config KataAgentConfig) error
+	configureFromGrpc(ctx context.Context, h hypervisor, id string, config KataAgentConfig) error
 
 	// reseedRNG will reseed the guest random number generator
 	reseedRNG(ctx context.Context, data []byte) error

src/runtime/virtcontainers/kata_agent.go

@@ -32,6 +32,7 @@ import (
 	"github.com/kata-containers/kata-containers/src/runtime/virtcontainers/types"
 	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/label"
+	otelLabel "go.opentelemetry.io/otel/label"
 	otelTrace "go.opentelemetry.io/otel/trace"
 
 	"github.com/gogo/protobuf/proto"
@@ -372,17 +373,25 @@ func (k *kataAgent) capabilities() types.Capabilities {
 	return caps
 }
 
-func (k *kataAgent) internalConfigure(h hypervisor, id string, config KataAgentConfig) error {
+func (k *kataAgent) internalConfigure(ctx context.Context, h hypervisor, id string, config KataAgentConfig) error {
+	span, _ := k.trace(ctx, "configure")
+	defer span.End()
+
 	var err error
 	if k.vmSocket, err = h.generateSocket(id); err != nil {
 		return err
 	}
 	k.keepConn = config.LongLiveConn
 
+	span.SetAttributes(otelLabel.Any("socket", k.vmSocket))
+
 	return nil
 }
 
-func (k *kataAgent) setupSandboxBindMounts(sandbox *Sandbox) (err error) {
+func (k *kataAgent) setupSandboxBindMounts(ctx context.Context, sandbox *Sandbox) (err error) {
+	span, ctx := k.trace(ctx, "setupSandboxBindMounts")
+	defer span.End()
+
 	if len(sandbox.config.SandboxBindMounts) == 0 {
 		return nil
 	}
@@ -411,13 +420,13 @@ func (k *kataAgent) setupSandboxBindMounts(sandbox *Sandbox) (err error) {
 	for _, m := range sandbox.config.SandboxBindMounts {
 		mountDest := filepath.Join(sandboxMountDir, filepath.Base(m))
 		// bind-mount each sandbox mount that's defined into the sandbox mounts dir
-		if err := bindMount(context.Background(), m, mountDest, true, "private"); err != nil {
+		if err := bindMount(ctx, m, mountDest, true, "private"); err != nil {
 			return fmt.Errorf("Mounting sandbox directory: %v to %v: %w", m, mountDest, err)
 		}
 		mountedList = append(mountedList, mountDest)
 
 		mountDest = filepath.Join(sandboxShareDir, filepath.Base(m))
-		if err := remountRo(context.Background(), mountDest); err != nil {
+		if err := remountRo(ctx, mountDest); err != nil {
 			return fmt.Errorf("remount sandbox directory: %v to %v: %w", m, mountDest, err)
 		}
 
@@ -453,7 +462,10 @@ func (k *kataAgent) cleanupSandboxBindMounts(sandbox *Sandbox) error {
 }
 
 func (k *kataAgent) configure(ctx context.Context, h hypervisor, id, sharePath string, config KataAgentConfig) error {
-	err := k.internalConfigure(h, id, config)
+	span, ctx := k.trace(ctx, "configure")
+	defer span.End()
+
+	err := k.internalConfigure(ctx, h, id, config)
 	if err != nil {
 		return err
 	}
@@ -494,11 +506,14 @@ func (k *kataAgent) configure(ctx context.Context, h hypervisor, id, sharePath s
 	return h.addDevice(ctx, sharedVolume, fsDev)
 }
 
-func (k *kataAgent) configureFromGrpc(h hypervisor, id string, config KataAgentConfig) error {
+func (k *kataAgent) configureFromGrpc(ctx context.Context, h hypervisor, id string, config KataAgentConfig) error {
-	return k.internalConfigure(h, id, config)
+	return k.internalConfigure(ctx, h, id, config)
 }
 
 func (k *kataAgent) setupSharedPath(ctx context.Context, sandbox *Sandbox) (err error) {
+	span, ctx := k.trace(ctx, "setupSharedPath")
+	defer span.End()
+
 	// create shared path structure
 	sharePath := getSharePath(sandbox.id)
 	mountPath := getMountPath(sandbox.id)
@@ -522,7 +537,7 @@ func (k *kataAgent) setupSharedPath(ctx context.Context, sandbox *Sandbox) (err
 	}()
 
 	// Setup sandbox bindmounts, if specified:
-	if err = k.setupSandboxBindMounts(sandbox); err != nil {
+	if err = k.setupSandboxBindMounts(ctx, sandbox); err != nil {
 		return err
 	}
 

src/runtime/virtcontainers/kata_agent_test.go

@@ -1279,7 +1279,7 @@ func TestSandboxBindMount(t *testing.T) {
 	defer syscall.Unmount(sharePath, syscall.MNT_DETACH|UmountNoFollow)
 
 	// Test the function. We expect it to succeed and for the mount to exist
-	err = k.setupSandboxBindMounts(sandbox)
+	err = k.setupSandboxBindMounts(context.Background(), sandbox)
 	assert.NoError(err)
 
 	// Test the cleanup function. We expect it to succeed for the mount to be removed.
@@ -1303,9 +1303,9 @@ func TestSandboxBindMount(t *testing.T) {
 	// We expect cleanup to fail on the first time, since it cannot remove the sandbox-bindmount directory because
 	// there are leftover mounts.   If we run it a second time, however, it should succeed since it'll remove the
 	// second set of mounts:
-	err = k.setupSandboxBindMounts(sandbox)
+	err = k.setupSandboxBindMounts(context.Background(), sandbox)
 	assert.NoError(err)
-	err = k.setupSandboxBindMounts(sandbox)
+	err = k.setupSandboxBindMounts(context.Background(), sandbox)
 	assert.NoError(err)
 	// Test the cleanup function. We expect it to succeed for the mount to be removed.
 	err = k.cleanupSandboxBindMounts(sandbox)
@@ -1317,7 +1317,7 @@ func TestSandboxBindMount(t *testing.T) {
 	// Now, let's setup the sandbox bindmount to fail, and verify that no mounts are left behind
 	//
 	sandbox.config.SandboxBindMounts = append(sandbox.config.SandboxBindMounts, "oh-nos")
-	err = k.setupSandboxBindMounts(sandbox)
+	err = k.setupSandboxBindMounts(context.Background(), sandbox)
 	assert.Error(err)
 	// Verify there aren't any mounts left behind
 	stat = syscall.Stat_t{}

src/runtime/virtcontainers/mock_agent.go

@@ -176,7 +176,7 @@ func (n *mockAgent) configure(ctx context.Context, h hypervisor, id, sharePath s
 	return nil
 }
 
-func (n *mockAgent) configureFromGrpc(h hypervisor, id string, config KataAgentConfig) error {
+func (n *mockAgent) configureFromGrpc(ctx context.Context, h hypervisor, id string, config KataAgentConfig) error {
 	return nil
 }
 

src/runtime/virtcontainers/mount.go

@@ -17,6 +17,7 @@ import (
 	merr "github.com/hashicorp/go-multierror"
 	"github.com/kata-containers/kata-containers/src/runtime/virtcontainers/utils"
 	"github.com/sirupsen/logrus"
+	otelLabel "go.opentelemetry.io/otel/label"
 )
 
 // DefaultShmSize is the default shm size to be used in case host
@@ -257,11 +258,13 @@ func moveMount(ctx context.Context, source, destination string) error {
 func bindMount(ctx context.Context, source, destination string, readonly bool, pgtypes string) error {
 	span, _ := trace(ctx, "bindMount")
 	defer span.End()
+	span.SetAttributes(otelLabel.String("source", source), otelLabel.String("destination", destination))
 
 	absSource, destination, err := evalMountPath(source, destination)
 	if err != nil {
 		return err
 	}
+	span.SetAttributes(otelLabel.String("source_after_eval", absSource))
 
 	if err := syscall.Mount(absSource, destination, "bind", syscall.MS_BIND, ""); err != nil {
 		return fmt.Errorf("Could not bind mount %v to %v: %v", absSource, destination, err)
@@ -290,10 +293,15 @@ func bindMount(ctx context.Context, source, destination string, readonly bool, p
 // The mountflags should match the values used in the original mount() call,
 // except for those parameters that you are trying to change.
 func remount(ctx context.Context, mountflags uintptr, src string) error {
+	span, _ := trace(ctx, "remount")
+	defer span.End()
+	span.SetAttributes(otelLabel.String("source", src))
+
 	absSrc, err := filepath.EvalSymlinks(src)
 	if err != nil {
 		return fmt.Errorf("Could not resolve symlink for %s", src)
 	}
+	span.SetAttributes(otelLabel.String("source_after_eval", absSrc))
 
 	if err := syscall.Mount(absSrc, absSrc, "", syscall.MS_REMOUNT|mountflags, ""); err != nil {
 		return fmt.Errorf("remount %s failed: %v", absSrc, err)
@@ -352,6 +360,7 @@ func isSymlink(path string) bool {
 func bindUnmountContainerRootfs(ctx context.Context, sharedDir, cID string) error {
 	span, _ := trace(ctx, "bindUnmountContainerRootfs")
 	defer span.End()
+	span.SetAttributes(otelLabel.String("shared_dir", sharedDir), otelLabel.String("container_id", cID))
 
 	rootfsDest := filepath.Join(sharedDir, cID, rootfsDir)
 	if isSymlink(filepath.Join(sharedDir, cID)) || isSymlink(rootfsDest) {
@@ -374,6 +383,7 @@ func bindUnmountContainerRootfs(ctx context.Context, sharedDir, cID string) erro
 func bindUnmountAllRootfs(ctx context.Context, sharedDir string, sandbox *Sandbox) error {
 	span, ctx := trace(ctx, "bindUnmountAllRootfs")
 	defer span.End()
+	span.SetAttributes(otelLabel.String("shared_dir", sharedDir), otelLabel.String("sandbox_id", sandbox.id))
 
 	var errors *merr.Error
 	for _, c := range sandbox.containers {

src/runtime/virtcontainers/qemu.go

@@ -1601,6 +1601,7 @@ func (q *qemu) hotplugDevice(ctx context.Context, devInfo interface{}, devType d
 func (q *qemu) hotplugAddDevice(ctx context.Context, devInfo interface{}, devType deviceType) (interface{}, error) {
 	span, ctx := q.trace(ctx, "hotplugAddDevice")
 	defer span.End()
+	span.SetAttributes(otelLabel.Any("device", devInfo))
 
 	data, err := q.hotplugDevice(ctx, devInfo, devType, addDevice)
 	if err != nil {
@@ -1613,6 +1614,7 @@ func (q *qemu) hotplugAddDevice(ctx context.Context, devInfo interface{}, devTyp
 func (q *qemu) hotplugRemoveDevice(ctx context.Context, devInfo interface{}, devType deviceType) (interface{}, error) {
 	span, ctx := q.trace(ctx, "hotplugRemoveDevice")
 	defer span.End()
+	span.SetAttributes(otelLabel.Any("device", devInfo))
 
 	data, err := q.hotplugDevice(ctx, devInfo, devType, removeDevice)
 	if err != nil {
@@ -1841,6 +1843,7 @@ func (q *qemu) addDevice(ctx context.Context, devInfo interface{}, devType devic
 	var err error
 	span, _ := q.trace(ctx, "addDevice")
 	defer span.End()
+	span.SetAttributes(otelLabel.Any("device", devInfo))
 
 	switch v := devInfo.(type) {
 	case types.Volume:

src/runtime/virtcontainers/vm.go

@@ -191,7 +191,7 @@ func NewVMFromGrpc(ctx context.Context, v *pb.GrpcVM, config VMConfig) (*VM, err
 	// create agent instance
 	newAagentFunc := getNewAgentFunc(ctx)
 	agent := newAagentFunc()
-	agent.configureFromGrpc(hypervisor, v.Id, config.AgentConfig)
+	agent.configureFromGrpc(ctx, hypervisor, v.Id, config.AgentConfig)
 
 	return &VM{
 		id:         v.Id,