go.temporal.io/server@v1.23.0/common/persistence/visibility/quotas.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
     4  //
     5  // Copyright (c) 2020 Uber Technologies, Inc.
     6  //
     7  // Permission is hereby granted, free of charge, to any person obtaining a copy
     8  // of this software and associated documentation files (the "Software"), to deal
     9  // in the Software without restriction, including without limitation the rights
    10  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    11  // copies of the Software, and to permit persons to whom the Software is
    12  // furnished to do so, subject to the following conditions:
    13  //
    14  // The above copyright notice and this permission notice shall be included in
    15  // all copies or substantial portions of the Software.
    16  //
    17  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    18  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    19  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    20  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    21  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    22  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    23  // THE SOFTWARE.
    24  
    25  package visibility
    26  
    27  import (
    28  	"go.temporal.io/server/common/dynamicconfig"
    29  	"go.temporal.io/server/common/headers"
    30  	"go.temporal.io/server/common/quotas"
    31  )
    32  
    33  const (
    34  	// OperatorPriority is used to give precedence to calls coming from web UI or tctl
    35  	OperatorPriority = 0
    36  )
    37  
    38  var (
    39  	PrioritiesOrdered = []int{OperatorPriority, 1}
    40  )
    41  
    42  func newPriorityRateLimiter(
    43  	maxQPS dynamicconfig.IntPropertyFn,
    44  	operatorRPSRatio dynamicconfig.FloatPropertyFn,
    45  ) quotas.RequestRateLimiter {
    46  	rateLimiters := make(map[int]quotas.RequestRateLimiter)
    47  	for priority := range PrioritiesOrdered {
    48  		if priority == OperatorPriority {
    49  			rateLimiters[priority] = quotas.NewRequestRateLimiterAdapter(quotas.NewDefaultOutgoingRateLimiter(operatorRateFn(maxQPS, operatorRPSRatio)))
    50  		} else {
    51  			rateLimiters[priority] = quotas.NewRequestRateLimiterAdapter(quotas.NewDefaultOutgoingRateLimiter(rateFn(maxQPS)))
    52  		}
    53  	}
    54  	return quotas.NewPriorityRateLimiter(func(req quotas.Request) int {
    55  		if req.CallerType == headers.CallerTypeOperator {
    56  			return OperatorPriority
    57  		}
    58  		// default to lowest priority
    59  		return PrioritiesOrdered[len(PrioritiesOrdered)-1]
    60  	}, rateLimiters)
    61  }
    62  
    63  func rateFn(maxQPS dynamicconfig.IntPropertyFn) quotas.RateFn {
    64  	return func() float64 {
    65  		return float64(maxQPS())
    66  	}
    67  }
    68  
    69  func operatorRateFn(maxQPS dynamicconfig.IntPropertyFn, operatorRPSRatio dynamicconfig.FloatPropertyFn) quotas.RateFn {
    70  	return func() float64 {
    71  		return float64(maxQPS()) * operatorRPSRatio()
    72  	}
    73  }