Merge pull request #120 from nettorta/monitoring_config

monitoring configuration, examples

Author: direvius

acceptance_tests/acceptance_suite_test.go

@@ -65,15 +65,37 @@ func NewTestConfig() *TestConfig {
 // PandoraConfig will be encoded to file via github.com/ghodss/yaml that supports json tags.
 // Or it can be encoded as JSON too, to test pandora JSON support.
 type PandoraConfig struct {
-	Pool      []*InstancePoolConfig `json:"pools"`
-	LogConfig `json:"log,omitempty"`
+	Pool             []*InstancePoolConfig `json:"pools"`
+	LogConfig        `json:"log,omitempty"`
+	MonitoringConfig `json:"monitoring,omitempty"`
 }
 
 type LogConfig struct {
 	Level string `json:"level,omitempty"`
 	File  string `json:"file,omitempty"`
 }
 
+type MonitoringConfig struct {
+	Expvar     *expvarConfig
+	CPUProfile *cpuprofileConfig
+	MemProfile *memprofileConfig
+}
+
+type expvarConfig struct {
+	Enabled bool `json:"enabled"`
+	Port    int  `json:"port"`
+}
+
+type cpuprofileConfig struct {
+	Enabled bool   `json:"enabled"`
+	File    string `json:"file"`
+}
+
+type memprofileConfig struct {
+	Enabled bool   `json:"enabled"`
+	File    string `json:"file"`
+}
+
 func (pc *PandoraConfig) Append(ipc *InstancePoolConfig) {
 	pc.Pool = append(pc.Pool, ipc)
 }

cli/cli.go

@@ -11,6 +11,7 @@ import (
 	"os/signal"
 	"runtime"
 	"runtime/pprof"
+	"strconv"
 	"strings"
 	"syscall"
 	"time"
@@ -32,9 +33,9 @@ var useStdinConfig = false
 var configSearchDirs = []string{"./", "./config", "/etc/pandora"}
 
 type cliConfig struct {
-	Engine engine.Config `config:",squash"`
-	Log    logConfig     `config:"log"`
-	// TODO(skipor): monitoring
+	Engine     engine.Config    `config:",squash"`
+	Log        logConfig        `config:"log"`
+	Monitoring monitoringConfig `config:"monitoring"`
 }
 
 type logConfig struct {
@@ -62,6 +63,20 @@ func defaultConfig() *cliConfig {
 			Level: zap.InfoLevel,
 			File:  "stdout",
 		},
+		Monitoring: monitoringConfig{
+			Expvar: &expvarConfig{
+				Enabled: false,
+				Port:    1234,
+			},
+			CPUProfile: &cpuprofileConfig{
+				Enabled: false,
+				File:    "cpuprofile.log",
+			},
+			MemProfile: &memprofileConfig{
+				Enabled: false,
+				File:    "memprofile.log",
+			},
+		},
 	}
 }
 
@@ -74,13 +89,9 @@ func Run() {
 		flag.PrintDefaults()
 	}
 	var (
-		example    bool
-		monitoring monitoringConfig
+		example bool
 	)
 	flag.BoolVar(&example, "example", false, "print example config to STDOUT and exit")
-	flag.StringVar(&monitoring.CPUProfile, "cpuprofile", "", "write cpu profile to file")
-	flag.StringVar(&monitoring.MemProfile, "memprofile", "", "write memory profile to this file")
-	flag.BoolVar(&monitoring.Expvar, "expvar", false, "start HTTP server with monitoring variables")
 	flag.Parse()
 
 	if example {
@@ -93,7 +104,7 @@ func Run() {
 	zap.ReplaceGlobals(log)
 	zap.RedirectStdLog(log)
 
-	closeMonitoring := startMonitoring(monitoring)
+	closeMonitoring := startMonitoring(conf.Monitoring)
 	defer closeMonitoring()
 	m := newEngineMetrics()
 	startReport(m)
@@ -214,22 +225,39 @@ func newViper() *viper.Viper {
 }
 
 type monitoringConfig struct {
-	Expvar     bool   // TODO: struct { Enabled bool; Port string }
-	CPUProfile string // TODO: struct { Enabled bool; File string }
-	MemProfile string // TODO: struct { Enabled bool; File string }
+	Expvar     *expvarConfig
+	CPUProfile *cpuprofileConfig
+	MemProfile *memprofileConfig
+}
+
+type expvarConfig struct {
+	Enabled bool `config:"enabled"`
+	Port    int  `config:"port" validate:"required"`
+}
+
+type cpuprofileConfig struct {
+	Enabled bool   `config:"enabled"`
+	File    string `config:"file"`
+}
+
+type memprofileConfig struct {
+	Enabled bool   `config:"enabled"`
+	File    string `config:"file"`
 }
 
 func startMonitoring(conf monitoringConfig) (stop func()) {
 	zap.L().Debug("Start monitoring", zap.Reflect("conf", conf))
-	if conf.Expvar {
-		go func() {
-			err := http.ListenAndServe(":1234", nil)
-			zap.L().Fatal("Monitoring server failed", zap.Error(err))
-		}()
+	if conf.Expvar != nil {
+		if conf.Expvar.Enabled {
+			go func() {
+				err := http.ListenAndServe(":"+strconv.Itoa(conf.Expvar.Port), nil)
+				zap.L().Fatal("Monitoring server failed", zap.Error(err))
+			}()
+		}
 	}
 	var stops []func()
-	if conf.CPUProfile != "" {
-		f, err := os.Create(conf.CPUProfile)
+	if conf.CPUProfile.Enabled {
+		f, err := os.Create(conf.CPUProfile.File)
 		if err != nil {
 			zap.L().Fatal("CPU profile file create fail", zap.Error(err))
 		}
@@ -240,8 +268,8 @@ func startMonitoring(conf monitoringConfig) (stop func()) {
 			f.Close()
 		})
 	}
-	if conf.MemProfile != "" {
-		f, err := os.Create(conf.MemProfile)
+	if conf.MemProfile.Enabled {
+		f, err := os.Create(conf.MemProfile.File)
 		if err != nil {
 			zap.L().Fatal("Memory profile file create fail", zap.Error(err))
 		}

docs/tutorial.rst

@@ -33,6 +33,26 @@ Pandora supports config files in `YAML`_ format. Create a new file named ``load.
         type: once                     # start 10 instances
         times: 10
 
+
+You can enable debug information about gun (e.g. monitoring and additional logging).
+
+.. code-block:: yaml
+
+  log:                                 # gun logging configuration
+    level: error                       # log only `error` messages (`debug` for verbose logging)
+
+  monitoring:
+    expvar:                            # gun statistics HTTP server
+      enabled: true
+      port: 1234
+    cpuprofile:                        # cpu profiling
+      enabled: true
+      file: "cpuprofile.log"
+    memprofile:                        # mem profiling
+      enabled: true
+      memprofile: "memprofile.log"
+
+
 `ammo.uri`:
 
 ::

examples/connect.yaml

@@ -19,3 +19,5 @@ pools:
     startup:
       type: once
       times: 5
+log:
+  level: debug

examples/debug_and_profiling.yaml

@@ -0,0 +1,31 @@
+pools:
+- id: HTTP pool
+  gun:
+    type: http
+    target: example.com:80
+    dial:
+      timeout: 1s
+  ammo:
+    type: http/json
+    file: ./examples/http.jsonline
+  result:
+    type: phout
+    destination: ./http_phout.log
+  rps:
+    type: line
+    from: 1
+    to: 5
+    duration: 2s
+  startup:
+    type: once
+    times: 5
+log:
+  level: debug
+monitoring:
+  expvar:
+    enabled: true
+    port: 1234
+  cpuprofile:
+    enabled: true
+  memprofile:
+    enabled: true

examples/example.yaml

@@ -15,4 +15,5 @@ pools:
     startup:
       type: once
       times: 5
-
+log:
+  level: debug

examples/http.yaml

@@ -19,4 +19,13 @@ pools:
     startup:
       type: once
       times: 5
-
+log:
+  level: debug
+monitoring:
+  expvar:
+    enabled: true
+    port: 1234
+  cpuprofile:
+    enabled: false
+  memprofile:
+    enabled: false