github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/storage/limits/source_logger.go (about)

     1  // Copyright (c) 2020 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package limits
    22  
    23  import (
    24  	"fmt"
    25  
    26  	"go.uber.org/zap"
    27  	"go.uber.org/zap/zapcore"
    28  
    29  	"github.com/m3db/m3/src/x/instrument"
    30  )
    31  
    32  // NB: log queries that are over 1 GB.
    33  const defaultLimit = 1024 * 1024 * 1024
    34  
    35  type sourceLoggerBuilder struct{}
    36  
    37  var _ SourceLoggerBuilder = (*sourceLoggerBuilder)(nil)
    38  
    39  func (s *sourceLoggerBuilder) NewSourceLogger(
    40  	name string,
    41  	iOpts instrument.Options,
    42  ) SourceLogger {
    43  	var (
    44  		logger   = iOpts.Logger()
    45  		debugLog = logger.Check(zapcore.DebugLevel, fmt.Sprint("source logger for", name))
    46  	)
    47  
    48  	if debugLog == nil {
    49  		// NB: use empty logger.
    50  		return &sourceLogger{}
    51  	}
    52  
    53  	return &sourceLogger{logger: logger.With(zap.String("limit_name", name))}
    54  }
    55  
    56  type sourceLogger struct {
    57  	logger *zap.Logger
    58  }
    59  
    60  var _ SourceLogger = (*sourceLogger)(nil)
    61  
    62  func (l *sourceLogger) LogSourceValue(val int64, source []byte) {
    63  	if l.logger == nil || val < defaultLimit || len(source) == 0 {
    64  		// NB: Don't log each source as it would be very noisy, even at debug level.
    65  		return
    66  	}
    67  
    68  	l.logger.Debug("query from source exceeded size",
    69  		zap.ByteString("source", source),
    70  		zap.Int64("size", val),
    71  		zap.Int64("limit", defaultLimit))
    72  }