all: more logging, everywhere

Co-authored-by: Morten Lied Johansen <[email protected]>

Author: tronghn

cmd/cleanup/main.go

@@ -3,15 +3,16 @@ package main
 import (
 	"context"
 	"fmt"
+	"os"
+	"time"
+
 	"github.com/nais/cloudsql-migrator/internal/pkg/common_main"
 	"github.com/nais/cloudsql-migrator/internal/pkg/config"
 	"github.com/nais/cloudsql-migrator/internal/pkg/instance"
 	"github.com/nais/cloudsql-migrator/internal/pkg/migration"
 	"github.com/nais/cloudsql-migrator/internal/pkg/resolved"
 	"github.com/sethvargo/go-envconfig"
 	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"os"
-	"time"
 )
 
 func main() {
@@ -83,7 +84,6 @@ func main() {
 		os.Exit(9)
 	}
 
-	mgr.Logger.Info("deleting authorized networks")
 	err = instance.CleanupAuthNetworks(ctx, target, mgr)
 	if err != nil {
 		mgr.Logger.Error("failed to cleanup authorized networks", "error", err)

cmd/promote/main.go

@@ -3,6 +3,9 @@ package main
 import (
 	"context"
 	"fmt"
+	"os"
+	"time"
+
 	"github.com/nais/cloudsql-migrator/internal/pkg/application"
 	"github.com/nais/cloudsql-migrator/internal/pkg/backup"
 	"github.com/nais/cloudsql-migrator/internal/pkg/common_main"
@@ -12,8 +15,6 @@ import (
 	"github.com/nais/cloudsql-migrator/internal/pkg/promote"
 	"github.com/nais/cloudsql-migrator/internal/pkg/resolved"
 	"github.com/sethvargo/go-envconfig"
-	"os"
-	"time"
 )
 
 func main() {
@@ -42,6 +43,7 @@ func main() {
 		os.Exit(3)
 	}
 
+	mgr.Logger.Info("getting application", "name", cfg.ApplicationName)
 	app, err := mgr.AppClient.Get(ctx, cfg.ApplicationName)
 	if err != nil {
 		mgr.Logger.Error("failed to get application", "error", err)
@@ -66,6 +68,7 @@ func main() {
 		os.Exit(7)
 	}
 
+	mgr.Logger.Info("getting helper application", "name", helperName)
 	helperApp, err := mgr.AppClient.Get(ctx, helperName)
 	if err != nil {
 		mgr.Logger.Error("failed to get helper application", "error", err)

internal/pkg/instance/certificate.go

@@ -3,15 +3,16 @@ package instance
 import (
 	"context"
 	"fmt"
+	"os"
+	"time"
+
 	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/clients/generated/apis/k8s/v1alpha1"
 	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/clients/generated/apis/sql/v1beta1"
 	"github.com/nais/cloudsql-migrator/internal/pkg/common_main"
 	"github.com/nais/cloudsql-migrator/internal/pkg/config"
 	"github.com/nais/cloudsql-migrator/internal/pkg/resolved"
 	"k8s.io/apimachinery/pkg/api/errors"
 	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"os"
-	"time"
 )
 
 type CertPaths struct {
@@ -117,6 +118,7 @@ func DeleteSslCertByCommonName(ctx context.Context, instanceName, commonName str
 	ctx, cancel := context.WithTimeout(ctx, 5*time.Minute)
 	defer cancel()
 
+	mgr.Logger.Info("listing ssl certs", "instance", instanceName)
 	listResponse, err := sslCertsService.List(gcpProject.Id, instanceName).Context(ctx).Do()
 	if err != nil {
 		return fmt.Errorf("failed to list ssl certs: %w", err)

internal/pkg/instance/instance.go

@@ -4,6 +4,13 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"io"
+	"net/http"
+	"os"
+	"os/user"
+	"strings"
+	"time"
+
 	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/clients/generated/apis/sql/v1beta1"
 	_ "github.com/lib/pq"
 	"github.com/nais/cloudsql-migrator/internal/pkg/common_main"
@@ -12,15 +19,9 @@ import (
 	nais_io_v1 "github.com/nais/liberator/pkg/apis/nais.io/v1"
 	nais_io_v1alpha1 "github.com/nais/liberator/pkg/apis/nais.io/v1alpha1"
 	"google.golang.org/api/googleapi"
-	"io"
 	k8s_errors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/utils/ptr"
-	"net/http"
-	"os"
-	"os/user"
-	"strings"
-	"time"
 )
 
 const (
@@ -30,6 +31,7 @@ const (
 )
 
 func CreateInstance(ctx context.Context, cfg *config.Config, source *resolved.Instance, gcpProject *resolved.GcpProject, databaseName string, mgr *common_main.Manager) (*resolved.Instance, error) {
+	mgr.Logger.Info("getting source application", "name", cfg.ApplicationName)
 	app, err := mgr.AppClient.Get(ctx, cfg.ApplicationName)
 	if err != nil {
 		return nil, err
@@ -42,6 +44,7 @@ func CreateInstance(ctx context.Context, cfg *config.Config, source *resolved.In
 		return nil, err
 	}
 
+	mgr.Logger.Info("get helper application", "name", helperName)
 	dummyApp, err := mgr.AppClient.Get(ctx, helperName)
 	if k8s_errors.IsNotFound(err) {
 		dummyApp = &nais_io_v1alpha1.Application{
@@ -71,6 +74,7 @@ func CreateInstance(ctx context.Context, cfg *config.Config, source *resolved.In
 			},
 		}
 
+		mgr.Logger.Info("creating helper application", "name", helperName)
 		app, err = mgr.AppClient.Create(ctx, dummyApp)
 	}
 	if err != nil {
@@ -213,15 +217,15 @@ func PrepareTargetInstance(ctx context.Context, cfg *config.Config, target *reso
 }
 
 func prepareTargetInstanceWithRetries(ctx context.Context, cfg *config.Config, target *resolved.Instance, mgr *common_main.Manager, retries int) error {
+	mgr.Logger.Info("preparing target instance for migration")
+
 	targetSqlInstance, err := mgr.SqlInstanceClient.Get(ctx, target.Name)
 	if err != nil {
 		if !k8s_errors.IsNotFound(err) {
 			return err
 		}
 	}
 
-	mgr.Logger.Info("preparing target instance for migration")
-
 	targetSqlInstance.Spec.Settings.BackupConfiguration.Enabled = ptr.To(false)
 
 	var authNetwork v1beta1.InstanceAuthorizedNetworks
@@ -232,6 +236,7 @@ func prepareTargetInstanceWithRetries(ctx context.Context, cfg *config.Config, t
 
 	targetSqlInstance.Spec.Settings.IpConfiguration.AuthorizedNetworks = appendAuthNetIfNotExists(targetSqlInstance, authNetwork)
 
+	mgr.Logger.Info("updating target instance", "name", target.Name)
 	_, err = mgr.SqlInstanceClient.Update(ctx, targetSqlInstance)
 	if err != nil {
 		if k8s_errors.IsConflict(err) && retries > 0 {
@@ -291,7 +296,7 @@ func updateTargetInstanceAfterPromotionWithRetries(ctx context.Context, target *
 func DeleteInstance(ctx context.Context, instanceName string, gcpProject *resolved.GcpProject, mgr *common_main.Manager) error {
 	instancesService := mgr.SqlAdminService.Instances
 
-	mgr.Logger.Debug("checking for existence before deletion")
+	mgr.Logger.Info("checking for instance existence before deletion", "name", instanceName)
 	_, err := instancesService.Get(gcpProject.Id, instanceName).Context(ctx).Do()
 	if err != nil {
 		var ae *googleapi.Error
@@ -315,6 +320,7 @@ func CleanupAuthNetworks(ctx context.Context, target *resolved.Instance, mgr *co
 }
 
 func cleanupAuthNetworksWithRetries(ctx context.Context, target *resolved.Instance, mgr *common_main.Manager, retries int) error {
+	mgr.Logger.Info("deleting authorized networks")
 	targetSqlInstance, err := mgr.SqlInstanceClient.Get(ctx, target.Name)
 	if err != nil {
 		return fmt.Errorf("failed to get target instance: %w", err)

internal/pkg/instance/profile.go

@@ -1,10 +1,11 @@
 package instance
 
 import (
-	clouddms "cloud.google.com/go/clouddms/apiv1"
-	"cloud.google.com/go/clouddms/apiv1/clouddmspb"
 	"context"
 	"fmt"
+
+	clouddms "cloud.google.com/go/clouddms/apiv1"
+	"cloud.google.com/go/clouddms/apiv1/clouddmspb"
 	"github.com/nais/cloudsql-migrator/internal/pkg/common_main"
 	"github.com/nais/cloudsql-migrator/internal/pkg/config"
 	"github.com/nais/cloudsql-migrator/internal/pkg/resolved"
@@ -91,6 +92,7 @@ func deleteOldConnectionProfiles(ctx context.Context, cps map[string]*clouddmspb
 	}
 
 	for _, deleteOperation := range deleteOperations {
+		mgr.Logger.Info("waiting for connection profile deletion...", "name", deleteOperation.Name())
 		err := deleteOperation.Wait(ctx)
 		if err != nil {
 			return fmt.Errorf("failed to wait for connection profile deletion: %w", err)

internal/pkg/migration/migration.go

@@ -3,10 +3,11 @@ package migration
 import (
 	"context"
 	"fmt"
+	"time"
+
 	"github.com/nais/cloudsql-migrator/internal/pkg/config"
 	"github.com/nais/cloudsql-migrator/internal/pkg/instance"
 	"github.com/nais/cloudsql-migrator/internal/pkg/resolved"
-	"time"
 
 	"cloud.google.com/go/clouddms/apiv1/clouddmspb"
 	"github.com/nais/cloudsql-migrator/internal/pkg/common_main"
@@ -89,6 +90,7 @@ func demoteTargetInstance(ctx context.Context, migrationJob *clouddmspb.Migratio
 }
 
 func createMigrationJob(ctx context.Context, migrationName string, cfg *config.Config, gcpProject *resolved.GcpProject, mgr *common_main.Manager) (*clouddmspb.MigrationJob, error) {
+	mgr.Logger.Info("looking for existing migration job", "name", migrationName)
 	migrationJob, err := mgr.DBMigrationClient.GetMigrationJob(ctx, &clouddmspb.GetMigrationJobRequest{
 		Name: gcpProject.GcpComponentURI("migrationJobs", migrationName),
 	})
@@ -125,6 +127,7 @@ func createMigrationJob(ctx context.Context, migrationName string, cfg *config.C
 		return nil, fmt.Errorf("unable to create new migration job: %w", err)
 	}
 
+	mgr.Logger.Info("waiting for migration job creation", "name", migrationName)
 	migrationJob, err = createOperation.Wait(ctx)
 	if err != nil {
 		return nil, fmt.Errorf("failed waiting for migration job creation: %w", err)

internal/pkg/netpol/netpol.go

@@ -3,18 +3,20 @@ package netpol
 import (
 	"context"
 	"fmt"
+	"os"
+
 	"github.com/nais/cloudsql-migrator/internal/pkg/common_main"
 	"github.com/nais/cloudsql-migrator/internal/pkg/config"
 	"github.com/nais/cloudsql-migrator/internal/pkg/resolved"
 	v1 "k8s.io/api/networking/v1"
 	k8s_errors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"os"
 )
 
 func CreateNetworkPolicy(ctx context.Context, cfg *config.Config, source *resolved.Instance, target *resolved.Instance, mgr *common_main.Manager) error {
 	v := os.Getenv("KUBERNETES_SERVICE_HOST")
 	if v == "" {
+		mgr.Logger.Debug("not running in kubernetes, skipping network policy creation")
 		return nil
 	}
 
@@ -49,9 +51,11 @@ func CreateNetworkPolicy(ctx context.Context, cfg *config.Config, source *resolv
 		},
 	}
 
+	mgr.Logger.Info("creating network policy", "name", netpol.Name)
 	_, err := mgr.K8sClient.NetworkingV1().NetworkPolicies(cfg.Namespace).Create(ctx, netpol, metav1.CreateOptions{})
 	if err != nil {
 		if k8s_errors.IsAlreadyExists(err) {
+			mgr.Logger.Info("network policy already exists, updating", "name", netpol.Name)
 			_, err = mgr.K8sClient.NetworkingV1().NetworkPolicies(cfg.Namespace).Update(ctx, netpol, metav1.UpdateOptions{})
 			if err != nil {
 				return fmt.Errorf("failed to update network policy: %w", err)

internal/pkg/promote/promote.go

@@ -103,14 +103,14 @@ func waitForReplicationLagToReachZero(ctx context.Context, target *resolved.Inst
 	req := &monitoringpb.QueryTimeSeriesRequest{
 		Name: gcpProject.GcpParentURI(),
 		Query: "fetch cloudsql_database\n" +
-				"| metric\n" +
-				"    'cloudsql.googleapis.com/database/postgresql/external_sync/max_replica_byte_lag'\n" +
-				"| filter\n" +
-				"    resource.region == 'europe-north1' && \n" +
-				fmt.Sprintf("    resource.project_id == '%s' &&\n", gcpProject.Id) +
-				fmt.Sprintf("    resource.database_id == '%s:%s'\n", gcpProject.Id, target.Name) +
-				"| group_by [], mean(val())\n" +
-				"| within 5m\n",
+			"| metric\n" +
+			"    'cloudsql.googleapis.com/database/postgresql/external_sync/max_replica_byte_lag'\n" +
+			"| filter\n" +
+			"    resource.region == 'europe-north1' && \n" +
+			fmt.Sprintf("    resource.project_id == '%s' &&\n", gcpProject.Id) +
+			fmt.Sprintf("    resource.database_id == '%s:%s'\n", gcpProject.Id, target.Name) +
+			"| group_by [], mean(val())\n" +
+			"| within 5m\n",
 	}
 
 	for {

internal/pkg/resolved/resolved.go

@@ -3,15 +3,16 @@ package resolved
 import (
 	"context"
 	"fmt"
+	"strings"
+	"time"
+
 	"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/clients/generated/apis/sql/v1beta1"
 	"github.com/nais/cloudsql-migrator/internal/pkg/common_main"
 	"github.com/nais/cloudsql-migrator/internal/pkg/config"
 	"github.com/nais/liberator/pkg/apis/nais.io/v1alpha1"
 	"k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/errors"
 	meta_v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"strings"
-	"time"
 )
 
 // Resolved is configuration that is resolved by looking up in the cluster
@@ -44,6 +45,7 @@ type GcpProject struct {
 }
 
 func ResolveGcpProject(ctx context.Context, cfg *config.Config, mgr *common_main.Manager) (*GcpProject, error) {
+	mgr.Logger.Info("resolving google project id", "namespace", cfg.Namespace)
 	ns, err := mgr.K8sClient.CoreV1().Namespaces().Get(ctx, cfg.Namespace, meta_v1.GetOptions{})
 	if err != nil {
 		return nil, err
@@ -115,6 +117,8 @@ func ResolveInstance(ctx context.Context, app *nais_io_v1alpha1.Application, mgr
 		Name: name,
 	}
 
+	mgr.Logger.Info("resolving sql instance", "name", name)
+
 	var secret *v1.Secret
 	for {
 		secret, err = mgr.K8sClient.CoreV1().Secrets(app.Namespace).Get(ctx, "google-sql-"+app.Name, meta_v1.GetOptions{})