github.com/xfond/eth-implementation@v1.8.9-0.20180514135602-f6bc65fc6811/internal/debug/flags.go (about) 1 // Copyright 2016 The go-ethereum Authors 2 // This file is part of the go-ethereum library. 3 // 4 // The go-ethereum library is free software: you can redistribute it and/or modify 5 // it under the terms of the GNU Lesser General Public License as published by 6 // the Free Software Foundation, either version 3 of the License, or 7 // (at your option) any later version. 8 // 9 // The go-ethereum library is distributed in the hope that it will be useful, 10 // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 // GNU Lesser General Public License for more details. 13 // 14 // You should have received a copy of the GNU Lesser General Public License 15 // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>. 16 17 package debug 18 19 import ( 20 "fmt" 21 "io" 22 "net/http" 23 _ "net/http/pprof" 24 "os" 25 "runtime" 26 27 "github.com/ethereum/go-ethereum/log" 28 "github.com/ethereum/go-ethereum/log/term" 29 "github.com/ethereum/go-ethereum/metrics" 30 "github.com/ethereum/go-ethereum/metrics/exp" 31 "github.com/fjl/memsize/memsizeui" 32 colorable "github.com/mattn/go-colorable" 33 "gopkg.in/urfave/cli.v1" 34 ) 35 36 var Memsize memsizeui.Handler 37 38 var ( 39 verbosityFlag = cli.IntFlag{ 40 Name: "verbosity", 41 Usage: "Logging verbosity: 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=detail", 42 Value: 3, 43 } 44 vmoduleFlag = cli.StringFlag{ 45 Name: "vmodule", 46 Usage: "Per-module verbosity: comma-separated list of <pattern>=<level> (e.g. eth/*=5,p2p=4)", 47 Value: "", 48 } 49 backtraceAtFlag = cli.StringFlag{ 50 Name: "backtrace", 51 Usage: "Request a stack trace at a specific logging statement (e.g. \"block.go:271\")", 52 Value: "", 53 } 54 debugFlag = cli.BoolFlag{ 55 Name: "debug", 56 Usage: "Prepends log messages with call-site location (file and line number)", 57 } 58 pprofFlag = cli.BoolFlag{ 59 Name: "pprof", 60 Usage: "Enable the pprof HTTP server", 61 } 62 pprofPortFlag = cli.IntFlag{ 63 Name: "pprofport", 64 Usage: "pprof HTTP server listening port", 65 Value: 6060, 66 } 67 pprofAddrFlag = cli.StringFlag{ 68 Name: "pprofaddr", 69 Usage: "pprof HTTP server listening interface", 70 Value: "127.0.0.1", 71 } 72 memprofilerateFlag = cli.IntFlag{ 73 Name: "memprofilerate", 74 Usage: "Turn on memory profiling with the given rate", 75 Value: runtime.MemProfileRate, 76 } 77 blockprofilerateFlag = cli.IntFlag{ 78 Name: "blockprofilerate", 79 Usage: "Turn on block profiling with the given rate", 80 } 81 cpuprofileFlag = cli.StringFlag{ 82 Name: "cpuprofile", 83 Usage: "Write CPU profile to the given file", 84 } 85 traceFlag = cli.StringFlag{ 86 Name: "trace", 87 Usage: "Write execution trace to the given file", 88 } 89 ) 90 91 // Flags holds all command-line flags required for debugging. 92 var Flags = []cli.Flag{ 93 verbosityFlag, vmoduleFlag, backtraceAtFlag, debugFlag, 94 pprofFlag, pprofAddrFlag, pprofPortFlag, 95 memprofilerateFlag, blockprofilerateFlag, cpuprofileFlag, traceFlag, 96 } 97 98 var glogger *log.GlogHandler 99 100 func init() { 101 usecolor := term.IsTty(os.Stderr.Fd()) && os.Getenv("TERM") != "dumb" 102 output := io.Writer(os.Stderr) 103 if usecolor { 104 output = colorable.NewColorableStderr() 105 } 106 glogger = log.NewGlogHandler(log.StreamHandler(output, log.TerminalFormat(usecolor))) 107 } 108 109 // Setup initializes profiling and logging based on the CLI flags. 110 // It should be called as early as possible in the program. 111 func Setup(ctx *cli.Context) error { 112 // logging 113 log.PrintOrigins(ctx.GlobalBool(debugFlag.Name)) 114 glogger.Verbosity(log.Lvl(ctx.GlobalInt(verbosityFlag.Name))) 115 glogger.Vmodule(ctx.GlobalString(vmoduleFlag.Name)) 116 glogger.BacktraceAt(ctx.GlobalString(backtraceAtFlag.Name)) 117 log.Root().SetHandler(glogger) 118 119 // profiling, tracing 120 runtime.MemProfileRate = ctx.GlobalInt(memprofilerateFlag.Name) 121 Handler.SetBlockProfileRate(ctx.GlobalInt(blockprofilerateFlag.Name)) 122 if traceFile := ctx.GlobalString(traceFlag.Name); traceFile != "" { 123 if err := Handler.StartGoTrace(traceFile); err != nil { 124 return err 125 } 126 } 127 if cpuFile := ctx.GlobalString(cpuprofileFlag.Name); cpuFile != "" { 128 if err := Handler.StartCPUProfile(cpuFile); err != nil { 129 return err 130 } 131 } 132 133 // pprof server 134 if ctx.GlobalBool(pprofFlag.Name) { 135 address := fmt.Sprintf("%s:%d", ctx.GlobalString(pprofAddrFlag.Name), ctx.GlobalInt(pprofPortFlag.Name)) 136 StartPProf(address) 137 } 138 return nil 139 } 140 141 func StartPProf(address string) { 142 // Hook go-metrics into expvar on any /debug/metrics request, load all vars 143 // from the registry into expvar, and execute regular expvar handler. 144 exp.Exp(metrics.DefaultRegistry) 145 http.Handle("/memsize/", http.StripPrefix("/memsize", &Memsize)) 146 log.Info("Starting pprof server", "addr", fmt.Sprintf("http://%s/debug/pprof", address)) 147 go func() { 148 if err := http.ListenAndServe(address, nil); err != nil { 149 log.Error("Failure in running pprof server", "err", err) 150 } 151 }() 152 } 153 154 // Exit stops all running profiles, flushing their output to the 155 // respective file. 156 func Exit() { 157 Handler.StopCPUProfile() 158 Handler.StopGoTrace() 159 }