mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
d4ec8a178f
## What changed? Changing rate limiters to return resource scope in ResourceExhausted errors. ResourceScope is a new field added to ResourceExhaustedFailure to specify if the namespace level or system level resource is exhausted. Also added this field to other ResourceExhausted errors. ## Why? We need to differentiate whether a request has been rate-limited because of namespace limit or system limit. This will help us better understand why requests are rate-limited and which limits to adjust. ## How did you test it? Unit tests. Will add more tests for persistence rate-limited clients. ## Potential risk None ## Documentation ## Is hotfix candidate? No --------- Co-authored-by: Tim Deeb-Swihart <[email protected]>
106 lines
3.0 KiB
Go
106 lines
3.0 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 interceptor
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
enumspb "go.temporal.io/api/enums/v1"
|
|
"go.temporal.io/api/serviceerror"
|
|
"go.temporal.io/server/common/headers"
|
|
"google.golang.org/grpc"
|
|
"google.golang.org/grpc/metadata"
|
|
|
|
"go.temporal.io/server/common/quotas"
|
|
)
|
|
|
|
const (
|
|
RateLimitDefaultToken = 1
|
|
)
|
|
|
|
var (
|
|
RateLimitServerBusy = &serviceerror.ResourceExhausted{
|
|
Cause: enumspb.RESOURCE_EXHAUSTED_CAUSE_RPS_LIMIT,
|
|
Scope: enumspb.RESOURCE_EXHAUSTED_SCOPE_SYSTEM,
|
|
Message: "service rate limit exceeded",
|
|
}
|
|
)
|
|
|
|
type (
|
|
RateLimitInterceptor struct {
|
|
rateLimiter quotas.RequestRateLimiter
|
|
tokens map[string]int
|
|
}
|
|
)
|
|
|
|
var _ grpc.UnaryServerInterceptor = (*RateLimitInterceptor)(nil).Intercept
|
|
|
|
func NewRateLimitInterceptor(
|
|
rateLimiter quotas.RequestRateLimiter,
|
|
tokens map[string]int,
|
|
) *RateLimitInterceptor {
|
|
return &RateLimitInterceptor{
|
|
rateLimiter: rateLimiter,
|
|
tokens: tokens,
|
|
}
|
|
}
|
|
|
|
func (i *RateLimitInterceptor) Intercept(
|
|
ctx context.Context,
|
|
req interface{},
|
|
info *grpc.UnaryServerInfo,
|
|
handler grpc.UnaryHandler,
|
|
) (interface{}, error) {
|
|
md, _ := metadata.FromIncomingContext(ctx)
|
|
if err := i.Allow(info.FullMethod, headers.GRPCHeaderGetter{Metadata: md}); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return handler(ctx, req)
|
|
}
|
|
|
|
func (i *RateLimitInterceptor) Allow(
|
|
methodName string,
|
|
headerGetter headers.HeaderGetter,
|
|
) error {
|
|
token, ok := i.tokens[methodName]
|
|
if !ok {
|
|
token = RateLimitDefaultToken
|
|
}
|
|
|
|
if !i.rateLimiter.Allow(time.Now().UTC(), quotas.NewRequest(
|
|
methodName,
|
|
token,
|
|
"", // this interceptor layer does not throttle based on caller name
|
|
headerGetter.Get(headers.CallerTypeHeaderName),
|
|
0, // this interceptor layer does not throttle based on caller segment
|
|
"", // this interceptor layer does not throttle based on call initiation
|
|
)) {
|
|
return RateLimitServerBusy
|
|
}
|
|
return nil
|
|
}
|