github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/query/storage/options.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 storage
    22  
    23  import (
    24  	"time"
    25  
    26  	xtime "github.com/m3db/m3/src/x/time"
    27  )
    28  
    29  const (
    30  	defaultResolutionThresholdForCounterNormalization = 5 * time.Minute
    31  )
    32  
    33  type promConvertOptions struct {
    34  	resolutionThresholdForCounterNormalization time.Duration
    35  
    36  	valueDecreaseTolerance      float64
    37  	valueDecreaseToleranceUntil xtime.UnixNano
    38  }
    39  
    40  // NewPromConvertOptions builds a new PromConvertOptions with default values.
    41  func NewPromConvertOptions() PromConvertOptions {
    42  	return &promConvertOptions{
    43  		resolutionThresholdForCounterNormalization: defaultResolutionThresholdForCounterNormalization,
    44  	}
    45  }
    46  
    47  func (o *promConvertOptions) SetResolutionThresholdForCounterNormalization(value time.Duration) PromConvertOptions {
    48  	opts := *o
    49  	opts.resolutionThresholdForCounterNormalization = value
    50  	return &opts
    51  }
    52  
    53  func (o *promConvertOptions) ResolutionThresholdForCounterNormalization() time.Duration {
    54  	return o.resolutionThresholdForCounterNormalization
    55  }
    56  
    57  func (o *promConvertOptions) SetValueDecreaseTolerance(value float64) PromConvertOptions {
    58  	opts := *o
    59  	opts.valueDecreaseTolerance = value
    60  	return &opts
    61  }
    62  
    63  func (o *promConvertOptions) ValueDecreaseTolerance() float64 {
    64  	return o.valueDecreaseTolerance
    65  }
    66  
    67  func (o *promConvertOptions) SetValueDecreaseToleranceUntil(value xtime.UnixNano) PromConvertOptions {
    68  	opts := *o
    69  	opts.valueDecreaseToleranceUntil = value
    70  	return &opts
    71  }
    72  
    73  func (o *promConvertOptions) ValueDecreaseToleranceUntil() xtime.UnixNano {
    74  	return o.valueDecreaseToleranceUntil
    75  }