logging

Documentation

Index

• Variables
• func LogDirPath(ctx *cli.Context) string
• func SetupLogger(filePrefix string) log.Logger
• func SetupLoggerCmd(filePrefix string, cmd *cobra.Command) log.Logger
• func SetupLoggerCtx(filePrefix string, ctx *cli.Context, consoleDefaultLevel log.Lvl, ...) log.Logger

Variables

var (
	LogJsonFlag = cli.BoolFlag{
		Name:  "log.json",
		Usage: "Format console logs with JSON",
	}

	LogConsoleJsonFlag = cli.BoolFlag{
		Name:  "log.console.json",
		Usage: "Format console logs with JSON",
	}

	LogDirJsonFlag = cli.BoolFlag{
		Name:  "log.dir.json",
		Usage: "Format file logs with JSON",
	}

	LogVerbosityFlag = cli.StringFlag{
		Name:  "verbosity",
		Usage: "Set the log level for console logs",
		Value: log.LvlInfo.String(),
	}

	LogConsoleVerbosityFlag = cli.StringFlag{
		Name:  "log.console.verbosity",
		Usage: "Set the log level for console logs",
		Value: log.LvlInfo.String(),
	}
	LogDirDisableFlag = cli.BoolFlag{
		Name:  "log.dir.disable",
		Usage: "disable disk logging",
	}
	LogDirPathFlag = cli.StringFlag{
		Name:  "log.dir.path",
		Usage: "Path to store user and error logs to disk",
	}

	LogDirPrefixFlag = cli.StringFlag{
		Name:  "log.dir.prefix",
		Usage: "The file name prefix for logs stored to disk",
	}

	LogDirVerbosityFlag = cli.StringFlag{
		Name:  "log.dir.verbosity",
		Usage: "Set the log verbosity for logs stored to disk",
		Value: log.LvlInfo.String(),
	}

	LogBlockDelayFlag = cli.BoolFlag{
		Name:  "log.delays",
		Usage: "Enable block delay logging",
	}
)

var Flags = []cli.Flag{
	&LogJsonFlag,
	&LogConsoleJsonFlag,
	&LogDirJsonFlag,
	&LogVerbosityFlag,
	&LogConsoleVerbosityFlag,
	&LogDirDisableFlag,
	&LogDirPathFlag,
	&LogDirPrefixFlag,
	&LogDirVerbosityFlag,
	&LogBlockDelayFlag,
}

Functions

func LogDirPath

func LogDirPath(ctx *cli.Context) string

Determine the log dir path based on the given urfave context

func SetupLogger

func SetupLogger(filePrefix string) log.Logger

SetupLoggerCmd perform the logging using parametrs specifying by `flag` package, and sets it to the root logger This is the function which is NOT used by Erigon itself, but instead by utility commands

func SetupLoggerCmd

func SetupLoggerCmd(filePrefix string, cmd *cobra.Command) log.Logger

SetupLoggerCmd perform the logging for a cobra command, and sets it to the root logger This is the function which is NOT used by Erigon itself, but instead by some cobra-based commands, for example, rpcdaemon or integration. Note: urfave and cobra are two CLI frameworks/libraries for the same functionalities and it would make sense to choose one over another

func SetupLoggerCtx

func SetupLoggerCtx(filePrefix string, ctx *cli.Context,
	consoleDefaultLevel log.Lvl, dirDefaultLevel log.Lvl, rootHandler bool) log.Logger

SetupLoggerCtx performs the logging setup according to the parameters contained in the given urfave context. It returns either root logger, if rootHandler argument is set to true, or a newly created logger. This is to ensure gradual transition to the use of non-root logger throughout the erigon code without a huge change at once. This function which is used in Erigon itself. Note: urfave and cobra are two CLI frameworks/libraries for the same functionalities and it would make sense to choose one over another