Skip to content
This repository has been archived by the owner on Aug 2, 2021. It is now read-only.

Commit

Permalink
cmd/swarm, internal/debug: decouple cli library from internal/debug (#…
Browse files Browse the repository at this point in the history 
…2060)
  • Loading branch information
@janos
janos authored Dec 23, 2019
1 parent b8c09a1 commit 1a60969
Show file tree
Hide file tree
Showing 3 changed files with 127 additions and 78 deletions.
83 changes: 83 additions & 0 deletions cmd/swarm/debug.go
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
// Copyright 2019 The Swarm Authors
// This file is part of The Swarm.
//
// The Swarm is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The Swarm is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with The Swarm. If not, see <http://www.gnu.org/licenses/>.

package main

import (
"runtime"

"gopkg.in/urfave/cli.v1"
)

var (
verbosityFlag = cli.IntFlag{
Name: "verbosity",
Usage: "Logging verbosity: 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=detail",
Value: 3,
}
vmoduleFlag = cli.StringFlag{
Name: "vmodule",
Usage: "Per-module verbosity: comma-separated list of <pattern>=<level> (e.g. eth/*=5,p2p=4)",
Value: "",
}
backtraceAtFlag = cli.StringFlag{
Name: "backtrace",
Usage: "Request a stack trace at a specific logging statement (e.g. \"block.go:271\")",
Value: "",
}
debugFlag = cli.BoolFlag{
Name: "debug",
Usage: "Prepends log messages with call-site location (file and line number)",
}
pprofFlag = cli.BoolFlag{
Name: "pprof",
Usage: "Enable the pprof HTTP server",
}
pprofPortFlag = cli.IntFlag{
Name: "pprofport",
Usage: "pprof HTTP server listening port",
Value: 6060,
}
pprofAddrFlag = cli.StringFlag{
Name: "pprofaddr",
Usage: "pprof HTTP server listening interface",
Value: "127.0.0.1",
}
memprofilerateFlag = cli.IntFlag{
Name: "memprofilerate",
Usage: "Turn on memory profiling with the given rate",
Value: runtime.MemProfileRate,
}
blockprofilerateFlag = cli.IntFlag{
Name: "blockprofilerate",
Usage: "Turn on block profiling with the given rate",
}
cpuprofileFlag = cli.StringFlag{
Name: "cpuprofile",
Usage: "Write CPU profile to the given file",
}
traceFlag = cli.StringFlag{
Name: "trace",
Usage: "Write execution trace to the given file",
}
)

