mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
bb11365e96
Loggers that implement BufSize() (e.g. awslogs) uses the method to tell Copier about the maximum log line length. However loggerWithCache and RingBuffer hide the method by wrapping loggers. As a result, Copier uses its default 16KB limit which breaks log lines > 16kB even the destinations can handle that. This change implements BufSize() on loggerWithCache and RingBuffer to make sure these logger wrappes don't hide the method on the underlying loggers. Fixes #41794. Signed-off-by: Kazuyoshi Kato <katokazu@amazon.com>
121 lines
3.1 KiB
Go
121 lines
3.1 KiB
Go
package cache // import "github.com/docker/docker/daemon/logger/loggerutils/cache"
|
|
|
|
import (
|
|
"strconv"
|
|
|
|
"github.com/docker/docker/api/types/container"
|
|
"github.com/docker/docker/daemon/logger"
|
|
"github.com/docker/docker/daemon/logger/local"
|
|
units "github.com/docker/go-units"
|
|
"github.com/pkg/errors"
|
|
"github.com/sirupsen/logrus"
|
|
)
|
|
|
|
const (
|
|
// DriverName is the name of the driver used for local log caching
|
|
DriverName = local.Name
|
|
|
|
cachePrefix = "cache-"
|
|
cacheDisabledKey = cachePrefix + "disabled"
|
|
)
|
|
|
|
var builtInCacheLogOpts = map[string]bool{
|
|
cacheDisabledKey: true,
|
|
}
|
|
|
|
// WithLocalCache wraps the passed in logger with a logger caches all writes locally
|
|
// in addition to writing to the passed in logger.
|
|
func WithLocalCache(l logger.Logger, info logger.Info) (logger.Logger, error) {
|
|
initLogger, err := logger.GetLogDriver(DriverName)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
cacher, err := initLogger(info)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "error initializing local log cache driver")
|
|
}
|
|
|
|
if info.Config["mode"] == container.LogModeUnset || container.LogMode(info.Config["mode"]) == container.LogModeNonBlock {
|
|
var size int64 = -1
|
|
if s, exists := info.Config["max-buffer-size"]; exists {
|
|
size, err = units.RAMInBytes(s)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
cacher = logger.NewRingLogger(cacher, info, size)
|
|
}
|
|
|
|
return &loggerWithCache{
|
|
l: l,
|
|
cache: cacher,
|
|
}, nil
|
|
}
|
|
|
|
type loggerWithCache struct {
|
|
l logger.Logger
|
|
cache logger.Logger
|
|
}
|
|
|
|
var _ logger.SizedLogger = &loggerWithCache{}
|
|
|
|
// BufSize returns the buffer size of the underlying logger.
|
|
// Returns -1 if the logger doesn't match SizedLogger interface.
|
|
func (l *loggerWithCache) BufSize() int {
|
|
if sl, ok := l.l.(logger.SizedLogger); ok {
|
|
return sl.BufSize()
|
|
}
|
|
return -1
|
|
}
|
|
|
|
func (l *loggerWithCache) Log(msg *logger.Message) error {
|
|
// copy the message as the original will be reset once the call to `Log` is complete
|
|
dup := logger.NewMessage()
|
|
dumbCopyMessage(dup, msg)
|
|
|
|
if err := l.l.Log(msg); err != nil {
|
|
return err
|
|
}
|
|
return l.cache.Log(dup)
|
|
}
|
|
|
|
func (l *loggerWithCache) Name() string {
|
|
return l.l.Name()
|
|
}
|
|
|
|
func (l *loggerWithCache) ReadLogs(config logger.ReadConfig) *logger.LogWatcher {
|
|
return l.cache.(logger.LogReader).ReadLogs(config)
|
|
}
|
|
|
|
func (l *loggerWithCache) Close() error {
|
|
err := l.l.Close()
|
|
if err := l.cache.Close(); err != nil {
|
|
logrus.WithError(err).Warn("error while shutting cache logger")
|
|
}
|
|
return err
|
|
}
|
|
|
|
// ShouldUseCache reads the log opts to determine if caching should be enabled
|
|
func ShouldUseCache(cfg map[string]string) bool {
|
|
if cfg[cacheDisabledKey] == "" {
|
|
return true
|
|
}
|
|
b, err := strconv.ParseBool(cfg[cacheDisabledKey])
|
|
if err != nil {
|
|
// This shouldn't happen since the values are validated before hand.
|
|
return false
|
|
}
|
|
return !b
|
|
}
|
|
|
|
// dumbCopyMessage is a bit of a fake copy but avoids extra allocations which
|
|
// are not necessary for this use case.
|
|
func dumbCopyMessage(dst, src *logger.Message) {
|
|
dst.Source = src.Source
|
|
dst.Timestamp = src.Timestamp
|
|
dst.PLogMetaData = src.PLogMetaData
|
|
dst.Err = src.Err
|
|
dst.Attrs = src.Attrs
|
|
dst.Line = append(dst.Line[:0], src.Line...)
|
|
}
|