github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/metrics/matcher/cache/config.go (about)

     1  // Copyright (c) 2017 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 cache
    22  
    23  import (
    24  	"time"
    25  
    26  	"github.com/m3db/m3/src/x/clock"
    27  	"github.com/m3db/m3/src/x/instrument"
    28  )
    29  
    30  // Configuration is config used to create a Cache.
    31  type Configuration struct {
    32  	Capacity          int           `yaml:"capacity"`
    33  	FreshDuration     time.Duration `yaml:"freshDuration"`
    34  	StutterDuration   time.Duration `yaml:"stutterDuration"`
    35  	EvictionBatchSize int           `yaml:"evictionBatchSize"`
    36  	DeletionBatchSize int           `yaml:"deletionBatchSize"`
    37  }
    38  
    39  // NewCache creates a Cache.
    40  func (cfg *Configuration) NewCache(
    41  	clockOpts clock.Options,
    42  	instrumentOpts instrument.Options,
    43  ) Cache {
    44  	opts := NewOptions().
    45  		SetClockOptions(clockOpts).
    46  		SetInstrumentOptions(instrumentOpts)
    47  	if cfg.Capacity != 0 {
    48  		opts = opts.SetCapacity(cfg.Capacity)
    49  	}
    50  	if cfg.FreshDuration != 0 {
    51  		opts = opts.SetFreshDuration(cfg.FreshDuration)
    52  	}
    53  	if cfg.StutterDuration != 0 {
    54  		opts = opts.SetStutterDuration(cfg.StutterDuration)
    55  	}
    56  	if cfg.EvictionBatchSize != 0 {
    57  		opts = opts.SetEvictionBatchSize(cfg.EvictionBatchSize)
    58  	}
    59  	if cfg.DeletionBatchSize != 0 {
    60  		opts = opts.SetDeletionBatchSize(cfg.DeletionBatchSize)
    61  	}
    62  
    63  	return NewCache(opts)
    64  }