go.temporal.io/server@v1.23.0/common/persistence/client/quotas.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 client

import (
	"go.temporal.io/server/common/headers"
	"go.temporal.io/server/common/log"
	"go.temporal.io/server/common/metrics"
	p "go.temporal.io/server/common/persistence"
	"go.temporal.io/server/common/quotas"
	"go.temporal.io/server/service/history/tasks"
)

type (
	perShardPerNamespaceKey struct {
		namespaceID string
		shardID     int32
	}
)

var (
	CallerTypeDefaultPriority = map[string]int{
		headers.CallerTypeOperator:    0,
		headers.CallerTypeAPI:         2,
		headers.CallerTypeBackground:  4,
		headers.CallerTypePreemptable: 5,
	}

	APITypeCallOriginPriorityOverride = map[string]int{
		"StartWorkflowExecution":           1,
		"SignalWithStartWorkflowExecution": 1,
		"SignalWorkflowExecution":          1,
		"RequestCancelWorkflowExecution":   1,
		"TerminateWorkflowExecution":       1,
		"GetWorkflowExecutionHistory":      1,
		"UpdateWorkflowExecution":          1,
	}

	BackgroundTypeAPIPriorityOverride = map[string]int{
		"GetOrCreateShard": 1,
		"UpdateShard":      1,

		// This is a preprequisite for checkpointing queue process progress
		p.ConstructHistoryTaskAPI("RangeCompleteHistoryTasks", tasks.CategoryTransfer):   1,
		p.ConstructHistoryTaskAPI("RangeCompleteHistoryTasks", tasks.CategoryTimer):      1,
		p.ConstructHistoryTaskAPI("RangeCompleteHistoryTasks", tasks.CategoryVisibility): 1,

		// Task resource isolation assumes task can always be loaded.
		// When one namespace has high load, all task processing goroutines
		// may be busy and consumes all persistence request tokens, preventing
		// tasks for other namespaces to be loaded. So give task loading a higher
		// priority than other background requests.
		// NOTE: we also don't want task loading to consume all persistence request tokens,
		// and blocks all other operations. This is done by setting the queue host rps limit
		// dynamic config.
		p.ConstructHistoryTaskAPI("GetHistoryTasks", tasks.CategoryTransfer):   3,
		p.ConstructHistoryTaskAPI("GetHistoryTasks", tasks.CategoryTimer):      3,
		p.ConstructHistoryTaskAPI("GetHistoryTasks", tasks.CategoryVisibility): 3,
	}

	RequestPrioritiesOrdered = []int{0, 1, 2, 3, 4, 5}
)

func NewPriorityRateLimiter(
	namespaceMaxQPS PersistenceNamespaceMaxQps,
	hostMaxQPS PersistenceMaxQps,
	perShardNamespaceMaxQPS PersistencePerShardNamespaceMaxQPS,
	requestPriorityFn quotas.RequestPriorityFn,
	operatorRPSRatio OperatorRPSRatio,
	healthSignals p.HealthSignalAggregator,
	dynamicParams DynamicRateLimitingParams,
	metricsHandler metrics.Handler,
	logger log.Logger,
) quotas.RequestRateLimiter {
	hostRateFn := func() float64 { return float64(hostMaxQPS()) }

	return quotas.NewMultiRequestRateLimiter(
		// per shardID+namespaceID rate limiters
		newPerShardPerNamespacePriorityRateLimiter(perShardNamespaceMaxQPS, hostMaxQPS, requestPriorityFn, operatorRPSRatio),
		// per namespaceID rate limiters
		newPriorityNamespaceRateLimiter(namespaceMaxQPS, hostMaxQPS, requestPriorityFn, operatorRPSRatio),
		// host-level dynamic rate limiter
		newPriorityDynamicRateLimiter(hostRateFn, requestPriorityFn, operatorRPSRatio, healthSignals, dynamicParams, metricsHandler, logger),
		// basic host-level rate limiter
		newPriorityRateLimiter(hostRateFn, requestPriorityFn, operatorRPSRatio),
	)
}

func newPerShardPerNamespacePriorityRateLimiter(
	perShardNamespaceMaxQPS PersistencePerShardNamespaceMaxQPS,
	hostMaxQPS PersistenceMaxQps,
	requestPriorityFn quotas.RequestPriorityFn,
	operatorRPSRatio OperatorRPSRatio,
) quotas.RequestRateLimiter {
	return quotas.NewMapRequestRateLimiter(func(req quotas.Request) quotas.RequestRateLimiter {
		if hasCaller(req) && hasCallerSegment(req) {
			return newPriorityRateLimiter(func() float64 {
				if perShardNamespaceMaxQPS == nil || perShardNamespaceMaxQPS(req.Caller) <= 0 {
					return float64(hostMaxQPS())
				}
				return float64(perShardNamespaceMaxQPS(req.Caller))
			},
				requestPriorityFn,
				operatorRPSRatio,
			)
		}
		return quotas.NoopRequestRateLimiter
	},
		perShardPerNamespaceKeyFn,
	)
}

