Document variable names for request.CTX and mlog.Logger (#26029)

This commit is contained in:
Ben Schumacher 2024-01-26 14:03:35 +01:00 committed by GitHub
parent 223c9c7426
commit 929ab6b289
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 5 additions and 0 deletions

View File

@ -28,6 +28,7 @@ const (
DefaultMetricsUpdateFreqMillis = 15000
)
// LoggerIFace should be abbreviated as `logger`.
type LoggerIFace interface {
IsLevelEnabled(Level) bool
Trace(string, ...Field)
@ -169,6 +170,8 @@ func Map[M ~map[K]V, K comparable, V any](key string, val M) Field {
// so that there are no allocations on the heap each interface method invocation. Normally not
// something to be concerned about, but logging calls for disabled levels should have as little CPU
// and memory impact as possible. Most of these wrapper calls will be inlined as well.
//
// Logger should be abbreviated as `logger`.
type Logger struct {
log *logr.Logger
lockConfig *int32

View File

@ -12,6 +12,7 @@ import (
"github.com/mattermost/mattermost/server/public/shared/mlog"
)
// Context should be abbreviated as `rctx`.
type Context struct {
t i18n.TranslateFunc
session model.Session
@ -148,6 +149,7 @@ func (c *Context) With(f func(ctx CTX) CTX) CTX {
return f(c)
}
// CTX should be abbreviated as `rctx`.
type CTX interface {
T(string, ...interface{}) string
GetT() i18n.TranslateFunc