log: fix some functions comments (#29907)
updates some docstrings --------- Co-authored-by: rjl493456442 <garyrong0905@gmail.com>
This commit is contained in:
parent
a58e4f0674
commit
b78d2352ef
|
@ -139,11 +139,15 @@ func (h *GlogHandler) Vmodule(ruleset string) error {
|
|||
return nil
|
||||
}
|
||||
|
||||
// Enabled implements slog.Handler, reporting whether the handler handles records
|
||||
// at the given level.
|
||||
func (h *GlogHandler) Enabled(ctx context.Context, lvl slog.Level) bool {
|
||||
// fast-track skipping logging if override not enabled and the provided verbosity is above configured
|
||||
return h.override.Load() || slog.Level(h.level.Load()) <= lvl
|
||||
}
|
||||
|
||||
// WithAttrs implements slog.Handler, returning a new Handler whose attributes
|
||||
// consist of both the receiver's attributes and the arguments.
|
||||
func (h *GlogHandler) WithAttrs(attrs []slog.Attr) slog.Handler {
|
||||
h.lock.RLock()
|
||||
siteCache := maps.Clone(h.siteCache)
|
||||
|
@ -164,12 +168,16 @@ func (h *GlogHandler) WithAttrs(attrs []slog.Attr) slog.Handler {
|
|||
return &res
|
||||
}
|
||||
|
||||
// WithGroup implements slog.Handler, returning a new Handler with the given
|
||||
// group appended to the receiver's existing groups.
|
||||
//
|
||||
// Note, this function is not implemented.
|
||||
func (h *GlogHandler) WithGroup(name string) slog.Handler {
|
||||
panic("not implemented")
|
||||
}
|
||||
|
||||
// Log implements Handler.Log, filtering a log record through the global, local
|
||||
// and backtrace filters, finally emitting it if either allow it through.
|
||||
// Handle implements slog.Handler, filtering a log record through the global,
|
||||
// local and backtrace filters, finally emitting it if either allow it through.
|
||||
func (h *GlogHandler) Handle(_ context.Context, r slog.Record) error {
|
||||
// If the global log level allows, fast track logging
|
||||
if slog.Level(h.level.Load()) <= r.Level {
|
||||
|
|
|
@ -35,7 +35,7 @@ const (
|
|||
LvlDebug = LevelDebug
|
||||
)
|
||||
|
||||
// convert from old Geth verbosity level constants
|
||||
// FromLegacyLevel converts from old Geth verbosity level constants
|
||||
// to levels defined by slog
|
||||
func FromLegacyLevel(lvl int) slog.Level {
|
||||
switch lvl {
|
||||
|
@ -107,7 +107,7 @@ type Logger interface {
|
|||
// With returns a new Logger that has this logger's attributes plus the given attributes
|
||||
With(ctx ...interface{}) Logger
|
||||
|
||||
// With returns a new Logger that has this logger's attributes plus the given attributes. Identical to 'With'.
|
||||
// New returns a new Logger that has this logger's attributes plus the given attributes. Identical to 'With'.
|
||||
New(ctx ...interface{}) Logger
|
||||
|
||||
// Log logs a message at the specified level with context key/value pairs
|
||||
|
@ -156,7 +156,7 @@ func (l *logger) Handler() slog.Handler {
|
|||
return l.inner.Handler()
|
||||
}
|
||||
|
||||
// Write logs a message at the specified level:
|
||||
// Write logs a message at the specified level.
|
||||
func (l *logger) Write(level slog.Level, msg string, attrs ...any) {
|
||||
if !l.inner.Enabled(context.Background(), level) {
|
||||
return
|
||||
|
|
Loading…
Reference in New Issue