feat: manually mirror opencoze's code from bytedance

Change-Id: I09a73aadda978ad9511264a756b2ce51f5761adf

backend/pkg/logs/default.go

@@ -0,0 +1,292 @@
+/*
+ * Copyright 2025 coze-dev Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package logs
+
+import (
+	"context"
+	"fmt"
+	"io"
+	"log"
+	"os"
+)
+
+var logger FullLogger = &defaultLogger{
+	level:  LevelInfo,
+	stdlog: log.New(os.Stderr, "", log.LstdFlags|log.Lshortfile|log.Lmicroseconds),
+}
+
+// SetOutput sets the output of default logs. By default, it is stderr.
+func SetOutput(w io.Writer) {
+	logger.SetOutput(w)
+}
+
+// SetLevel sets the level of logs below which logs will not be output.
+// The default log level is LevelTrace.
+// Note that this method is not concurrent-safe.
+func SetLevel(lv Level) {
+	logger.SetLevel(lv)
+}
+
+// DefaultLogger return the default logs for kitex.
+func DefaultLogger() FullLogger {
+	return logger
+}
+
+// SetLogger sets the default logs.
+// Note that this method is not concurrent-safe and must not be called
+// after the use of DefaultLogger and global functions in this package.
+func SetLogger(v FullLogger) {
+	logger = v
+}
+
+// Fatal calls the default logs's Fatal method and then os.Exit(1).
+func Fatal(v ...interface{}) {
+	logger.Fatal(v...)
+}
+
+// Error calls the default logs's Error method.
+func Error(v ...interface{}) {
+	logger.Error(v...)
+}
+
+// Warn calls the default logs's Warn method.
+func Warn(v ...interface{}) {
+	logger.Warn(v...)
+}
+
+// Notice calls the default logs's Notice method.
+func Notice(v ...interface{}) {
+	logger.Notice(v...)
+}
+
+// Info calls the default logs's Info method.
+func Info(v ...interface{}) {
+	logger.Info(v...)
+}
+
+// Debug calls the default logs's Debug method.
+func Debug(v ...interface{}) {
+	logger.Debug(v...)
+}
+
+// Trace calls the default logs's Trace method.
+func Trace(v ...interface{}) {
+	logger.Trace(v...)
+}
+
+// Fatalf calls the default logs's Fatalf method and then os.Exit(1).
+func Fatalf(format string, v ...interface{}) {
+	logger.Fatalf(format, v...)
+}
+
+// Errorf calls the default logs's Errorf method.
+func Errorf(format string, v ...interface{}) {
+	logger.Errorf(format, v...)
+}
+
+// Warnf calls the default logs's Warnf method.
+func Warnf(format string, v ...interface{}) {
+	logger.Warnf(format, v...)
+}
+
+// Noticef calls the default logs's Noticef method.
+func Noticef(format string, v ...interface{}) {
+	logger.Noticef(format, v...)
+}
+
+// Infof calls the default logs's Infof method.
+func Infof(format string, v ...interface{}) {
+	logger.Infof(format, v...)
+}
+
+// Debugf calls the default logs's Debugf method.
+func Debugf(format string, v ...interface{}) {
+	logger.Debugf(format, v...)
+}
+
+// Tracef calls the default logs's Tracef method.
+func Tracef(format string, v ...interface{}) {
+	logger.Tracef(format, v...)
+}
+
+// CtxFatalf calls the default logs's CtxFatalf method and then os.Exit(1).
+func CtxFatalf(ctx context.Context, format string, v ...interface{}) {
+	logger.CtxFatalf(ctx, format, v...)
+}
+
+// CtxErrorf calls the default logs's CtxErrorf method.
+func CtxErrorf(ctx context.Context, format string, v ...interface{}) {
+	logger.CtxErrorf(ctx, format, v...)
+}
+
+// CtxWarnf calls the default logs's CtxWarnf method.
+func CtxWarnf(ctx context.Context, format string, v ...interface{}) {
+	logger.CtxWarnf(ctx, format, v...)
+}
+
+// CtxNoticef calls the default logs's CtxNoticef method.
+func CtxNoticef(ctx context.Context, format string, v ...interface{}) {
+	logger.CtxNoticef(ctx, format, v...)
+}
+
+// CtxInfof calls the default logs's CtxInfof method.
+func CtxInfof(ctx context.Context, format string, v ...interface{}) {
+	logger.CtxInfof(ctx, format, v...)
+}
+
+// CtxDebugf calls the default logs's CtxDebugf method.
+func CtxDebugf(ctx context.Context, format string, v ...interface{}) {
+	logger.CtxDebugf(ctx, format, v...)
+}
+
+// CtxTracef calls the default logs's CtxTracef method.
+func CtxTracef(ctx context.Context, format string, v ...interface{}) {
+	logger.CtxTracef(ctx, format, v...)
+}
+
+type defaultLogger struct {
+	stdlog *log.Logger
+	level  Level
+}
+
+func (ll *defaultLogger) SetOutput(w io.Writer) {
+	ll.stdlog.SetOutput(w)
+}
+
+func (ll *defaultLogger) SetLevel(lv Level) {
+	ll.level = lv
+}
+
+func (ll *defaultLogger) logf(lv Level, format *string, v ...interface{}) {
+	if ll.level > lv {
+		return
+	}
+	msg := lv.toString()
+	if format != nil {
+		msg += fmt.Sprintf(*format, v...)
+	} else {
+		msg += fmt.Sprint(v...)
+	}
+	ll.stdlog.Output(4, msg)
+	if lv == LevelFatal {
+		os.Exit(1)
+	}
+}
+
+func (ll *defaultLogger) logfCtx(ctx context.Context, lv Level, format *string, v ...interface{}) {
+	if ll.level > lv {
+		return
+	}
+	msg := lv.toString()
+	logID := ctx.Value("log-id")
+	if logID != nil {
+		msg += fmt.Sprintf("[log-id: %v] ", logID)
+	}
+	if format != nil {
+		msg += fmt.Sprintf(*format, v...)
+	} else {
+		msg += fmt.Sprint(v...)
+	}
+	ll.stdlog.Output(4, msg)
+	if lv == LevelFatal {
+		os.Exit(1)
+	}
+}
+
+func (ll *defaultLogger) Fatal(v ...interface{}) {
+	ll.logf(LevelFatal, nil, v...)
+}
+
+func (ll *defaultLogger) Error(v ...interface{}) {
+	ll.logf(LevelError, nil, v...)
+}
+
+func (ll *defaultLogger) Warn(v ...interface{}) {
+	ll.logf(LevelWarn, nil, v...)
+}
+
+func (ll *defaultLogger) Notice(v ...interface{}) {
+	ll.logf(LevelNotice, nil, v...)
+}
+
+func (ll *defaultLogger) Info(v ...interface{}) {
+	ll.logf(LevelInfo, nil, v...)
+}
+
+func (ll *defaultLogger) Debug(v ...interface{}) {
+	ll.logf(LevelDebug, nil, v...)
+}
+
+func (ll *defaultLogger) Trace(v ...interface{}) {
+	ll.logf(LevelTrace, nil, v...)
+}
+
+func (ll *defaultLogger) Fatalf(format string, v ...interface{}) {
+	ll.logf(LevelFatal, &format, v...)
+}
+
+func (ll *defaultLogger) Errorf(format string, v ...interface{}) {
+	ll.logf(LevelError, &format, v...)
+}
+
+func (ll *defaultLogger) Warnf(format string, v ...interface{}) {
+	ll.logf(LevelWarn, &format, v...)
+}
+
+func (ll *defaultLogger) Noticef(format string, v ...interface{}) {
+	ll.logf(LevelNotice, &format, v...)
+}
+
+func (ll *defaultLogger) Infof(format string, v ...interface{}) {
+	ll.logf(LevelInfo, &format, v...)
+}
+
+func (ll *defaultLogger) Debugf(format string, v ...interface{}) {
+	ll.logf(LevelDebug, &format, v...)
+}
+
+func (ll *defaultLogger) Tracef(format string, v ...interface{}) {
+	ll.logf(LevelTrace, &format, v...)
+}
+
+func (ll *defaultLogger) CtxFatalf(ctx context.Context, format string, v ...interface{}) {
+	ll.logfCtx(ctx, LevelFatal, &format, v...)
+}
+
+func (ll *defaultLogger) CtxErrorf(ctx context.Context, format string, v ...interface{}) {
+	ll.logfCtx(ctx, LevelError, &format, v...)
+}
+
+func (ll *defaultLogger) CtxWarnf(ctx context.Context, format string, v ...interface{}) {
+	ll.logfCtx(ctx, LevelWarn, &format, v...)
+}
+
+func (ll *defaultLogger) CtxNoticef(ctx context.Context, format string, v ...interface{}) {
+	ll.logfCtx(ctx, LevelNotice, &format, v...)
+}
+
+func (ll *defaultLogger) CtxInfof(ctx context.Context, format string, v ...interface{}) {
+	ll.logfCtx(ctx, LevelInfo, &format, v...)
+}
+
+func (ll *defaultLogger) CtxDebugf(ctx context.Context, format string, v ...interface{}) {
+	ll.logfCtx(ctx, LevelDebug, &format, v...)
+}
+
+func (ll *defaultLogger) CtxTracef(ctx context.Context, format string, v ...interface{}) {
+	ll.logfCtx(ctx, LevelTrace, &format, v...)
+}

backend/pkg/logs/logger.go

@@ -0,0 +1,104 @@
+/*
+ * Copyright 2025 coze-dev Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package logs
+
+import (
+	"context"
+	"fmt"
+	"io"
+)
+
+// FormatLogger is a logs interface that output logs with a format.
+type FormatLogger interface {
+	Tracef(format string, v ...interface{})
+	Debugf(format string, v ...interface{})
+	Infof(format string, v ...interface{})
+	Noticef(format string, v ...interface{})
+	Warnf(format string, v ...interface{})
+	Errorf(format string, v ...interface{})
+	Fatalf(format string, v ...interface{})
+}
+
+// Logger is a logs interface that provides logging function with levels.
+type Logger interface {
+	Trace(v ...interface{})
+	Debug(v ...interface{})
+	Info(v ...interface{})
+	Notice(v ...interface{})
+	Warn(v ...interface{})
+	Error(v ...interface{})
+	Fatal(v ...interface{})
+}
+
+// CtxLogger is a logs interface that accepts a context argument and output
+// logs with a format.
+type CtxLogger interface {
+	CtxTracef(ctx context.Context, format string, v ...interface{})
+	CtxDebugf(ctx context.Context, format string, v ...interface{})
+	CtxInfof(ctx context.Context, format string, v ...interface{})
+	CtxNoticef(ctx context.Context, format string, v ...interface{})
+	CtxWarnf(ctx context.Context, format string, v ...interface{})
+	CtxErrorf(ctx context.Context, format string, v ...interface{})
+	CtxFatalf(ctx context.Context, format string, v ...interface{})
+}
+
+// Control provides methods to config a logs.
+type Control interface {
+	SetLevel(Level)
+	SetOutput(io.Writer)
+}
+
+// FullLogger is the combination of Logger, FormatLogger, CtxLogger and Control.
+type FullLogger interface {
+	Logger
+	FormatLogger
+	CtxLogger
+	Control
+}
+
+// Level defines the priority of a log message.
+// When a logs is configured with a level, any log message with a lower
+// log level (smaller by integer comparison) will not be output.
+type Level int
+
+// The levels of logs.
+const (
+	LevelTrace Level = iota
+	LevelDebug
+	LevelInfo
+	LevelNotice
+	LevelWarn
+	LevelError
+	LevelFatal
+)
+
+var strs = []string{
+	"[Trace] ",
+	"[Debug] ",
+	"[Info] ",
+	"[Notice] ",
+	"[Warn] ",
+	"[Error] ",
+	"[Fatal] ",
+}
+
+func (lv Level) toString() string {
+	if lv >= LevelTrace && lv <= LevelFatal {
+		return strs[lv]
+	}
+	return fmt.Sprintf("[?%d] ", lv)
+}