logging

Documentation

Index

• Variables
• func ConvertStringKeyedMaps(val interface{}) interface{}
• func SetupZeroLog()
• type CborDiagLogger
  • func NewCborDiagLogger(out io.StringWriter) *CborDiagLogger
  • func (inst *CborDiagLogger) Write(p []byte) (n int, err error)
• type CborSpewLogger
  • func NewCborSpewLogger(out io.Writer) *CborSpewLogger
  • func (inst *CborSpewLogger) Write(p []byte) (n int, err error)
• type JsonIndentLogger
  • func NewJsonIndentLogger(out io.Writer) *JsonIndentLogger
  • func (inst *JsonIndentLogger) Write(p []byte) (n int, err error)

Variables

var LoggingFlags = []cli.Flag{
	&cli.StringFlag{
		Name:        "logLevel",
		Category:    "logging",
		DefaultText: "info",
		EnvVars:     []string{"BOXER_LOG_LEVEL"},
		Action: func(context *cli.Context, s string) error {
			var lvl zerolog.Level
			switch strings.ToLower(s) {
			case "trace":
				lvl = zerolog.TraceLevel
				break
			case "debug":
				lvl = zerolog.DebugLevel
				break
			case "info":
				lvl = zerolog.InfoLevel
				break
			case "warn":
				lvl = zerolog.WarnLevel
				break
			case "error":
				lvl = zerolog.ErrorLevel
				break
			case "fatal":
				lvl = zerolog.FatalLevel
				break
			case "panic":
				lvl = zerolog.PanicLevel
				break
			default:
				return eh.Errorf("unhandled log level %s", s)
			}
			zerolog.SetGlobalLevel(lvl)
			return nil
		},
	},
	&cli.StringFlag{
		Name:        "logFormat",
		Category:    "logging",
		DefaultText: "json",
		EnvVars:     []string{"BOXER_LOG_FORMAT"},
		Action: func(context *cli.Context, s string) error {
			switch s {
			case "console":
				log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stderr, TimeFormat: time.RFC3339})
				dumper := godump.Dumper{
					Indentation:             "  ",
					ShowPrimitiveNamedTypes: false,
					HidePrivateFields:       false,
					Theme:                   godump.DefaultTheme,
				}
				var cbordiagmode cbor.DiagMode
				var cborencmode cbor.EncMode
				var err error
				if true {
					cborencmode, err = cbor.CanonicalEncOptions().EncMode()
					if err != nil {
						log.Warn().Err(err).Msg("unable to create cbor encoder, skipping")
						err = nil
					}
					cbordiagmode, err = cbor.DiagOptions{
						ByteStringEncoding:      0,
						ByteStringHexWhitespace: false,
						ByteStringText:          false,
						ByteStringEmbeddedCBOR:  false,
						CBORSequence:            false,
						FloatPrecisionIndicator: false,
						MaxNestedLevels:         0,
						MaxArrayElements:        0,
						MaxMapPairs:             0,
					}.DiagMode()
					if err != nil {
						log.Warn().Err(err).Msg("unable to create cbor diagmode, skipping")
						err = nil
					}
				}
				zerolog.InterfaceMarshalFunc = func(v any) ([]byte, error) {
					if cborencmode != nil && cbordiagmode != nil {
						c, err := cborencmode.Marshal(v)
						if err == nil {
							s, err = cbordiagmode.Diagnose(c)
							if err == nil {
								return []byte(s), nil
							}
						}
					}
					var js []byte
					js, err = json.MarshalIndent(v, "", "  ")
					if err != nil {
						return []byte(dumper.Sprintln(v)), nil
					}
					return js, nil
				}
				break
			case "diag":
				log.Logger = log.Output(NewCborDiagLogger(os.Stderr))
				break
			case "spew":
				log.Logger = log.Output(NewCborSpewLogger(os.Stderr))
				break
			case "json":
				log.Logger = log.Output(NewJsonIndentLogger(os.Stderr))
				break
			case "cbor":
				checkZeroLogCborBuild()
				log.Logger = log.Output(os.Stderr)
				break
			default:
				return eh.Errorf("unhandled log format %s", s)
			}
			return nil
		},
	},
}

Functions

func ConvertStringKeyedMaps

func ConvertStringKeyedMaps(val interface{}) interface{}

func SetupZeroLog

func SetupZeroLog()

Types

type CborDiagLogger

type CborDiagLogger struct {
	Out io.StringWriter
}

func NewCborDiagLogger

func NewCborDiagLogger(out io.StringWriter) *CborDiagLogger

func (*CborDiagLogger) Write

func (inst *CborDiagLogger) Write(p []byte) (n int, err error)

type CborSpewLogger

type CborSpewLogger struct {
	Out io.Writer
}

func NewCborSpewLogger

func NewCborSpewLogger(out io.Writer) *CborSpewLogger

func (*CborSpewLogger) Write

func (inst *CborSpewLogger) Write(p []byte) (n int, err error)

type JsonIndentLogger

type JsonIndentLogger struct {
	Out    io.Writer
	Prefix string
	Indent string
}

func NewJsonIndentLogger

func NewJsonIndentLogger(out io.Writer) *JsonIndentLogger

func (*JsonIndentLogger) Write

func (inst *JsonIndentLogger) Write(p []byte) (n int, err error)