// debugFlags holds all command-line flags required for debugging.
var debugFlags = []cli.Flag{
verbosityFlag, vmoduleFlag, backtraceAtFlag, debugFlag,
pprofFlag, pprofAddrFlag, pprofPortFlag,
memprofilerateFlag, blockprofilerateFlag, cpuprofileFlag, traceFlag,
}
16 changes: 14 additions & 2 deletions cmd/swarm/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -225,12 +225,24 @@ func init() {
utils.WSAllowedOriginsFlag,
}
app.Flags = append(app.Flags, rpcFlags...)
app.Flags = append(app.Flags, debug.Flags...)
app.Flags = append(app.Flags, debugFlags...)
app.Flags = append(app.Flags, swarmmetrics.Flags...)
app.Flags = append(app.Flags, flags.Tracing...)
app.Before = func(ctx *cli.Context) error {
runtime.GOMAXPROCS(runtime.NumCPU())
if err := debug.Setup(ctx, ""); err != nil {
if err := debug.Setup(debug.Options{
Debug: ctx.GlobalBool(debugFlag.Name),
Verbosity: ctx.GlobalInt(verbosityFlag.Name),
Vmodule: ctx.GlobalString(vmoduleFlag.Name),
BacktraceAt: ctx.GlobalString(backtraceAtFlag.Name),
MemProfileRate: ctx.GlobalInt(memprofilerateFlag.Name),
BlockProfileRate: ctx.GlobalInt(blockprofilerateFlag.Name),
TraceFile: ctx.GlobalString(traceFlag.Name),
CPUProfileFile: ctx.GlobalString(cpuprofileFlag.Name),
PprofEnabled: ctx.GlobalBool(pprofFlag.Name),
PprofAddr: ctx.GlobalString(pprofAddrFlag.Name),
PprofPort: ctx.GlobalInt(pprofPortFlag.Name),
}); err != nil {
return err
}
swarmmetrics.Setup(ctx)
Expand Down
106 changes: 30 additions & 76 deletions internal/debug/flags.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,71 +30,10 @@ import (
"github.com/fjl/memsize/memsizeui"
colorable "github.com/mattn/go-colorable"
"github.com/mattn/go-isatty"
"gopkg.in/urfave/cli.v1"
)

var Memsize memsizeui.Handler

var (
verbosityFlag = cli.IntFlag{
Name: "verbosity",
Usage: "Logging verbosity: 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=detail",
Value: 3,
}
vmoduleFlag = cli.StringFlag{
Name: "vmodule",
Usage: "Per-module verbosity: comma-separated list of <pattern>=<level> (e.g. eth/*=5,p2p=4)",
Value: "",
}
backtraceAtFlag = cli.StringFlag{
Name: "backtrace",
Usage: "Request a stack trace at a specific logging statement (e.g. \"block.go:271\")",
Value: "",
}
debugFlag = cli.BoolFlag{
Name: "debug",
Usage: "Prepends log messages with call-site location (file and line number)",
}
pprofFlag = cli.BoolFlag{
Name: "pprof",
Usage: "Enable the pprof HTTP server",
}
pprofPortFlag = cli.IntFlag{
Name: "pprofport",
Usage: "pprof HTTP server listening port",
Value: 6060,
}
pprofAddrFlag = cli.StringFlag{
Name: "pprofaddr",
Usage: "pprof HTTP server listening interface",
Value: "127.0.0.1",
}
memprofilerateFlag = cli.IntFlag{
Name: "memprofilerate",
Usage: "Turn on memory profiling with the given rate",
Value: runtime.MemProfileRate,
}
blockprofilerateFlag = cli.IntFlag{
Name: "blockprofilerate",
Usage: "Turn on block profiling with the given rate",
}
cpuprofileFlag = cli.StringFlag{
Name: "cpuprofile",
Usage: "Write CPU profile to the given file",
}
traceFlag = cli.StringFlag{
Name: "trace",
Usage: "Write execution trace to the given file",
}
)

// Flags holds all command-line flags required for debugging.
var Flags = []cli.Flag{
verbosityFlag, vmoduleFlag, backtraceAtFlag, debugFlag,
pprofFlag, pprofAddrFlag, pprofPortFlag,
memprofilerateFlag, blockprofilerateFlag, cpuprofileFlag, traceFlag,
}

var (
ostream log.Handler
glogger *log.GlogHandler
Expand All @@ -120,40 +59,55 @@ func rotatingFileHandler(logdir string) (log.Handler, error) {
)
}

type Options struct {
Debug bool
Verbosity int
Vmodule string
BacktraceAt string
LogDirectory string
MemProfileRate int
BlockProfileRate int
TraceFile string
CPUProfileFile string
PprofEnabled bool
PprofAddr string
PprofPort int
}

// 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(o Options) error {
// logging
log.PrintOrigins(ctx.GlobalBool(debugFlag.Name))
if logdir != "" {
rfh, err := rotatingFileHandler(logdir)
log.PrintOrigins(o.Debug)
if o.LogDirectory != "" {
rfh, err := rotatingFileHandler(o.LogDirectory)
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))
glogger.Verbosity(log.Lvl(o.Verbosity))
glogger.Vmodule(o.Vmodule)
glogger.BacktraceAt(o.BacktraceAt)
log.Root().SetHandler(glogger)

// profiling, tracing
runtime.MemProfileRate = ctx.GlobalInt(memprofilerateFlag.Name)
Handler.SetBlockProfileRate(ctx.GlobalInt(blockprofilerateFlag.Name))
if traceFile := ctx.GlobalString(traceFlag.Name); traceFile != "" {
if err := Handler.StartGoTrace(traceFile); err != nil {
runtime.MemProfileRate = o.MemProfileRate
Handler.SetBlockProfileRate(o.BlockProfileRate)
if o.TraceFile != "" {
if err := Handler.StartGoTrace(o.TraceFile); err != nil {
return err
}
}
if cpuFile := ctx.GlobalString(cpuprofileFlag.Name); cpuFile != "" {
if err := Handler.StartCPUProfile(cpuFile); err != nil {
if o.CPUProfileFile != "" {
if err := Handler.StartCPUProfile(o.CPUProfileFile); err != nil {
return err
}
}

// pprof server
if ctx.GlobalBool(pprofFlag.Name) {
address := fmt.Sprintf("%s:%d", ctx.GlobalString(pprofAddrFlag.Name), ctx.GlobalInt(pprofPortFlag.Name))
if o.PprofEnabled {
address := fmt.Sprintf("%s:%d", o.PprofAddr, o.PprofPort)
StartPProf(address)
}
return nil
Expand Down

0 comments on commit 1a60969

Please sign in to comment.