debug

Documentation

Index

• Constants
• Variables
• func NewInvalidLogLevelError(logLevel string) error
• type Helper
  • func New(logLevels ...string) (*Helper, error)
  • func (h *Helper) GetFirecrackerContainerdLogLevel() (logrus.Level, bool)
  • func (h *Helper) GetFirecrackerLogLevel() string
  • func (h *Helper) GetFirecrackerSDKLogLevel() (logrus.Level, bool)
  • func (h *Helper) LogFirecrackerOutput() bool
• type InvalidLogLevelError
  • func (e *InvalidLogLevelError) Error() string

Constants

const (
	// LogLevelDebug will enable debugging for all applciations and SDKs. This
	// uses log levels of firecracker:debug, firecracker-go-sdk:debug,
	// firecracker:output, and firecracker-containerd:debug
	LogLevelDebug = "debug"
	// LogLevelError will enable error logging for all applciations and SDKs.
	// This uses log levels of firecracker:error, firecracker-go-sdk:error,
	// and firecracker-containerd:error
	LogLevelError = "error"
	// LogLevelInfo will enable info logging for all applciations and SDKs.
	// This uses log levels of firecracker:info, firecracker-go-sdk:info,
	// and firecracker-containerd:info
	LogLevelInfo = "info"
	// LogLevelWarning will enable warning logging for all applciations and SDKs.
	// This uses log levels of firecracker:warning, firecracker-go-sdk:warning,
	// firecracker:output, and firecracker-containerd:warning
	LogLevelWarning = "warning"
	// LogLevelFirecrackerDebug enables debug level logging on Firecracker
	// MicroVMs
	LogLevelFirecrackerDebug = "firecracker:debug"
	// LogLevelFirecrackerError enables error level logging on Firecracker
	// MicroVMs
	LogLevelFirecrackerError = "firecracker:error"
	// LogLevelFirecrackerInfo enables info level logging on Firecracker MicroVMs
	LogLevelFirecrackerInfo = "firecracker:info"
	// LogLevelFirecrackerWarning enables warning level logging on Firecracker
	// MicroVMs
	LogLevelFirecrackerWarning = "firecracker:warning"
	// LogLevelFirecrackerOutput will redirect stdout and stderr of Firecracker
	// to logging. By default, stdout and stderr is ignored
	LogLevelFirecrackerOutput = "firecracker:output"
	// LogLevelFirecrackerSDKDebug enables debug level logging on
	// firecracker-go-sdk
	LogLevelFirecrackerSDKDebug = "firecracker-go-sdk:debug"
	// LogLevelFirecrackerSDKError enables error level logging on
	// firecracker-go-sdk
	LogLevelFirecrackerSDKError = "firecracker-go-sdk:error"
	// LogLevelFirecrackerSDKInfo enables info level logging on
	// firecracker-go-sdk
	LogLevelFirecrackerSDKInfo = "firecracker-go-sdk:info"
	// LogLevelFirecrackerSDKWarning enables warning level logging on
	// firecracker-go-sdk
	LogLevelFirecrackerSDKWarning = "firecracker-go-sdk:warning"
	// LogLevelFirecrackerContainerdDebug enables debug level logging on
	// firecracker-containerd
	LogLevelFirecrackerContainerdDebug = "firecracker-containerd:debug"
	// LogLevelFirecrackerContainerdError enables error level logging on
	// firecracker-containerd
	LogLevelFirecrackerContainerdError = "firecracker-containerd:error"
	// LogLevelFirecrackerContainerdInfo enables info level logging on
	// firecracker-containerd
	LogLevelFirecrackerContainerdInfo = "firecracker-containerd:info"
	// LogLevelFirecrackerContainerdWarning enables warning level logging on
	// firecracker-containerd
	LogLevelFirecrackerContainerdWarning = "firecracker-containerd:warning"
)

Variables

var ErrFCContainerdLogLevelAlreadySet = fmt.Errorf("only one value of firecracker-containerd log level can be set")

ErrFCContainerdLogLevelAlreadySet will return if a log level has been previously set.

var ErrFCLogLevelAlreadySet = fmt.Errorf("only one value of firecracker log level can be set")

ErrFCLogLevelAlreadySet will return if a log level has been previously set.

var ErrFCSDKLogLevelAlreadySet = fmt.Errorf("only one value of firecracker-go-sdk log level can be set")

ErrFCSDKLogLevelAlreadySet will return if a log level has been previously set.

var ErrLogLevelAlreadySet = fmt.Errorf("only one value for top level log level can be set")

ErrLogLevelAlreadySet will return if a log level has been previously set.

Functions

func NewInvalidLogLevelError

func NewInvalidLogLevelError(logLevel string) error

NewInvalidLogLevelError will constract an InvalidLogLevelError

Types

type Helper

type Helper struct {
	ShimDebug bool
	// contains filtered or unexported fields
}

Helper is used to abstract away the complications of multilevel log levels.

func New

func New(logLevels ...string) (*Helper, error)

New will return a new Helper in the event an error does not occur. This will parse the logLevel provided to figure out what logging is enabled. New will also validate that the log level is a valid value along with any mutually exclusive values.

func (*Helper) GetFirecrackerContainerdLogLevel

func (h *Helper) GetFirecrackerContainerdLogLevel() (logrus.Level, bool)

GetFirecrackerContainerdLogLevel return the log level for firecracker-containerd

func (*Helper) GetFirecrackerLogLevel

func (h *Helper) GetFirecrackerLogLevel() string

GetFirecrackerLogLevel will return the current log level for Firecracker.

func (*Helper) GetFirecrackerSDKLogLevel

func (h *Helper) GetFirecrackerSDKLogLevel() (logrus.Level, bool)

GetFirecrackerSDKLogLevel returns what log level to log the firecracker-go-sdk at. This also return whether or not the value was set

func (*Helper) LogFirecrackerOutput

func (h *Helper) LogFirecrackerOutput() bool

LogFirecrackerOutput will return whether our not we want to redirect stdout and stderr to our logging

type InvalidLogLevelError

type InvalidLogLevelError struct {
	// contains filtered or unexported fields
}

InvalidLogLevelError is an error that will be returned in the event that an invalid log level was provided

func (*InvalidLogLevelError) Error

func (e *InvalidLogLevelError) Error() string