// Copyright (c) 2015-2024 MinIO, Inc. // // This file is part of MinIO Object Storage stack // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU Affero General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Affero General Public License for more details. // // You should have received a copy of the GNU Affero General Public License // along with this program. If not, see . package cmd import ( "container/ring" "context" "io" "sync" "sync/atomic" "github.com/minio/madmin-go/v3" "github.com/minio/minio/internal/logger" "github.com/minio/minio/internal/logger/target/console" "github.com/minio/minio/internal/logger/target/types" "github.com/minio/minio/internal/pubsub" "github.com/minio/pkg/v2/logger/message/log" xnet "github.com/minio/pkg/v2/net" ) // number of log messages to buffer const defaultLogBufferCount = 10000 // HTTPConsoleLoggerSys holds global console logger state type HTTPConsoleLoggerSys struct { totalMessages int64 failedMessages int64 sync.RWMutex pubsub *pubsub.PubSub[log.Info, madmin.LogMask] console *console.Target nodeName string logBuf *ring.Ring } // NewConsoleLogger - creates new HTTPConsoleLoggerSys with all nodes subscribed to // the console logging pub sub system func NewConsoleLogger(ctx context.Context, w io.Writer) *HTTPConsoleLoggerSys { return &HTTPConsoleLoggerSys{ pubsub: pubsub.New[log.Info, madmin.LogMask](8), console: console.New(w), logBuf: ring.New(defaultLogBufferCount), } } // IsOnline always true in case of console logger func (sys *HTTPConsoleLoggerSys) IsOnline(_ context.Context) bool { return true } // SetNodeName - sets the node name if any after distributed setup has initialized func (sys *HTTPConsoleLoggerSys) SetNodeName(nodeName string) { if !globalIsDistErasure { sys.nodeName = "" return } host, err := xnet.ParseHost(globalLocalNodeName) if err != nil { logger.FatalIf(err, "Unable to start console logging subsystem") } sys.nodeName = host.Name } // HasLogListeners returns true if console log listeners are registered // for this node or peers func (sys *HTTPConsoleLoggerSys) HasLogListeners() bool { return sys != nil && sys.pubsub.Subscribers() > 0 } // Subscribe starts console logging for this node. func (sys *HTTPConsoleLoggerSys) Subscribe(subCh chan log.Info, doneCh <-chan struct{}, node string, last int, logKind madmin.LogMask, filter func(entry log.Info) bool) error { // Enable console logging for remote client. if !sys.HasLogListeners() { logger.AddSystemTarget(GlobalContext, sys) } cnt := 0 // by default send all console logs in the ring buffer unless node or limit query parameters // are set. var lastN []log.Info if last > defaultLogBufferCount || last <= 0 { last = defaultLogBufferCount } lastN = make([]log.Info, last) sys.RLock() sys.logBuf.Do(func(p interface{}) { if p != nil { lg, ok := p.(log.Info) if ok && lg.SendLog(node, logKind) { lastN[cnt%last] = lg cnt++ } } }) sys.RUnlock() // send last n console log messages in order filtered by node if cnt > 0 { for i := 0; i < last; i++ { entry := lastN[(cnt+i)%last] if (entry == log.Info{}) { continue } select { case subCh <- entry: case <-doneCh: return nil } } } return sys.pubsub.Subscribe(madmin.LogMaskAll, subCh, doneCh, filter) } // Init if HTTPConsoleLoggerSys is valid, always returns nil right now func (sys *HTTPConsoleLoggerSys) Init(_ context.Context) error { return nil } // Endpoint - dummy function for interface compatibility func (sys *HTTPConsoleLoggerSys) Endpoint() string { return sys.console.Endpoint() } // String - stringer function for interface compatibility func (sys *HTTPConsoleLoggerSys) String() string { return logger.ConsoleLoggerTgt } // Stats returns the target statistics. func (sys *HTTPConsoleLoggerSys) Stats() types.TargetStats { return types.TargetStats{ TotalMessages: atomic.LoadInt64(&sys.totalMessages), FailedMessages: atomic.LoadInt64(&sys.failedMessages), QueueLength: 0, } } // Content returns the console stdout log func (sys *HTTPConsoleLoggerSys) Content() (logs []log.Entry) { sys.RLock() sys.logBuf.Do(func(p interface{}) { if p != nil { lg, ok := p.(log.Info) if ok { if (lg.Entry != log.Entry{}) { logs = append(logs, lg.Entry) } } } }) sys.RUnlock() return } // Cancel - cancels the target func (sys *HTTPConsoleLoggerSys) Cancel() { } // Type - returns type of the target func (sys *HTTPConsoleLoggerSys) Type() types.TargetType { return types.TargetConsole } // Send log message 'e' to console and publish to console // log pubsub system func (sys *HTTPConsoleLoggerSys) Send(ctx context.Context, entry interface{}) error { var lg log.Info switch e := entry.(type) { case log.Entry: lg = log.Info{Entry: e, NodeName: sys.nodeName} case string: lg = log.Info{ConsoleMsg: e, NodeName: sys.nodeName} } atomic.AddInt64(&sys.totalMessages, 1) sys.pubsub.Publish(lg) sys.Lock() // add log to ring buffer sys.logBuf.Value = lg sys.logBuf = sys.logBuf.Next() sys.Unlock() err := sys.console.Send(entry) if err != nil { atomic.AddInt64(&sys.failedMessages, 1) } return err }