Merge pull request scaleway#84 from moul/feature-enhanced-logging

Refactored logging for 'scw run' (Fix scaleway#83)

Author: aimxhaisse

README.md

@@ -124,6 +124,7 @@ Options:
  --api-endpoint=APIEndPoint   Set the API endpoint
  -D, --debug=false            Enable debug mode
  -h, --help=false             Print usage
+ -V, --verbose=false          Enable verbose mode
  -v, --version=false          Print version information and quit
 
 Commands:
@@ -1039,6 +1040,7 @@ $ scw inspect myserver | jq '.[0].public_ip.address'
 
 #### Features
 
+* Support of `scw -V/--verbose` option ([#83](https://github.com/scaleway/scaleway-cli/issues/83))
 * Support of `scw inspect --browser` option
 * Support of `scw _flush-cache` internal command
 * `scw run --gateway ...` or `SCW_GATEWAY="..." scw run ...` now creates a server without public ip address ([#74](https://github.com/scaleway/scaleway-cli/issues/74))

api/helpers.go

@@ -139,7 +139,7 @@ func GetIdentifier(api *ScalewayAPI, needle string) *ScalewayResolverResult {
 	log.Errorf("Too many candidates for %s (%d)", needle, len(idents))
 	for _, identifier := range idents {
 		// FIXME: also print the name
-		log.Infof("- %s", identifier.Identifier)
+		fmt.Fprint(os.Stderr, "- %s\n", identifier.Identifier)
 	}
 	os.Exit(1)
 	return nil
@@ -380,8 +380,14 @@ func WaitForServerState(api *ScalewayAPI, serverID string, targetState string) (
 	var server *ScalewayServer
 	var err error
 
+	var currentState string
+
 	for {
 		server, err = api.GetServer(serverID)
+		if currentState != server.State {
+			log.Infof("Server changed state to '%s'", server.State)
+			currentState = server.State
+		}
 		if err != nil {
 			return nil, err
 		}

commands/run.go

@@ -7,7 +7,6 @@ package commands
 import (
 	"fmt"
 	"os"
-	"time"
 
 	log "github.com/scaleway/scaleway-cli/vendor/github.com/Sirupsen/logrus"
 
@@ -76,21 +75,21 @@ func runRun(cmd *types.Command, args []string) {
 	}
 
 	// create IMAGE
-	log.Debugf("Creating a new server")
+	log.Info("Server creation ...")
 	dynamicIPRequired := runGateway == ""
 	serverID, err := api.CreateServer(cmd.API, args[0], runCreateName, runCreateBootscript, runCreateEnv, runCreateVolume, dynamicIPRequired)
 	if err != nil {
 		log.Fatalf("Failed to create server: %v", err)
 	}
-	log.Debugf("Created server: %s", serverID)
+	log.Infof("Server created: %s", serverID)
 
 	// start SERVER
-	log.Debugf("Starting server")
+	log.Info("Server start requested ...")
 	err = api.StartServer(cmd.API, serverID, false)
 	if err != nil {
 		log.Fatalf("Failed to start server %s: %v", serverID, err)
 	}
-	log.Debugf("Server is booting")
+	log.Info("Server is starting, this may take up to a minute ...")
 
 	if runDetachFlag {
 		fmt.Println(serverID)
@@ -99,7 +98,7 @@ func runRun(cmd *types.Command, args []string) {
 
 	if runAttachFlag {
 		// Attach to server serial
-		log.Debugf("Attaching to server console")
+		log.Info("Attaching to server console ...")
 		err = utils.AttachToSerial(serverID, cmd.API.Token, true)
 		if err != nil {
 			log.Fatalf("Cannot attach to server serial: %v", err)
@@ -112,26 +111,27 @@ func runRun(cmd *types.Command, args []string) {
 		}
 
 		// waiting for server to be ready
-		log.Debugf("Waiting for server to be ready")
+		log.Debug("Waiting for server to be ready")
 		// We wait for 30 seconds, which is the minimal amount of time needed by a server to boot
-		time.Sleep(30 * time.Second)
 		server, err := api.WaitForServerReady(cmd.API, serverID, gateway)
 		if err != nil {
 			log.Fatalf("Cannot get access to server %s: %v", serverID, err)
 		}
-		log.Debugf("Server is ready: %s", server.PublicAddress.IP)
+		log.Debugf("SSH server is available: %s:22", server.PublicAddress.IP)
+		log.Info("Server is ready !")
 
 		// exec -w SERVER COMMAND ARGS...
-		log.Debugf("Executing command")
 		if len(args) < 2 {
+			log.Info("Connecting to server ...")
 			err = utils.SSHExec(server.PublicAddress.IP, server.PrivateIP, []string{}, false, gateway)
 		} else {
+			log.Infof("Executing command: %s ...", args[1:])
 			err = utils.SSHExec(server.PublicAddress.IP, server.PrivateIP, args[1:], false, gateway)
 		}
 		if err != nil {
-			log.Debugf("Command execution failed: %v", err)
+			log.Infof("Command execution failed: %v", err)
 			os.Exit(1)
 		}
-		log.Debugf("Command successfuly executed")
+		log.Info("Command successfuly executed")
 	}
 }

main.go

@@ -50,6 +50,7 @@ func commandUsage(name string) {
 var (
 	flAPIEndPoint *string
 	flDebug       = flag.Bool([]string{"D", "-debug"}, false, "Enable debug mode")
+	flVerbose     = flag.Bool([]string{"V", "-verbose"}, false, "Enable verbose mode")
 	flVersion     = flag.Bool([]string{"v", "-version"}, false, "Print version information and quit")
 	flSensitive   = flag.Bool([]string{"-sensitive"}, false, "Show sensitive data in outputs, i.e. API Token/Organization")
 )
@@ -82,7 +83,7 @@ func main() {
 		os.Setenv("DEBUG", "1")
 	}
 
-	initLogging(os.Getenv("DEBUG") != "")
+	initLogging(os.Getenv("DEBUG") != "", *flVerbose)
 
 	args := flag.Args()
 	if len(args) < 1 {
@@ -173,11 +174,13 @@ func showVersion() {
 	fmt.Printf("scw version %s, build %s\n", scwversion.VERSION, scwversion.GITCOMMIT)
 }
 
-func initLogging(debug bool) {
+func initLogging(debug bool, verbose bool) {
 	log.SetOutput(os.Stderr)
 	if debug {
 		log.SetLevel(log.DebugLevel)
-	} else {
+	} else if verbose {
 		log.SetLevel(log.InfoLevel)
+	} else {
+		log.SetLevel(log.WarnLevel)
 	}
 }