log

Documentation

Index

• Variables
• func New(path string) *logging.Logger
• func Noop() *logging.Logger
• func Stdout() *logging.Logger
• type Kit
  • func NewKit(b, a, e *logging.Logger) Kit
• type Valuer
  • func Caller(depth int) Valuer
  • func Cost(t time.Time) Valuer
  • func Timestamp(t func() time.Time) Valuer
  • func TimestampFormat(t func() time.Time, layout string) Valuer
  • func TraceID(ctx goctx.Context) Valuer

Variables

var (
	// DefaultTimestamp is a Valuer that returns the current wallclock time,
	// respecting time zones, when bound.
	//DefaultTimestamp = TimestampFormat(time.Now, time.RFC3339)
	DefaultTimestamp = TimestampFormat(time.Now, "2006-01-02 15:04:05.999")

	// DefaultTimestampUTC is a Valuer that returns the current time in UTC
	// when bound.
	DefaultTimestampUTC = TimestampFormat(
		func() time.Time { return time.Now().UTC() },
		time.RFC3339Nano,
	)

	PID = func() interface{} {
		return strconv.Itoa(os.Getpid())
	}

	// DefaultCaller is a Valuer that returns the file and line where the Log
	// method was invoked. It can only be used with log.With.
	DefaultCaller = Caller(3)
)

Functions

func New

func New(path string) *logging.Logger

func Noop

func Noop() *logging.Logger

func Stdout

func Stdout() *logging.Logger

Types

type Kit

type Kit interface {
	// Business log
	B() *logging.Logger
	// Access log
	A() *logging.Logger
	// Error log
	E() *logging.Logger
}

func NewKit

func NewKit(b, a, e *logging.Logger) Kit

type Valuer

type Valuer func() interface{}

A Valuer generates a log value. When passed to With or WithPrefix in a value element (odd indexes), it represents a dynamic value which is re- evaluated with each log event.

func Caller

func Caller(depth int) Valuer

Caller returns a Valuer that returns a file and line from a specified depth in the callstack. Users will probably want to use DefaultCaller.

func Cost

func Cost(t time.Time) Valuer

func Timestamp

func Timestamp(t func() time.Time) Valuer

Timestamp returns a timestamp Valuer. It invokes the t function to get the time; unless you are doing something tricky, pass time.Now.

Most users will want to use DefaultTimestamp or DefaultTimestampUTC, which are TimestampFormats that use the RFC3339Nano format.

func TimestampFormat

func TimestampFormat(t func() time.Time, layout string) Valuer

TimestampFormat returns a timestamp Valuer with a custom time format. It invokes the t function to get the time to format; unless you are doing something tricky, pass time.Now. The layout string is passed to Time.Format.

Most users will want to use DefaultTimestamp or DefaultTimestampUTC, which are TimestampFormats that use the RFC3339Nano format.

func TraceID

func TraceID(ctx goctx.Context) Valuer

TraceID todo 使用jaeger，暂时注释