Merge pull request #141 from danmx/#132

aws: adding tracing, max retries for AWS api calls

CHANGELOG.md

@@ -1,6 +1,9 @@
 <a name="unreleased"></a>
 ## [Unreleased]
 
+### Aws
+- customizing default retryer for AWS api calls
+
 ### Chore
 - **deps:** bumping Go and tidying dependecies
 - **deps:** update module aws/aws-sdk-go to v1.34.2
@@ -15,6 +18,7 @@
 
 ### Fix
 - **bazel:** docker rules
+- **pre-commit:** adding Gazelle run during fmt phase
 
 
 <a name="0.5.3"></a>

cmd/list.go

@@ -81,6 +81,7 @@ Filter format examples:
 			listType := cfg.GetString("list-type")
 			instanceIDs := cfg.GetStringSlice("filters.instance.ids")
 			mfaToken := cfg.GetString("mfa")
+			trace := log.IsLevelEnabled(log.TraceLevel)
 			// hack to get map[string]string from args
 			// https://github.com/spf13/viper/issues/608
 			if cmd.Flags().Changed("session-filters") {
@@ -113,6 +114,7 @@ Filter format examples:
 				"instanceIDs":    instanceIDs,
 				"sessionFilters": sessionFilters,
 				"tags":           tags,
+				"trace":          trace,
 			}).Debug("List inputs")
 			input := &list.StartInput{
 				OutputFormat: &outputFormat,
@@ -122,6 +124,7 @@ Filter format examples:
 				Filters:      &filters,
 				Interactive:  &interactive,
 				Type:         &listType,
+				Trace:        &trace,
 			}
 			err := list.Start(input)
 			if err != nil {

cmd/session.go

@@ -36,19 +36,22 @@ var sessionCmd = &cobra.Command{
 		profile := cfg.GetString("profile")
 		region := cfg.GetString("region")
 		mfaToken := cfg.GetString("mfa")
+		trace := log.IsLevelEnabled(log.TraceLevel)
 		log.WithFields(log.Fields{
 			"target":  target,
 			"type":    targetType,
 			"region":  region,
 			"profile": profile,
 			"mfa":     mfaToken,
+			"trace":   trace,
 		}).Debug("Session inputs")
 		input := &session.StartInput{
 			Target:     &target,
 			TargetType: &targetType,
 			Region:     &region,
 			Profile:    &profile,
 			MFAToken:   &mfaToken,
+			Trace:      &trace,
 		}
 		// returns err
 		return session.Start(input)

cmd/ssh.go

@@ -52,6 +52,7 @@ var (
 			genKeyPair := cfg.GetBool("gen-key-pair")
 			genKeyDir := cfg.GetString("gen-key-dir")
 			mfaToken := cfg.GetString("mfa")
+			trace := log.IsLevelEnabled(log.TraceLevel)
 			if genKeyPair {
 				stat, err := os.Stat(genKeyDir)
 				if !(err == nil && stat.IsDir()) {
@@ -79,6 +80,7 @@ var (
 				"os-user":      OSUser,
 				"gen-key-pair": genKeyPair,
 				"gen-key-dir":  genKeyDir,
+				"trace":        trace,
 			}).Debug("ssh inputs")
 			input := &ssh.StartInput{
 				Target:     &target,
@@ -90,6 +92,7 @@ var (
 				Region:     &region,
 				Profile:    &profile,
 				MFAToken:   &mfaToken,
+				Trace:      &trace,
 			}
 			// returns err
 			return ssh.Start(input)

pkg/aws/BUILD.bazel

@@ -12,8 +12,10 @@ go_library(
     importpath = "github.com/danmx/sigil/pkg/aws",
     visibility = ["//visibility:public"],
     deps = [
+        "//pkg/aws/log:go_default_library",
         "//pkg/os:go_default_library",
         "@com_github_aws_aws_sdk_go//aws:go_default_library",
+        "@com_github_aws_aws_sdk_go//aws/client:go_default_library",
         "@com_github_aws_aws_sdk_go//aws/credentials/stscreds:go_default_library",
         "@com_github_aws_aws_sdk_go//aws/session:go_default_library",
         "@com_github_aws_aws_sdk_go//service/ec2:go_default_library",

pkg/aws/aws.go

@@ -7,18 +7,19 @@ import (
 	"os/exec"
 	"os/signal"
 	"syscall"
+	"time"
 
+	logger "github.com/danmx/sigil/pkg/aws/log"
 	sigilOS "github.com/danmx/sigil/pkg/os"
 
 	"github.com/aws/aws-sdk-go/aws"
+	"github.com/aws/aws-sdk-go/aws/client"
 	"github.com/aws/aws-sdk-go/aws/credentials/stscreds"
 	"github.com/aws/aws-sdk-go/aws/session"
 	"github.com/aws/aws-sdk-go/service/ec2"
 	log "github.com/sirupsen/logrus"
 )
 
-const execEnvVar = "AWS_EXECUTION_ENV"
-
 // Provider contains necessary components like the session
 type Provider struct {
 	filters    Filters
@@ -32,6 +33,7 @@ type Config struct {
 	Region   string
 	Profile  string
 	MFAToken string
+	Trace    bool
 }
 
 // Filters grouped per type
@@ -82,8 +84,15 @@ type SessionFilters struct {
 }
 
 const (
-	maxResults int64  = 50
-	pluginName string = "session-manager-plugin"
+	execEnvVar       = "AWS_EXECUTION_ENV"
+	maxResults int64 = 50
+	pluginName       = "session-manager-plugin"
+	// API calls retry configuration
+	numMaxRetries    = 10
+	minRetryDelay    = 1 * time.Second
+	minThrottleDelay = 2 * time.Second
+	maxRetryDelay    = client.DefaultRetryerMaxRetryDelay
+	maxThrottleDelay = client.DefaultRetryerMaxThrottleDelay
 	// TargetTypeInstanceID points to an instance ID type
 	TargetTypeInstanceID = "instance-id"
 	// TargetTypePrivateDNS points to a private DNS type
@@ -102,6 +111,17 @@ func (p *Provider) NewWithConfig(c *Config) error {
 		Profile:                 c.Profile,
 	}
 	awsConfig := aws.NewConfig()
+	if c.Trace {
+		awsConfig.LogLevel = aws.LogLevel(aws.LogDebugWithRequestRetries)
+		awsConfig.Logger = logger.NewTraceLogger()
+	}
+	awsConfig.Retryer = client.DefaultRetryer{
+		NumMaxRetries:    numMaxRetries,
+		MinRetryDelay:    minRetryDelay,
+		MinThrottleDelay: minThrottleDelay,
+		MaxRetryDelay:    maxRetryDelay,
+		MaxThrottleDelay: maxThrottleDelay,
+	}
 	awsConfig.Region = aws.String(c.Region)
 	options.Config = *awsConfig
 	sess, err := session.NewSessionWithOptions(options)

pkg/aws/log/BUILD.bazel

@@ -0,0 +1,12 @@
+load("@io_bazel_rules_go//go:def.bzl", "go_library")
+
+go_library(
+    name = "go_default_library",
+    srcs = ["log.go"],
+    importpath = "github.com/danmx/sigil/pkg/aws/log",
+    visibility = ["//visibility:public"],
+    deps = [
+        "@com_github_aws_aws_sdk_go//aws:go_default_library",
+        "@com_github_sirupsen_logrus//:go_default_library",
+    ],
+)

pkg/aws/log/log.go

@@ -0,0 +1,19 @@
+package aws
+
+import (
+	"github.com/aws/aws-sdk-go/aws"
+	log "github.com/sirupsen/logrus"
+)
+
+// A traceLogger provides a minimalistic logger satisfying the aws.Logger interface.
+type traceLogger struct{}
+
+// newTraceLogger returns a Logger which will write log messages to current logger
+func NewTraceLogger() aws.Logger {
+	return &traceLogger{}
+}
+
+// Log logs the parameters to the stdlib logger. See log.Println.
+func (l traceLogger) Log(args ...interface{}) {
+	log.Trace(args) //nolint:govet // AWS Logger to Logrus
+}

pkg/list/list.go

@@ -46,6 +46,7 @@ type StartInput struct {
 	Region       *string
 	Profile      *string
 	Filters      *aws.Filters
+	Trace        *bool
 }
 
 // Start will output a ist of all available EC2 instances
@@ -56,6 +57,7 @@ func Start(input *StartInput) error {
 		Region:   *input.Region,
 		Profile:  *input.Profile,
 		MFAToken: *input.MFAToken,
+		Trace:    *input.Trace,
 	})
 	if err != nil {
 		log.Error(err)

pkg/session/session.go

@@ -18,6 +18,7 @@ type StartInput struct {
 	MFAToken   *string
 	Region     *string
 	Profile    *string
+	Trace      *bool
 }
 
 // Start will start a session in chosen instance
@@ -30,6 +31,7 @@ func (input *StartInput) start(provider aws.CloudInstances) error {
 		Region:   *input.Region,
 		Profile:  *input.Profile,
 		MFAToken: *input.MFAToken,
+		Trace:    *input.Trace,
 	})
 	if err != nil {
 		log.Error("Failed to generate new provider")

pkg/session/session_test.go

@@ -21,10 +21,12 @@ func TestStart(t *testing.T) {
 	mfa := "123456"
 	region := "eu-west-1"
 	profile := "west"
+	trace := false
 	input := StartInput{
 		MFAToken: &mfa,
 		Region:   &region,
 		Profile:  &profile,
+		Trace:    &trace,
 	}
 	// Instance ID
 	target := "i-xxxxxxxxxxxxxxxx1"
@@ -36,6 +38,7 @@ func TestStart(t *testing.T) {
 			Region:   *input.Region,
 			Profile:  *input.Profile,
 			MFAToken: *input.MFAToken,
+			Trace:    *input.Trace,
 		})).Return(nil),
 		m.EXPECT().StartSession(gomock.Eq(*input.TargetType), gomock.Eq(*input.Target)).Return(nil),
 	)
@@ -48,6 +51,7 @@ func TestStart(t *testing.T) {
 			Region:   *input.Region,
 			Profile:  *input.Profile,
 			MFAToken: *input.MFAToken,
+			Trace:    *input.Trace,
 		})).Return(nil),
 		m.EXPECT().StartSession(gomock.Eq(*input.TargetType), gomock.Eq(*input.Target)).Return(nil),
 	)
@@ -60,6 +64,7 @@ func TestStart(t *testing.T) {
 			Region:   *input.Region,
 			Profile:  *input.Profile,
 			MFAToken: *input.MFAToken,
+			Trace:    *input.Trace,
 		})).Return(nil),
 		m.EXPECT().StartSession(gomock.Eq(*input.TargetType), gomock.Eq(*input.Target)).Return(nil),
 	)
@@ -71,6 +76,7 @@ func TestStart(t *testing.T) {
 			Region:   *input.Region,
 			Profile:  *input.Profile,
 			MFAToken: *input.MFAToken,
+			Trace:    *input.Trace,
 		})).Return(nil),
 		m.EXPECT().StartSession(gomock.Eq(*input.TargetType), gomock.Eq(*input.Target)).Return(nil),
 	)

