github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/x/instrument/logging.go (about)

     1  // Copyright (c) 2019 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 instrument
    22  
    23  import (
    24  	"testing"
    25  
    26  	"github.com/stretchr/testify/require"
    27  	"go.uber.org/zap"
    28  	"go.uber.org/zap/zapcore"
    29  )
    30  
    31  // NewTestDebugLogger returns a new debug logger for tests.
    32  func NewTestDebugLogger(t *testing.T) *zap.Logger {
    33  	loggerConfig := zap.NewDevelopmentConfig()
    34  	loggerConfig.Level = zap.NewAtomicLevelAt(zapcore.DebugLevel)
    35  	logger, err := loggerConfig.Build()
    36  	require.NoError(t, err)
    37  	return logger
    38  }
    39  
    40  // NewTestOptions returns a set of instrument options useful for
    41  // tests. This includes:
    42  // - Logger built using development config with debug level set.
    43  func NewTestOptions(t *testing.T) Options {
    44  	logger := NewTestDebugLogger(t)
    45  	return NewOptions().SetLogger(logger)
    46  }