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

     1  // Copyright (c) 2021 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  	"go.uber.org/zap"
    25  )
    26  
    27  // WithOptions creates a new instrument options with options.
    28  func WithOptions(iOpts Options, opts ...Option) Options {
    29  	ptr := &iOpts
    30  	for _, opt := range opts {
    31  		opt(ptr)
    32  	}
    33  	return *ptr
    34  }
    35  
    36  // Option applys optional settings to the instrument options.
    37  type Option func(*Options)
    38  
    39  // WithScopeAndLoggerTagged tags both the metric scope and logger in the
    40  // instrument options.
    41  func WithScopeAndLoggerTagged(k, v string) Option {
    42  	return func(ptr *Options) {
    43  		WithScopeTagged(k, v)(ptr)
    44  		WithLoggerTagged(k, v)(ptr)
    45  	}
    46  }
    47  
    48  // WithScopeTagged tags the metric scope in the instrument options.
    49  func WithScopeTagged(k, v string) Option {
    50  	return func(ptr *Options) {
    51  		iOpts := *ptr
    52  		iOpts = iOpts.SetMetricsScope(iOpts.MetricsScope().Tagged(map[string]string{k: v}))
    53  		*ptr = iOpts
    54  	}
    55  }
    56  
    57  // WithLoggerTagged tags the logger in the instrument options.
    58  func WithLoggerTagged(k, v string) Option {
    59  	return func(ptr *Options) {
    60  		iOpts := *ptr
    61  		iOpts = iOpts.SetLogger(iOpts.Logger().With(zap.String(k, v)))
    62  		*ptr = iOpts
    63  	}
    64  }