logger.go

// Copyright 2018 The OpenPitrix Authors. All rights reserved.
// Use of this source code is governed by a Apache license
// that can be found in the LICENSE file.

// Package logger provides standard logger for OpenPitrix.
package logger

import (
	"context"
	"fmt"
	"io"
	"os"
	"strings"
	"sync/atomic"
	"time"

	"openpitrix.io/logger/ctxutil"
)

var (
	defaultGlobalLogLevel = InfoLevel
	defaultLoggerHelper   = New().WithDepth(1)
)

func escapeNewline(s string) string {
	var replacer = strings.NewReplacer("\r", "\\r", "\n", "\\n")
	return replacer.Replace(s)
}

func SetLevelByString(level string) {
	defaultGlobalLogLevel = StringToLevel(level)
	defaultLoggerHelper.SetLevelByString(level)
}

func Infof(ctx context.Context, format string, a ...interface{}) {
	defaultLoggerHelper.Infof(ctx, format, a...)
}

func Debugf(ctx context.Context, format string, a ...interface{}) {
	defaultLoggerHelper.Debugf(ctx, format, a...)
}

func Warnf(ctx context.Context, format string, a ...interface{}) {
	defaultLoggerHelper.Warnf(ctx, format, a...)
}

func Errorf(ctx context.Context, format string, a ...interface{}) {
	defaultLoggerHelper.Errorf(ctx, format, a...)
}

func Criticalf(ctx context.Context, format string, a ...interface{}) {
	defaultLoggerHelper.Criticalf(ctx, format, a...)
}

func HideCallstack() {
	defaultLoggerHelper.HideCallstack()
}
func ShowCallstack() {
	defaultLoggerHelper.ShowCallstack()
}

func SetOutput(output io.Writer) {
	defaultLoggerHelper.SetOutput(output)
}

type Logger struct {
	Level         Level
	output        io.Writer
	hideCallstack uint32
	depth         int
}

func New() *Logger {
	return &Logger{
		Level:  defaultGlobalLogLevel,
		output: os.Stdout,
		depth:  0,
	}
}

func (p *Logger) level() Level {
	return Level(atomic.LoadUint32((*uint32)(&p.Level)))
}
func (p *Logger) SetLevel(level Level) {
	atomic.StoreUint32((*uint32)(&p.Level), uint32(level))
}
func (p *Logger) SetLevelByString(level string) {
	p.SetLevel(StringToLevel(level))
}

func (p *Logger) isHideCallstack() bool {
	return atomic.LoadUint32((*uint32)(&p.hideCallstack)) != 0
}
func (p *Logger) HideCallstack() *Logger {
	atomic.StoreUint32((*uint32)(&p.hideCallstack), 1)
	return p
}
func (p *Logger) ShowCallstack() *Logger {
	atomic.StoreUint32((*uint32)(&p.hideCallstack), 0)
	return p
}

func (p *Logger) Debugf(ctx context.Context, format string, a ...interface{}) {
	output := escapeNewline(fmt.Sprintf(format, a...))
	p.logOutput(ctx, DebugLevel, output, p.depth+1)
}

func (p *Logger) Infof(ctx context.Context, format string, a ...interface{}) {
	output := escapeNewline(fmt.Sprintf(format, a...))
	p.logOutput(ctx, InfoLevel, output, p.depth+1)
}

func (p *Logger) Warnf(ctx context.Context, format string, a ...interface{}) {
	output := escapeNewline(fmt.Sprintf(format, a...))
	p.logOutput(ctx, WarnLevel, output, p.depth+1)
}

func (p *Logger) Errorf(ctx context.Context, format string, args ...interface{}) {
	output := escapeNewline(fmt.Sprintf(format, args...))
	p.logOutput(ctx, ErrorLevel, output, p.depth+1)
}

func (p *Logger) Criticalf(ctx context.Context, format string, args ...interface{}) {
	output := escapeNewline(fmt.Sprintf(format, args...))
	p.logOutput(ctx, CriticalLevel, output, p.depth+1)
}

func (p *Logger) SetOutput(w io.Writer) *Logger {
	p.output = w
	return p
}

func (p *Logger) WithDepth(depth int) *Logger {
	p.depth = depth
	return p
}

func (p *Logger) logOutput(ctx context.Context, level Level, output string, callerDepth int) {
	if p.level() < level {
		return
	}

	var (
		now = time.Now().Format("2006-01-02 15:04:05.99999")

		messageId = ctxutil.GetMessageId(ctx)
		requestId = ctxutil.GetRequestId(ctx)

		suffix string
	)

	if len(messageId) > 0 {
		suffix = strings.Join(messageId, "|")
	}
	if len(requestId) > 0 || suffix != "" {
		suffix += "@" + requestId
	}
	if suffix != "" {
		suffix = "{" + suffix + "}"
	}

	if p.isHideCallstack() {
		output = fmt.Sprintf("%-25s -%s- %s%s",
			now, strings.ToUpper(level.String()),
			output,
			suffix,
		)
	} else {
		file, line, _ := callerInfo(callerDepth + 1)

		// 2018-03-27 02:08:44.93894 -INFO- Api service start http://openpitrix-api-gateway:9100 (main.go:44)
		output = fmt.Sprintf("%-25s -%s- %s (%s:%d)%s",
			now, strings.ToUpper(level.String()),
			output, file, line,
			suffix,
		)
	}

	fmt.Fprintln(p.output, output)
}