mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
<!-- Describe what has changed in this PR --> **What changed?** * Added a new possible value for the `caller-type` header: `operator` * This header should be set by web UI and tctl to indicate that requests should be given higher precedence * Rate limiters for persistence, history, matching, and visibility were updated with a new priority corresponding to `operator` requests * These new priorities have a lower RPS limit to prevent abusing the header to get high priority for all requests. Currently the operator priority is allowed 20% of the rate of the existing rate limiters <!-- Tell your future self why have you made these changes --> **Why?** When the system is being throttled, users would like to be able to debug using the web UI and/or tctl without running into rate limit errors <!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> **How did you test it?** New unit tests <!-- Assuming the worst case, what can be broken when deploying this change to production? --> **Potential risks** The operator RPS is set too low leading to new rate limit errors <!-- Is this PR a hotfix candidate or require that a notification be sent to the broader community? (Yes/No) --> **Is hotfix candidate?** No
74 lines
2.6 KiB
Go
74 lines
2.6 KiB
Go
// The MIT License
|
|
//
|
|
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
|
|
//
|
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
|
|
package visibility
|
|
|
|
import (
|
|
"go.temporal.io/server/common/dynamicconfig"
|
|
"go.temporal.io/server/common/headers"
|
|
"go.temporal.io/server/common/quotas"
|
|
)
|
|
|
|
const (
|
|
// OperatorPriority is used to give precedence to calls coming from web UI or tctl
|
|
OperatorPriority = 0
|
|
)
|
|
|
|
var (
|
|
PrioritiesOrdered = []int{OperatorPriority, 1}
|
|
)
|
|
|
|
func newPriorityRateLimiter(
|
|
maxQPS dynamicconfig.IntPropertyFn,
|
|
operatorRPSRatio dynamicconfig.FloatPropertyFn,
|
|
) quotas.RequestRateLimiter {
|
|
rateLimiters := make(map[int]quotas.RequestRateLimiter)
|
|
for priority := range PrioritiesOrdered {
|
|
if priority == OperatorPriority {
|
|
rateLimiters[priority] = quotas.NewRequestRateLimiterAdapter(quotas.NewDefaultOutgoingRateLimiter(operatorRateFn(maxQPS, operatorRPSRatio)))
|
|
} else {
|
|
rateLimiters[priority] = quotas.NewRequestRateLimiterAdapter(quotas.NewDefaultOutgoingRateLimiter(rateFn(maxQPS)))
|
|
}
|
|
}
|
|
return quotas.NewPriorityRateLimiter(func(req quotas.Request) int {
|
|
if req.CallerType == headers.CallerTypeOperator {
|
|
return OperatorPriority
|
|
}
|
|
// default to lowest priority
|
|
return PrioritiesOrdered[len(PrioritiesOrdered)-1]
|
|
}, rateLimiters)
|
|
}
|
|
|
|
func rateFn(maxQPS dynamicconfig.IntPropertyFn) quotas.RateFn {
|
|
return func() float64 {
|
|
return float64(maxQPS())
|
|
}
|
|
}
|
|
|
|
func operatorRateFn(maxQPS dynamicconfig.IntPropertyFn, operatorRPSRatio dynamicconfig.FloatPropertyFn) quotas.RateFn {
|
|
return func() float64 {
|
|
return float64(maxQPS()) * operatorRPSRatio()
|
|
}
|
|
}
|