Merge pull request #20 from Spellchaser/glogify

Glog-ify logging

README.md

@@ -94,6 +94,10 @@ in other namespaces (eg. `kube-system`).
 
 See dir [`examples/`](https://github.com/asobti/kube-monkey/tree/master/examples) for example Kubernetes yaml files.
 
+## Logging
+
+kube-monkey uses glog and supports all command-line features for glog. To specify a custom v level or a custom log directory on the pod, see  `args: ["-v=5", "-log_dir=/path/to/custom/log"]` in the [example deployment file](https://github.com/asobti/kube-monkey/tree/master/examples/deployment.yaml)
+
 ## Compatibility with Kubernetes
 
 kube-monkey is built using v1.5 of [kubernetes/client-go](https://github.com/kubernetes/client-go). Refer to the 

calendar/calendar.go

@@ -1,9 +1,10 @@
 package calendar
 
 import (
-	"fmt"
-	"math/rand"
 	"time"
+	"math/rand"
+
+	"github.com/golang/glog"
 )
 
 // Checks if specified Time is a weekday
@@ -15,7 +16,9 @@ func isWeekday(t time.Time) bool {
 		return false
 	}
 
-	panic(fmt.Sprintf("Unrecognized day of the week: %s", t.Weekday().String()))
+	glog.Fatalf("Unrecognized day of the week: %s", t.Weekday().String())
+
+	panic("Explicit Panic to avoid compiler error: missing return at end of function")
 }
 
 // Returns the next weekday in Location

chaos/chaos.go

@@ -2,13 +2,17 @@ package chaos
 
 import (
 	"fmt"
+	"time"
+	"math/rand"
+
+	"github.com/golang/glog"
+
 	"github.com/asobti/kube-monkey/config"
 	"github.com/asobti/kube-monkey/deployments"
 	"github.com/asobti/kube-monkey/kubernetes"
+
 	kube "k8s.io/client-go/1.5/kubernetes"
 	"k8s.io/client-go/1.5/pkg/api/v1"
-	"math/rand"
-	"time"
 )
 
 type Chaos struct {
@@ -75,8 +79,7 @@ func (c *Chaos) Execute(resultchan chan<- *ChaosResult) {
 	// Do the termination
 	killAll, err := c.deployment.HasKillAll(client)
 	if err != nil {
-		fmt.Printf("Failed to check KillAll label for deployment %s. Proceeding with termination of a single pod.\n", c.deployment.Name())
-		fmt.Printf(err.Error())
+		glog.Errorf("Failed to check KillAll label for deployment %s. Proceeding with termination of a single pod. Error: %v", c.deployment.Name(), err.Error())
 	}
 
 	if killAll {
@@ -107,14 +110,14 @@ func (c *Chaos) Terminate(client *kube.Clientset) error {
 
 	targetPod := RandomPodName(pods)
 
-	fmt.Printf("Terminating pod %s for deployment %s\n", targetPod, c.deployment.Name())
+	glog.Errorf("Terminating pod %s for deployment %s\n", targetPod, c.deployment.Name())
 	return c.DeletePod(client, targetPod)
 }
 
 // Terminates ALL pods for the deployment
 // Not the default, or recommended, behavior
 func (c *Chaos) TerminateAll(client *kube.Clientset) error {
-	fmt.Printf("Terminating ALL pods for deployment %s\n", c.deployment.Name())
+	glog.V(1).Infof("Terminating ALL pods for deployment %s\n", c.deployment.Name())
 
 	pods, err := c.deployment.Pods(client)
 	if err != nil {
@@ -128,7 +131,7 @@ func (c *Chaos) TerminateAll(client *kube.Clientset) error {
 	for _, pod := range pods {
 		// In case of error, log it and move on to next pod
 		if err = c.DeletePod(client, pod.Name); err != nil {
-			fmt.Printf("Failed to delete pod %s for deployment %s", pod.Name, c.deployment.Name())
+			glog.Errorf("Failed to delete pod %s for deployment %s", pod.Name, c.deployment.Name())
 		}
 	}
 
@@ -138,7 +141,7 @@ func (c *Chaos) TerminateAll(client *kube.Clientset) error {
 // Deletes a pod for a deployment
 func (c *Chaos) DeletePod(client *kube.Clientset, podName string) error {
 	if config.DryRun() {
-		fmt.Printf("[DryRun Mode] Terminated pod %s for deployment %s\n", podName, c.deployment.Name())
+		glog.V(1).Infof("[DryRun Mode] Terminated pod %s for deployment %s\n", podName, c.deployment.Name())
 		return nil
 	} else {
 		return c.deployment.DeletePod(client, podName)
@@ -157,13 +160,13 @@ func (c *Chaos) NewResult(e error) *ChaosResult {
 func CreateClient() (*kube.Clientset, error) {
 	client, err := kubernetes.NewInClusterClient()
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("Failed to generate NewInClusterClient: %v", err)
 	}
 
 	if kubernetes.VerifyClient(client) {
 		return client, nil
 	} else {
-		return nil, fmt.Errorf("Unable to verify Kubernetes client")
+		return nil, fmt.Errorf("Unable to verify client connectivity to Kubernetes apiserver")
 	}
 }
 

config/config.go

@@ -1,12 +1,15 @@
 package config
 
 import (
-	"fmt"
-	"github.com/asobti/kube-monkey/config/param"
-	"github.com/fsnotify/fsnotify"
+	"time"
+
+	"github.com/golang/glog"
 	"github.com/spf13/viper"
+	"github.com/fsnotify/fsnotify"
+
+	"github.com/asobti/kube-monkey/config/param"
+
 	"k8s.io/client-go/1.5/pkg/util/sets"
-	"time"
 )
 
 const (
@@ -46,7 +49,7 @@ func setupWatch() {
 	// TODO: This does not appear to be working
 	viper.WatchConfig()
 	viper.OnConfigChange(func(e fsnotify.Event) {
-		fmt.Println("Config change detected")
+		glog.V(2).Infoln("Config change detected")
 		ValidateConfigs()
 	})
 }
@@ -61,7 +64,12 @@ func Init() error {
 		return err
 	}
 
-	ValidateConfigs()
+	if err := ValidateConfigs(); err != nil {
+		glog.Errorf("Failed to validate %v", err)
+		return err
+	} else {
+		glog.V(3).Info("Successfully validated configs")
+	}
 	setupWatch()
 	return nil
 }
@@ -74,7 +82,7 @@ func Timezone() *time.Location {
 	tz := viper.GetString(param.Timezone)
 	location, err := time.LoadLocation(tz)
 	if err != nil {
-		panic(err.Error())
+		glog.Fatal(err.Error())
 	}
 	return location
 }

config/validations.go

@@ -2,37 +2,37 @@ package config
 
 import (
 	"fmt"
+
 	"github.com/asobti/kube-monkey/config/param"
 )
 
 func ValidateConfigs() error {
 	// RunHour should be [0, 23]
 	runHour := RunHour()
-
 	if !IsValidHour(runHour) {
-		return fmt.Errorf("%s is outside valid range of [0,23]", param.RunHour)
+		return fmt.Errorf("RunHour: %s is outside valid range of [0,23]", param.RunHour)
 	}
 
 	// StartHour should be [0, 23]
 	startHour := StartHour()
 	if !IsValidHour(startHour) {
-		return fmt.Errorf("%s is outside valid range of [0,23]", param.StartHour)
+		return fmt.Errorf("StartHour: %s is outside valid range of [0,23]", param.StartHour)
 	}
 
 	// EndHour should be [0, 23]
 	endHour := EndHour()
 	if !IsValidHour(endHour) {
-		return fmt.Errorf("%s is outside valid range of [0,23]", param.EndHour)
+		return fmt.Errorf("EndHour: %s is outside valid range of [0,23]", param.EndHour)
 	}
 
 	// StartHour should be < EndHour
 	if !(startHour < endHour) {
-		return fmt.Errorf("%s must be less than %s", param.StartHour, param.EndHour)
+		return fmt.Errorf("StartHour: %s must be less than %s", param.StartHour, param.EndHour)
 	}
 
 	// RunHour should be < StartHour
 	if !(runHour < startHour) {
-		return fmt.Errorf("%s should be less than %s", param.RunHour, param.StartHour)
+		return fmt.Errorf("RunHour: %s should be less than %s", param.RunHour, param.StartHour)
 	}
 
 	return nil

deployments/deployments.go

@@ -2,15 +2,17 @@ package deployments
 
 import (
 	"fmt"
+	"strconv"
+
 	"github.com/asobti/kube-monkey/config"
+
 	kube "k8s.io/client-go/1.5/kubernetes"
 	"k8s.io/client-go/1.5/pkg/api"
 	"k8s.io/client-go/1.5/pkg/api/v1"
 	"k8s.io/client-go/1.5/pkg/apis/extensions/v1beta1"
 	"k8s.io/client-go/1.5/pkg/labels"
 	"k8s.io/client-go/1.5/pkg/selection"
 	"k8s.io/client-go/1.5/pkg/util/sets"
-	"strconv"
 )
 
 type Deployment struct {

deployments/eligible_deployments.go

@@ -1,9 +1,11 @@
 package deployments
 
 import (
-	"fmt"
+	"github.com/golang/glog"
+
 	"github.com/asobti/kube-monkey/config"
 	"github.com/asobti/kube-monkey/kubernetes"
+
 	"k8s.io/client-go/1.5/pkg/api"
 	"k8s.io/client-go/1.5/pkg/apis/extensions/v1beta1"
 	"k8s.io/client-go/1.5/pkg/labels"
@@ -23,7 +25,7 @@ func EligibleDeployments() ([]*Deployment, error) {
 	for _, dep := range enabledDeployments {
 		deployment, err := New(&dep)
 		if err != nil {
-			fmt.Printf("Skipping eligible deployment %s because of error:\n%s\n", dep.Name, err.Error())
+			glog.V(3).Infof("Skipping eligible deployment %s because of error:\n%s\n", dep.Name, err.Error())
 			continue
 		}
 

examples/deployment.yaml

@@ -15,6 +15,7 @@
           -  name: kube-monkey
              command:
                - "/kube-monkey"
+             args: ["-v=5", "-log_dir=/var/log/kube-monkey"]
              image: kube-monkey:v0.1.0
              volumeMounts:
                - name: config-volume

kubemonkey/kubemonkey.go

@@ -1,35 +1,29 @@
 package kubemonkey
 
 import (
-	"fmt"
-	"github.com/asobti/kube-monkey/calendar"
+	"time"
+
+	"github.com/golang/glog"
+
 	"github.com/asobti/kube-monkey/chaos"
 	"github.com/asobti/kube-monkey/config"
-	"github.com/asobti/kube-monkey/kubernetes"
+	"github.com/asobti/kube-monkey/calendar"
 	"github.com/asobti/kube-monkey/schedule"
-	"time"
 )
 
 func verifyKubeClient() error {
-	client, err := kubernetes.NewInClusterClient()
-	if err != nil {
-		return err
-	}
-	if !kubernetes.VerifyClient(client) {
-		fmt.Println(err)
-		return fmt.Errorf("Unable to verify client connectivity to Kubernetes server")
-	}
-	return nil
+	_, err := chaos.CreateClient()
+	return err
 }
 
 func durationToNextRun(runhour int, location *time.Location) time.Duration {
 	if config.DebugEnabled() {
 		debugDelayDuration := config.DebugScheduleDelay()
-		fmt.Printf("Debug mode detected. Next run scheduled in %.0f sec\n", debugDelayDuration.Seconds())
+		glog.V(2).Infof("Debug mode detected! Generating next schedule in %.0f sec\n", debugDelayDuration.Seconds())
 		return debugDelayDuration
 	} else {
 		nextRun := calendar.NextRuntime(location, runhour)
-		fmt.Printf("Next run scheduled at %s\n", nextRun)
+		glog.V(2).Infof("Generating next schedule at %s\n", nextRun)
 		return nextRun.Sub(time.Now())
 	}
 }
@@ -48,7 +42,7 @@ func Run() error {
 
 		schedule, err := schedule.New()
 		if err != nil {
-			panic(err.Error())
+			glog.Fatal(err.Error())
 		}
 		schedule.Print()
 		ScheduleTerminations(schedule.Entries())
@@ -67,19 +61,18 @@ func ScheduleTerminations(entries []*chaos.Chaos) {
 	completedCount := 0
 	var result *chaos.ChaosResult
 
-	fmt.Println("Waiting for terminations to run")
+	glog.V(3).Infof("Waiting for terminations to run")
 
 	// Gather results
 	for completedCount < len(entries) {
 		result = <-resultchan
 		if result.Error() != nil {
-			fmt.Printf("Failed to execute termination for deployment %s. Error:\n", result.Deployment().Name())
-			fmt.Println(result.Error().Error())
+			glog.Errorf("Failed to execute termination for deployment %s. Error: %v", result.Deployment().Name(), result.Error().Error())
 		} else {
-			fmt.Printf("Termination successfully executed for deployment %s\n", result.Deployment().Name())
+			glog.V(2).Infof("Termination successfully executed for deployment %s\n", result.Deployment().Name())
 		}
 		completedCount++
 	}
 
-	fmt.Println("All terminations done")
+	glog.V(3).Info("All terminations done")
 }

kubernetes/kubernetes.go

@@ -1,27 +1,29 @@
 package kubernetes
 
 import (
+	"github.com/golang/glog"
+
 	cfg "github.com/asobti/kube-monkey/config"
+
 	kube "k8s.io/client-go/1.5/kubernetes"
 	"k8s.io/client-go/1.5/rest"
-	"fmt"
 )
 
 func NewInClusterClient() (*kube.Clientset, error) {
 	config, err := rest.InClusterConfig()
 	if err != nil {
-		fmt.Println(err)
+		glog.Errorf("failed to obtain config from InClusterConfig: %v", err)
 		return nil, err
 	}
 
 	if apiserverHost, override := cfg.ClusterAPIServerHost(); override {
-		fmt.Printf("API server host overriden to: %s\n", apiserverHost)
+		glog.V(1).Infof("API server host overriden to: %s\n", apiserverHost)
 		config.Host = apiserverHost
 	}
 
 	clientset, err := kube.NewForConfig(config)
 	if err != nil {
-		fmt.Println(err)
+		glog.Errorf("failed to create clientset in NewForConfig: %v", err)
 		return nil, err
 	}
 	return clientset, nil