Rename ProfileMode to Mode

Author: cristaloleg

README.md

@@ -33,9 +33,9 @@ go get github.com/go-perf/easypprof
 ```go
 func main() {
 	cfg := easypprof.Config{
-		ProfileMode:          easypprof.CpuMode,
-		OutputDir:            path.Join(".", "test_pprof"),
-		FilePrefix:           "my-app",
+		Mode:       easypprof.CpuMode,
+		OutputDir:  path.Join(".", "test_pprof"),
+		FilePrefix: "my-app",
 	}
 	defer easypprof.Start(cfg).Stop()
 

easypprof.go

@@ -58,9 +58,9 @@ type Config struct {
 	// Default is false.
 	Disable bool
 
-	// ProfileMode is one of cpu, goroutine, threadcreate, heap, allocs, block, mutex.
+	// Mode is one of cpu, goroutine, threadcreate, heap, allocs, block, mutex.
 	// Default is empty string and is treated as cpu.
-	ProfileMode string
+	Mode string
 
 	// OutputDir where profile must be saved.
 	// Default is empty string and is treated as ".".
@@ -89,16 +89,16 @@ type Config struct {
 
 // newProfiler creates new profiler based on a config.
 func newProfiler(cfg Config) (*Profiler, error) {
-	if cfg.ProfileMode == "" {
-		cfg.ProfileMode = CpuMode
+	if cfg.Mode == "" {
+		cfg.Mode = CpuMode
 	}
 
-	switch cfg.ProfileMode {
+	switch cfg.Mode {
 	case CpuMode, TraceMode, HeapMode, AllocsMode, MutexMode,
 		BlockMode, ThreadCreateMode, GoroutineMode, FgprofMode:
 		// pass
 	default:
-		return nil, fmt.Errorf("unknown profile mode: %s", cfg.ProfileMode)
+		return nil, fmt.Errorf("unknown profile mode: %s", cfg.Mode)
 	}
 
 	if cfg.OutputDir == "" {
@@ -119,7 +119,7 @@ func newProfiler(cfg Config) (*Profiler, error) {
 		prefix = cfg.FilePrefix + "_"
 	}
 	now := time.Now().Format("20060102-15:04:05")
-	filename := fmt.Sprintf("%s%s_%s.pprof", prefix, cfg.ProfileMode, now)
+	filename := fmt.Sprintf("%s%s_%s.pprof", prefix, cfg.Mode, now)
 
 	if err := os.MkdirAll(cfg.OutputDir, 0777); err != nil {
 		return nil, err
@@ -131,7 +131,7 @@ func newProfiler(cfg Config) (*Profiler, error) {
 
 	p := &Profiler{
 		cfg:    cfg,
-		mode:   cfg.ProfileMode,
+		mode:   cfg.Mode,
 		output: output,
 	}
 	return p, nil

example_test.go

@@ -12,7 +12,7 @@ import (
 func ExampleEasyPprof() {
 	cfg := easypprof.Config{
 		Disable:              os.Getenv("NO_EASY_PPROF") == "true",
-		ProfileMode:          easypprof.CpuMode,
+		Mode:                 easypprof.CpuMode,
 		OutputDir:            path.Join(".", "test_pprof"),
 		FilePrefix:           "my-app",
 		UseTextFormat:        false,
@@ -26,7 +26,7 @@ func ExampleEasyPprof() {
 }
 
 func ExampleMinimalVersion() {
-	// ProfileMode by default is easypprof.CpuMode
+	// Mode by default is easypprof.CpuMode
 	defer easypprof.Start(easypprof.Config{}).Stop()
 
 	// Output:
@@ -50,10 +50,10 @@ func ExampleWithEnv() {
 	mode := os.Getenv("EASY_PPROF_MODE")
 
 	defer easypprof.Start(easypprof.Config{
-		Disable:     disable,
-		ProfileMode: mode,
-		OutputDir:   path.Join(".", "test_pprof"),
-		FilePrefix:  "env",
+		Disable:    disable,
+		Mode:       mode,
+		OutputDir:  path.Join(".", "test_pprof"),
+		FilePrefix: "env",
 	}).Stop()
 
 	// Output:
@@ -65,10 +65,10 @@ func ExampleWithFlags() {
 	flag.Parse()
 
 	defer easypprof.Start(easypprof.Config{
-		Disable:     *disable,
-		ProfileMode: *mode,
-		OutputDir:   path.Join(".", "test_pprof"),
-		FilePrefix:  "flag",
+		Disable:    *disable,
+		Mode:       *mode,
+		OutputDir:  path.Join(".", "test_pprof"),
+		FilePrefix: "flag",
 	}).Stop()
 
 	// Output: