aboutsummaryrefslogtreecommitdiff
path: root/internal/debug
diff options
context:
space:
mode:
authorTed Yin <[email protected]>2020-09-18 13:14:29 -0400
committerGitHub <[email protected]>2020-09-18 13:14:29 -0400
commitd048937c48753d9eaef771bf71820cf95d79df26 (patch)
tree1a7f65fcd72e77092525ab01625b8b9d365e3e40 /internal/debug
parent7d1388c743b4ec8f4a86bea95bfada785dee83f7 (diff)
parent7d8c85cf8895b0f998d8eafb02f99d5b689fcd59 (diff)
Merge pull request #34 from ava-labs/devv0.3.0-rc.5
Dev
Diffstat (limited to 'internal/debug')
-rw-r--r--internal/debug/api.go2
-rw-r--r--internal/debug/flags.go103
-rw-r--r--internal/debug/trace.go2
3 files changed, 79 insertions, 28 deletions
diff --git a/internal/debug/api.go b/internal/debug/api.go
index 7fba1ee..86a4218 100644
--- a/internal/debug/api.go
+++ b/internal/debug/api.go
@@ -34,7 +34,7 @@ import (
"sync"
"time"
- "github.com/ava-labs/go-ethereum/log"
+ "github.com/ethereum/go-ethereum/log"
)
// Handler is the global debugging handler.
diff --git a/internal/debug/flags.go b/internal/debug/flags.go
index 3247ace..3b077b6 100644
--- a/internal/debug/flags.go
+++ b/internal/debug/flags.go
@@ -24,9 +24,9 @@ import (
"os"
"runtime"
- "github.com/ava-labs/go-ethereum/log"
- "github.com/ava-labs/go-ethereum/metrics"
- "github.com/ava-labs/go-ethereum/metrics/exp"
+ "github.com/ethereum/go-ethereum/log"
+ "github.com/ethereum/go-ethereum/metrics"
+ "github.com/ethereum/go-ethereum/metrics/exp"
"github.com/fjl/memsize/memsizeui"
colorable "github.com/mattn/go-colorable"
"github.com/mattn/go-isatty"
@@ -60,39 +60,68 @@ var (
Usage: "Enable the pprof HTTP server",
}
pprofPortFlag = cli.IntFlag{
- Name: "pprofport",
+ Name: "pprof.port",
Usage: "pprof HTTP server listening port",
Value: 6060,
}
pprofAddrFlag = cli.StringFlag{
- Name: "pprofaddr",
+ Name: "pprof.addr",
Usage: "pprof HTTP server listening interface",
Value: "127.0.0.1",
}
memprofilerateFlag = cli.IntFlag{
- Name: "memprofilerate",
+ Name: "pprof.memprofilerate",
Usage: "Turn on memory profiling with the given rate",
Value: runtime.MemProfileRate,
}
blockprofilerateFlag = cli.IntFlag{
- Name: "blockprofilerate",
+ Name: "pprof.blockprofilerate",
Usage: "Turn on block profiling with the given rate",
}
cpuprofileFlag = cli.StringFlag{
- Name: "cpuprofile",
+ Name: "pprof.cpuprofile",
Usage: "Write CPU profile to the given file",
}
traceFlag = cli.StringFlag{
Name: "trace",
Usage: "Write execution trace to the given file",
}
+ // (Deprecated April 2020)
+ legacyPprofPortFlag = cli.IntFlag{
+ Name: "pprofport",
+ Usage: "pprof HTTP server listening port (deprecated, use --pprof.port)",
+ Value: 6060,
+ }
+ legacyPprofAddrFlag = cli.StringFlag{
+ Name: "pprofaddr",
+ Usage: "pprof HTTP server listening interface (deprecated, use --pprof.addr)",
+ Value: "127.0.0.1",
+ }
+ legacyMemprofilerateFlag = cli.IntFlag{
+ Name: "memprofilerate",
+ Usage: "Turn on memory profiling with the given rate (deprecated, use --pprof.memprofilerate)",
+ Value: runtime.MemProfileRate,
+ }
+ legacyBlockprofilerateFlag = cli.IntFlag{
+ Name: "blockprofilerate",
+ Usage: "Turn on block profiling with the given rate (deprecated, use --pprof.blockprofilerate)",
+ }
+ legacyCpuprofileFlag = cli.StringFlag{
+ Name: "cpuprofile",
+ Usage: "Write CPU profile to the given file (deprecated, use --pprof.cpuprofile)",
+ }
)
// Flags holds all command-line flags required for debugging.
var Flags = []cli.Flag{
verbosityFlag, vmoduleFlag, backtraceAtFlag, debugFlag,
- pprofFlag, pprofAddrFlag, pprofPortFlag,
- memprofilerateFlag, blockprofilerateFlag, cpuprofileFlag, traceFlag,
+ pprofFlag, pprofAddrFlag, pprofPortFlag, memprofilerateFlag,
+ blockprofilerateFlag, cpuprofileFlag, traceFlag,
+}
+
+var DeprecatedFlags = []cli.Flag{
+ legacyPprofPortFlag, legacyPprofAddrFlag, legacyMemprofilerateFlag,
+ legacyBlockprofilerateFlag, legacyCpuprofileFlag,
}
var (
@@ -112,51 +141,73 @@ func init() {
// Setup initializes profiling and logging based on the CLI flags.
// It should be called as early as possible in the program.
-func Setup(ctx *cli.Context, logdir string) error {
+func Setup(ctx *cli.Context) error {
// logging
log.PrintOrigins(ctx.GlobalBool(debugFlag.Name))
- if logdir != "" {
- rfh, err := log.RotatingFileHandler(
- logdir,
- 262144,
- log.JSONFormatOrderedEx(false, true),
- )
- if err != nil {
- return err
- }
- glogger.SetHandler(log.MultiHandler(ostream, rfh))
- }
glogger.Verbosity(log.Lvl(ctx.GlobalInt(verbosityFlag.Name)))
glogger.Vmodule(ctx.GlobalString(vmoduleFlag.Name))
glogger.BacktraceAt(ctx.GlobalString(backtraceAtFlag.Name))
log.Root().SetHandler(glogger)
// profiling, tracing
+ if ctx.GlobalIsSet(legacyMemprofilerateFlag.Name) {
+ runtime.MemProfileRate = ctx.GlobalInt(legacyMemprofilerateFlag.Name)
+ log.Warn("The flag --memprofilerate is deprecated and will be removed in the future, please use --pprof.memprofilerate")
+ }
runtime.MemProfileRate = ctx.GlobalInt(memprofilerateFlag.Name)
+
+ if ctx.GlobalIsSet(legacyBlockprofilerateFlag.Name) {
+ Handler.SetBlockProfileRate(ctx.GlobalInt(legacyBlockprofilerateFlag.Name))
+ log.Warn("The flag --blockprofilerate is deprecated and will be removed in the future, please use --pprof.blockprofilerate")
+ }
Handler.SetBlockProfileRate(ctx.GlobalInt(blockprofilerateFlag.Name))
+
if traceFile := ctx.GlobalString(traceFlag.Name); traceFile != "" {
if err := Handler.StartGoTrace(traceFile); err != nil {
return err
}
}
+
if cpuFile := ctx.GlobalString(cpuprofileFlag.Name); cpuFile != "" {
if err := Handler.StartCPUProfile(cpuFile); err != nil {
return err
}
}
+ if cpuFile := ctx.GlobalString(legacyCpuprofileFlag.Name); cpuFile != "" {
+ log.Warn("The flag --cpuprofile is deprecated and will be removed in the future, please use --pprof.cpuprofile")
+ if err := Handler.StartCPUProfile(cpuFile); err != nil {
+ return err
+ }
+ }
// pprof server
if ctx.GlobalBool(pprofFlag.Name) {
- address := fmt.Sprintf("%s:%d", ctx.GlobalString(pprofAddrFlag.Name), ctx.GlobalInt(pprofPortFlag.Name))
- StartPProf(address)
+ listenHost := ctx.GlobalString(pprofAddrFlag.Name)
+ if ctx.GlobalIsSet(legacyPprofAddrFlag.Name) && !ctx.GlobalIsSet(pprofAddrFlag.Name) {
+ listenHost = ctx.GlobalString(legacyPprofAddrFlag.Name)
+ log.Warn("The flag --pprofaddr is deprecated and will be removed in the future, please use --pprof.addr")
+ }
+
+ port := ctx.GlobalInt(pprofPortFlag.Name)
+ if ctx.GlobalIsSet(legacyPprofPortFlag.Name) && !ctx.GlobalIsSet(pprofPortFlag.Name) {
+ port = ctx.GlobalInt(legacyPprofPortFlag.Name)
+ log.Warn("The flag --pprofport is deprecated and will be removed in the future, please use --pprof.port")
+ }
+
+ address := fmt.Sprintf("%s:%d", listenHost, port)
+ // This context value ("metrics.addr") represents the utils.MetricsHTTPFlag.Name.
+ // It cannot be imported because it will cause a cyclical dependency.
+ StartPProf(address, !ctx.GlobalIsSet("metrics.addr"))
}
return nil
}
-func StartPProf(address string) {
+func StartPProf(address string, withMetrics bool) {
// Hook go-metrics into expvar on any /debug/metrics request, load all vars
// from the registry into expvar, and execute regular expvar handler.
- exp.Exp(metrics.DefaultRegistry)
+ if withMetrics {
+ exp.Exp(metrics.DefaultRegistry)
+ }
http.Handle("/memsize/", http.StripPrefix("/memsize", &Memsize))
log.Info("Starting pprof server", "addr", fmt.Sprintf("http://%s/debug/pprof", address))
go func() {
diff --git a/internal/debug/trace.go b/internal/debug/trace.go
index 898a1d7..cab5dea 100644
--- a/internal/debug/trace.go
+++ b/internal/debug/trace.go
@@ -23,7 +23,7 @@ import (
"os"
"runtime/trace"
- "github.com/ava-labs/go-ethereum/log"
+ "github.com/ethereum/go-ethereum/log"
)
// StartGoTrace turns on tracing, writing to the given file.