pkg/ssh/ssh.go

@@ -31,6 +31,7 @@ type StartInput struct {
 	MFAToken   *string
 	Region     *string
 	Profile    *string
+	Trace      *bool
 }
 
 // Start will start ssh session
@@ -43,6 +44,7 @@ func (input *StartInput) start(provider aws.CloudSSH) error {
 		Region:   *input.Region,
 		Profile:  *input.Profile,
 		MFAToken: *input.MFAToken,
+		Trace:    *input.Trace,
 	})
 	if err != nil {
 		log.Error(err)

pkg/ssh/ssh_test.go

@@ -30,6 +30,7 @@ func TestStart(t *testing.T) {
 	pubKey := path.Join(os.TempDir(), "sigil_test.pub")
 	osUser := "ec2-user"
 	genKey := true
+	trace := false
 	input := StartInput{
 		MFAToken:   &mfa,
 		Region:     &region,
@@ -40,13 +41,15 @@ func TestStart(t *testing.T) {
 		PublicKey:  &pubKey,
 		OSUser:     &osUser,
 		GenKeyPair: &genKey,
+		Trace:      &trace,
 	}
 
 	gomock.InOrder(
 		m.EXPECT().NewWithConfig(gomock.Eq(&aws.Config{
 			Region:   *input.Region,
 			Profile:  *input.Profile,
 			MFAToken: *input.MFAToken,
+			Trace:    *input.Trace,
 		})).Return(nil),
 		m.EXPECT().StartSSH(
 			gomock.Eq(*input.TargetType),
@@ -72,13 +75,15 @@ func TestStart(t *testing.T) {
 		PublicKey:  &pubKey,
 		OSUser:     &osUser,
 		GenKeyPair: &genKey,
+		Trace:      &trace,
 	}
 
 	gomock.InOrder(
 		m.EXPECT().NewWithConfig(gomock.Eq(&aws.Config{
 			Region:   *input.Region,
 			Profile:  *input.Profile,
 			MFAToken: *input.MFAToken,
+			Trace:    *input.Trace,
 		})).Return(nil),
 		m.EXPECT().StartSSH(
 			gomock.Eq(*input.TargetType),
@@ -104,13 +109,15 @@ func TestStart(t *testing.T) {
 		PublicKey:  &pubKey,
 		OSUser:     &osUser,
 		GenKeyPair: &genKey,
+		Trace:      &trace,
 	}
 
 	gomock.InOrder(
 		m.EXPECT().NewWithConfig(gomock.Eq(&aws.Config{
 			Region:   *input.Region,
 			Profile:  *input.Profile,
 			MFAToken: *input.MFAToken,
+			Trace:    *input.Trace,
 		})).Return(nil),
 		m.EXPECT().StartSSH(
 			gomock.Eq(*input.TargetType),
@@ -135,13 +142,15 @@ func TestStart(t *testing.T) {
 		PublicKey:  &pubKey,
 		OSUser:     &osUser,
 		GenKeyPair: &genKey,
+		Trace:      &trace,
 	}
 
 	gomock.InOrder(
 		m.EXPECT().NewWithConfig(gomock.Eq(&aws.Config{
 			Region:   *input.Region,
 			Profile:  *input.Profile,
 			MFAToken: *input.MFAToken,
+			Trace:    *input.Trace,
 		})).Return(nil),
 		m.EXPECT().StartSSH(
 			gomock.Eq(*input.TargetType),

scripts/pre-commit.sh

@@ -7,7 +7,7 @@ test(){
 }
 
 fmt() {
-    bazelisk run :gofmt
+    bazelisk run :gazelle && bazelisk run :gofmt
 }
 
 lint() {