func perShardPerNamespaceKeyFn(req quotas.Request) perShardPerNamespaceKey {
	return perShardPerNamespaceKey{
		namespaceID: req.Caller,
		shardID:     req.CallerSegment,
	}
}

func newPriorityNamespaceRateLimiter(
	namespaceMaxQPS PersistenceNamespaceMaxQps,
	hostMaxQPS PersistenceMaxQps,
	requestPriorityFn quotas.RequestPriorityFn,
	operatorRPSRatio OperatorRPSRatio,
) quotas.RequestRateLimiter {
	return quotas.NewNamespaceRequestRateLimiter(func(req quotas.Request) quotas.RequestRateLimiter {
		if hasCaller(req) {
			return newPriorityRateLimiter(
				func() float64 {
					if namespaceMaxQPS == nil {
						return float64(hostMaxQPS())
					}

					namespaceQPS := float64(namespaceMaxQPS(req.Caller))
					if namespaceQPS <= 0 {
						return float64(hostMaxQPS())
					}

					return namespaceQPS
				},
				requestPriorityFn,
				operatorRPSRatio,
			)
		}
		return quotas.NoopRequestRateLimiter
	})
}

func newPriorityRateLimiter(
	rateFn quotas.RateFn,
	requestPriorityFn quotas.RequestPriorityFn,
	operatorRPSRatio OperatorRPSRatio,
) quotas.RequestRateLimiter {
	rateLimiters := make(map[int]quotas.RequestRateLimiter)
	for priority := range RequestPrioritiesOrdered {
		if priority == CallerTypeDefaultPriority[headers.CallerTypeOperator] {
			rateLimiters[priority] = quotas.NewRequestRateLimiterAdapter(quotas.NewDefaultOutgoingRateLimiter(operatorRateFn(rateFn, operatorRPSRatio)))
		} else {
			rateLimiters[priority] = quotas.NewRequestRateLimiterAdapter(quotas.NewDefaultOutgoingRateLimiter(rateFn))
		}
	}

	return quotas.NewPriorityRateLimiter(
		requestPriorityFn,
		rateLimiters,
	)
}

func newPriorityDynamicRateLimiter(
	rateFn quotas.RateFn,
	requestPriorityFn quotas.RequestPriorityFn,
	operatorRPSRatio OperatorRPSRatio,
	healthSignals p.HealthSignalAggregator,
	dynamicParams DynamicRateLimitingParams,
	metricsHandler metrics.Handler,
	logger log.Logger,
) quotas.RequestRateLimiter {
	rateLimiters := make(map[int]quotas.RequestRateLimiter)
	for priority := range RequestPrioritiesOrdered {
		// TODO: refactor this so dynamic rate adjustment is global for all priorities
		if priority == CallerTypeDefaultPriority[headers.CallerTypeOperator] {
			rateLimiters[priority] = NewHealthRequestRateLimiterImpl(healthSignals, operatorRateFn(rateFn, operatorRPSRatio), dynamicParams, metricsHandler, logger)
		} else {
			rateLimiters[priority] = NewHealthRequestRateLimiterImpl(healthSignals, rateFn, dynamicParams, metricsHandler, logger)
		}
	}

	return quotas.NewPriorityRateLimiter(
		requestPriorityFn,
		rateLimiters,
	)
}

func NewNoopPriorityRateLimiter(
	maxQPS PersistenceMaxQps,
) quotas.RequestRateLimiter {
	priority := RequestPrioritiesOrdered[0]

	return quotas.NewPriorityRateLimiter(
		func(_ quotas.Request) int { return priority },
		map[int]quotas.RequestRateLimiter{
			priority: quotas.NewRequestRateLimiterAdapter(quotas.NewDefaultOutgoingRateLimiter(
				func() float64 { return float64(maxQPS()) },
			)),
		},
	)
}

func RequestPriorityFn(req quotas.Request) int {
	switch req.CallerType {
	case headers.CallerTypeOperator:
		return CallerTypeDefaultPriority[req.CallerType]
	case headers.CallerTypeAPI:
		if priority, ok := APITypeCallOriginPriorityOverride[req.Initiation]; ok {
			return priority
		}
		return CallerTypeDefaultPriority[req.CallerType]
	case headers.CallerTypeBackground:
		if priority, ok := BackgroundTypeAPIPriorityOverride[req.API]; ok {
			return priority
		}
		return CallerTypeDefaultPriority[req.CallerType]
	case headers.CallerTypePreemptable:
		return CallerTypeDefaultPriority[req.CallerType]
	default:
		// default requests to API priority to be consistent with existing behavior
		return CallerTypeDefaultPriority[headers.CallerTypeAPI]
	}
}

func operatorRateFn(rateFn quotas.RateFn, operatorRPSRatio OperatorRPSRatio) quotas.RateFn {
	return func() float64 {
		return operatorRPSRatio() * rateFn()
	}
}

func hasCaller(req quotas.Request) bool {
	return req.Caller != "" && req.Caller != headers.CallerNameSystem
}

func hasCallerSegment(req quotas.Request) bool {
	return req.CallerSegment > 0 && req.CallerSegment != p.CallerSegmentMissing
}