logex

package module
Version: v1.3.22 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 28, 2021 License: MIT Imports: 7 Imported by: 6

README

logex

Go GitHub tag (latest SemVer) Sourcegraph GoDoc go.dev Go Report Card Coverage Status FOSSA Status

an enhancement for logrus. logex attaches the context caller info to the logging output.

Since v1.2.0, logex allows switching the logging backends (such as logrus, zap, ...) transparently.

image-20200927083958978

Features

Usages

Build logger transparently

We provide the ability to switch logging backends transparently now.

A sample config file looks like:

app:

  # runmode: devel  # devel, prod

  logger:
    # The field 'level' will be reset to "debug" while the app is started up within a debugger
    # available values are:
    #   "disable"/"off", "panic", "fatal", "error", "warn", "info", "debug", "trace"
    level:  info
    format: text                  # text, json, logfmt, ...
    backend: sugar                # zap, sugar(sugared-zap) or logrus
    target: file                  # console, file
    directory: /var/log/$APPNAME

Load it to Config structure:

import "github.com/hedzr/log"
var config *log.LoggerConfig = log.NewLoggerConfig()
// ...

And build the backend:

import "github.com/hedzr/logex/build"
logger := build.New(config)
logger.Debugf("int value = %v", intVal)
Or build a logger backend directly
import "github.com/hedzr/logex/logx/logrus"
logrus.New(level string, traceMode, debugMode bool, opts ...Opt)

import "github.com/hedzr/logex/logx/zap"
zap.New(level string, traceMode, debugMode bool, opts ...Opt)

import "github.com/hedzr/logex/logx/zap/sugar"
sugar.New(level string, traceMode, debugMode bool, opts ...Opt)

Or, build the logger with pure go codes
import "github.com/hedzr/logex/build"
// config:=build.NewLoggerConfig()
config := build.NewLoggerConfigWith(true, "logrus", "debug")
logger := build.New(config)
logger.Debugf("int value = %v", intVal)

That's all stocked.

Integrating your backend:

You can wrap a logging backend with log.Logger and register it into logex/build. Why we should do it like this? A universal logger creating interface from logex/build will simplify the application initiliazing coding, esp. in a framework.

import "github.com/hedzr/logex/build"

build.RegisterBuilder("someone", createSomeLogger)

func createSomeLogger(config *log.LoggerConfig) log.Logger {
	//... wrapping your logging backend to log.Logger
}

// and use it:
build.New(build.NewLoggerConfigWith(true, "someone", "debug"))
build.New(build.NewLoggerConfigWith(false, "someone", "info"))
Legacy tools
Enable logrus
import "github.com/hedzr/logex"

func init(){
    logex.Enable()
    // Or:
    logex.EnableWith(logrus.DebugLevel)
}
Ignore the extra caller frames

If you are writing logging func wrappers, you might ignore the extra caller frames for those wrappers:

func wrong(err error, fmt string, args interface{}) {
    logrus.WithError(err).WithFields(logrus.Fields{
        logex.SKIP: 1,  // ignore wrong() frame
    }).Errorf(fmt, args)
}

func wrongInner(err error, fields logrus.Fields, fmt string, args interface{}) {
    logrus.WithError(err).WithFields(fields).Errorf(fmt, args)
}

func wrongwrong(err error, fmt string, args interface{}) {
    wrongInner(err, logrus.Fields{
        logex.SKIP: 2,  // ignore wrongwrong() and wrongInner() frame
    }, fmt, args...)
}

For go test

make logrus works in go test

The codes is copied from:

https://github.com/sirupsen/logrus/issues/834

And in a test function, you could code now:

   func TestFoo(t *testing.T) {
     defer logex.CaptureLog(t).Release()
     // …
   }

LICENSE

MIT

FOSSA Status

Documentation

Overview

Package logex is a logging helper library which append the context call info to logging output for locating

Index

Constants

View Source
const (
	// AppName const
	AppName = "logex"
	// Version const
	Version = "1.3.22"
	// VersionInt const
	VersionInt = 0x010316
)
View Source
const SKIP = formatter.SKIP

SKIP is a constant key Deprecated it's obsoleted

Variables

This section is empty.

Functions

func Enable

func Enable()

Enable makes logrus logging enabled. Deprecated it's obsoleted

func EnableWith added in v1.0.3

func EnableWith(lvl log.Level, opts ...Option)

EnableWith makes logrus logging enabled. Deprecated it's obsoleted

func GetDebugMode added in v1.2.0

func GetDebugMode() bool

GetDebugMode return the debug boolean flag generally

func GetLevel

func GetLevel() log.Level

GetLevel returns the current logging level in log/logex subsystem

func GetTraceMode added in v1.2.0

func GetTraceMode() bool

GetTraceMode return the trace boolean flag generally

func InDebugging added in v1.2.0

func InDebugging() bool

InDebugging check if the delve debugger presents

func SetDebugMode added in v1.2.0

func SetDebugMode(b bool)

SetDebugMode set the debug boolean flag generally

func SetTraceMode added in v1.2.0

func SetTraceMode(b bool)

SetTraceMode set the trace boolean flag generally

func SetupLoggingFormat added in v1.1.9

func SetupLoggingFormat(format string, logexSkipFrames int)

SetupLoggingFormat specify logrus logging configurations. Deprecated it's obsoleted

Types

type LogCapturer added in v1.0.1

type LogCapturer interface {
	Release()
}

LogCapturer reroutes testing.T log output

func CaptureLog added in v1.0.1

func CaptureLog(tb testing.TB) LogCapturer

CaptureLog redirects logrus output to testing.Log

type Option added in v1.1.9

type Option func()

Option specify option function. Deprecated it's obsoleted

Directories

Path Synopsis
logx
zap

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL