mirror of
https://gitea.com/gitea/runner.git
synced 2026-11-05 14:55:44 +00:00
Lunny Xiaoandbircni
e0ef637805
Log through `log/slog`, with a console `slog.Handler` that writes the text the runner has always written (sorted `key=value` fields on a plain stream, a colored prefix on a terminal), so nothing changes for users. I compared its output byte for byte with logrus's `TextFormatter` over plain, colored, timestamped and caller cases. Why not `slog.TextHandler`: its output differs from what users and their log parsers see today, and `ReplaceAttr` cannot close the gap. - level is `WARN` where logrus wrote `warning`, and time has milliseconds and no quotes - fields keep call order instead of being sorted - the caller is one `source=` key, where the runner writes `func=` and `file=` (reshaped by `callPrettyfier`), and `ReplaceAttr` returns a single attribute - no colored prefix on a terminal - no hook to rewrite a whole formatted line, which the process-wide secret masking relies on Libraries that log through logrus's global logger (the workflow model, the Docker client) are forwarded to the process-wide logger, so they keep following its level, format and secret masking. This is why logrus stays in `go.mod`. Stacked on https://gitea.com/gitea/runner/pulls/1303. Assisted-by: Codet Co-authored-by: bircni <[email protected]> Reviewed-on: https://gitea.com/gitea/runner/pulls/1304 Reviewed-by: bircni <[email protected]>
92 lines
3.2 KiB
Go
92 lines
3.2 KiB
Go
// Copyright 2026 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package logging
|
|
|
|
import (
|
|
"io"
|
|
"log/slog"
|
|
"os"
|
|
"runtime"
|
|
"sync/atomic"
|
|
|
|
"github.com/sirupsen/logrus"
|
|
)
|
|
|
|
// TextOptions describes how the process-wide Logger writes a record as text.
|
|
type TextOptions struct {
|
|
DisableColors bool
|
|
DisableTimestamp bool
|
|
FullTimestamp bool
|
|
// CallerPrettyfier renames the function and file reported with a record when ReportCaller is on.
|
|
CallerPrettyfier func(*runtime.Frame) (function, file string)
|
|
// Filter rewrites each formatted line, for example to mask secrets.
|
|
Filter func(line []byte) []byte
|
|
}
|
|
|
|
var (
|
|
std atomic.Pointer[Logger]
|
|
stdState = newConsole(os.Stderr)
|
|
)
|
|
|
|
func init() {
|
|
std.Store(New(NewSlogHandler(&consoleHandler{c: stdState})))
|
|
}
|
|
|
|
// Default returns the process-wide Logger.
|
|
func Default() *Logger { return std.Load() }
|
|
|
|
// SetDefault replaces the process-wide Logger, which tests use to capture what the package
|
|
// functions log. SetLevel, GetLevel, SetOutput and the format functions keep configuring the
|
|
// initial console Logger.
|
|
func SetDefault(l *Logger) { std.Store(l) }
|
|
|
|
// SetLevel sets the minimum level of the initial process-wide Logger and of what libraries log through logrus.
|
|
func SetLevel(level Level) {
|
|
stdState.level.Set(slog.Level(level))
|
|
logrus.SetLevel(toLogrusLevel(level))
|
|
}
|
|
|
|
// GetLevel returns the minimum level of the initial process-wide Logger.
|
|
func GetLevel() Level { return Level(stdState.level.Level()) }
|
|
|
|
// SetOutput sets where the initial process-wide Logger writes.
|
|
func SetOutput(w io.Writer) { stdState.setOutput(w) }
|
|
|
|
// Output returns where the initial process-wide Logger writes.
|
|
func Output() io.Writer {
|
|
stdState.mu.Lock()
|
|
defer stdState.mu.Unlock()
|
|
return stdState.out
|
|
}
|
|
|
|
// SetTextFormat sets the text format of the initial process-wide Logger.
|
|
func SetTextFormat(o TextOptions) {
|
|
stdState.mu.Lock()
|
|
defer stdState.mu.Unlock()
|
|
stdState.opts = o
|
|
}
|
|
|
|
// SetReportCaller makes the initial process-wide Logger record where each call came from, which costs time.
|
|
func SetReportCaller(on bool) {
|
|
stdState.mu.Lock()
|
|
defer stdState.mu.Unlock()
|
|
stdState.reportCaller = on
|
|
logrus.SetReportCaller(on)
|
|
}
|
|
|
|
func Enabled(level Level) bool { return Default().Enabled(level) }
|
|
|
|
func With(args ...any) *Logger { return Default().With(args...) }
|
|
func WithError(err error) *Logger { return Default().WithError(err) }
|
|
func Tracef(format string, args ...any) { Default().logf(LevelTrace, format, args) }
|
|
func Debugf(format string, args ...any) { Default().logf(LevelDebug, format, args) }
|
|
func Infof(format string, args ...any) { Default().logf(LevelInfo, format, args) }
|
|
func Warnf(format string, args ...any) { Default().logf(LevelWarn, format, args) }
|
|
func Errorf(format string, args ...any) { Default().logf(LevelError, format, args) }
|
|
func Trace(args ...any) { Default().log(LevelTrace, args) }
|
|
func Debug(args ...any) { Default().log(LevelDebug, args) }
|
|
func Info(args ...any) { Default().log(LevelInfo, args) }
|
|
func Warn(args ...any) { Default().log(LevelWarn, args) }
|
|
func Error(args ...any) { Default().log(LevelError, args) }
|