[Refactor] Adding structured logging to Nodeserver (#218)

* Implement structured logging and improve error handling

- Add Logger struct with context-aware logging methods
- Refactor NodeServer methods to use structured logging
- Update main.go to initialize and use the new logger
- Adjust unit tests to accommodate new logging structure

---------

Co-authored-by: Khaja Omer <komer@akamai.com>

Author: komer3

go.mod

@@ -4,6 +4,8 @@ go 1.22.5
 
 require (
 	github.com/container-storage-interface/spec v1.10.0
+	github.com/go-logr/logr v1.4.1
+	github.com/google/uuid v1.6.0
 	github.com/ianschenck/envflag v0.0.0-20140720210342-9111d830d133
 	github.com/linode/go-metadata v0.2.0
 	github.com/linode/linodego v1.35.0
@@ -19,7 +21,6 @@ require (
 )
 
 require (
-	github.com/go-logr/logr v1.4.1 // indirect
 	github.com/go-resty/resty/v2 v2.13.1 // indirect
 	github.com/moby/sys/mountinfo v0.6.2 // indirect
 	golang.org/x/text v0.16.0 // indirect

go.sum

@@ -53,6 +53,8 @@ github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeN
 github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
 github.com/google/gofuzz v1.1.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
 github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/googleapis/gnostic v0.4.1/go.mod h1:LRhVm6pbyptWbWbuZ38d1eyptfvIytN3ir6b65WBswg=
 github.com/hashicorp/golang-lru v0.5.1/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8=
 github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=

internal/driver/controllerserver.go

@@ -230,7 +230,7 @@ func (cs *ControllerServer) CreateVolume(ctx context.Context, req *csi.CreateVol
 	}
 
 	klog.V(4).Infoln("[CreateVolume] volume created successfully", map[string]interface{}{
-	    "response": 				resp,
+		"response": resp,
 	})
 	return resp, nil
 }

internal/driver/driver.go

@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 import (
+	"context"
 	"errors"
 	"fmt"
 	"regexp"
@@ -24,10 +25,10 @@ import (
 	"github.com/container-storage-interface/spec/lib/go/csi"
 	linodeclient "github.com/linode/linode-blockstorage-csi-driver/pkg/linode-client"
 
+	"github.com/linode/linode-blockstorage-csi-driver/pkg/logger"
 	mountmanager "github.com/linode/linode-blockstorage-csi-driver/pkg/mount-manager"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
-	"k8s.io/klog/v2"
 	"k8s.io/mount-utils"
 )
 
@@ -106,7 +107,7 @@ func (linodeDriver *LinodeDriver) SetupLinodeDriver(
 	if err != nil {
 		return fmt.Errorf("new node server: %w", err)
 	}
-	
+
 	linodeDriver.ids, err = NewIdentityServer(linodeDriver)
 	if err != nil {
 		return fmt.Errorf("new identity server: %w", err)
@@ -135,10 +136,11 @@ func (linodeDriver *LinodeDriver) ValidateControllerServiceRequest(c csi.Control
 	return status.Error(codes.InvalidArgument, "Invalid controller service request")
 }
 
-func (linodeDriver *LinodeDriver) Run(endpoint string) {
-	klog.V(4).Infof("Driver: %v", linodeDriver.name)
+func (linodeDriver *LinodeDriver) Run(ctx context.Context, endpoint string) {
+	log := logger.GetLogger(ctx)
+	log.V(4).Info("Driver", "name", linodeDriver.name)
 	if len(linodeDriver.volumeLabelPrefix) > 0 {
-		klog.V(4).Infof("BS Volume Prefix: %v", linodeDriver.volumeLabelPrefix)
+		log.V(4).Info("BS Volume Prefix", "prefix", linodeDriver.volumeLabelPrefix)
 	}
 
 	linodeDriver.readyMu.Lock()

internal/driver/driver_test.go

@@ -1,6 +1,7 @@
 package driver
 
 import (
+	"context"
 	"fmt"
 	"net/http/httptest"
 	"os"
@@ -53,8 +54,8 @@ func TestDriverSuite(t *testing.T) {
 	defer mockCtrl.Finish()
 
 	mounter := &mount.SafeFormatAndMount{
-		Interface: mocks.NewMockMounter(mockCtrl), 
-		Exec: mocks.NewMockExecutor(mockCtrl),
+		Interface: mocks.NewMockMounter(mockCtrl),
+		Exec:      mocks.NewMockExecutor(mockCtrl),
 	}
 	deviceUtils := mocks.NewMockDeviceUtils(mockCtrl)
 	fileSystem := mocks.NewMockFileSystem(mockCtrl)
@@ -77,11 +78,10 @@ func TestDriverSuite(t *testing.T) {
 		t.Fatalf("Failed to setup Linode Driver: %v", err)
 	}
 
-	go linodeDriver.Run(endpoint)
+	go linodeDriver.Run(context.Background(), endpoint)
 
 	// TODO: fix sanity checks for e2e, disable for ci
 	// cfg := sanity.NewTestConfig()
 	// cfg.Address = endpoint
 	// sanity.Test(t, cfg)
 }
-

internal/driver/identityserver.go

@@ -80,7 +80,7 @@ func (linodeIdentity *IdentityServer) GetPluginCapabilities(ctx context.Context,
 					// 	2. Delete and recreate the pod that is using the PVC(or scale replicas accordingly)
 					// 	3. This operation should detach and re-attach the volume to the newly created pod allowing you to use the updated size
 					VolumeExpansion: &csi.PluginCapability_VolumeExpansion{
-						Type: csi.PluginCapability_VolumeExpansion_OFFLINE,
+						Type: csi.PluginCapability_VolumeExpansion_ONLINE,
 					},
 				},
 			},