Files
pdoernerandGitHub 065c83f8ec Prioritize UI/tctl when system is throttled (#4623)
<!-- 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
2023-07-18 09:50:46 -07:00

128 lines
4.5 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 worker
import (
"go.uber.org/fx"
"go.temporal.io/server/common/config"
"go.temporal.io/server/common/dynamicconfig"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/metrics"
"go.temporal.io/server/common/persistence/visibility"
"go.temporal.io/server/common/persistence/visibility/manager"
esclient "go.temporal.io/server/common/persistence/visibility/store/elasticsearch/client"
"go.temporal.io/server/common/resolver"
"go.temporal.io/server/common/resource"
"go.temporal.io/server/common/searchattribute"
"go.temporal.io/server/service"
"go.temporal.io/server/service/worker/addsearchattributes"
"go.temporal.io/server/service/worker/batcher"
"go.temporal.io/server/service/worker/deletenamespace"
"go.temporal.io/server/service/worker/migration"
"go.temporal.io/server/service/worker/scheduler"
)
var Module = fx.Options(
migration.Module,
addsearchattributes.Module,
resource.Module,
deletenamespace.Module,
scheduler.Module,
batcher.Module,
fx.Provide(VisibilityManagerProvider),
fx.Provide(dynamicconfig.NewCollection),
fx.Provide(ThrottledLoggerRpsFnProvider),
fx.Provide(ConfigProvider),
fx.Provide(PersistenceRateLimitingParamsProvider),
fx.Provide(NewService),
fx.Provide(NewWorkerManager),
fx.Provide(NewPerNamespaceWorkerManager),
fx.Invoke(ServiceLifetimeHooks),
)
func ThrottledLoggerRpsFnProvider(serviceConfig *Config) resource.ThrottledLoggerRpsFn {
return func() float64 { return float64(serviceConfig.ThrottledLogRPS()) }
}
func PersistenceRateLimitingParamsProvider(
serviceConfig *Config,
) service.PersistenceRateLimitingParams {
return service.NewPersistenceRateLimitingParams(
serviceConfig.PersistenceMaxQPS,
serviceConfig.PersistenceGlobalMaxQPS,
serviceConfig.PersistenceNamespaceMaxQPS,
serviceConfig.PersistencePerShardNamespaceMaxQPS,
serviceConfig.EnablePersistencePriorityRateLimiting,
serviceConfig.OperatorRPSRatio,
serviceConfig.PersistenceDynamicRateLimitingParams,
)
}
func ConfigProvider(
dc *dynamicconfig.Collection,
persistenceConfig *config.Persistence,
) *Config {
return NewConfig(
dc,
persistenceConfig,
persistenceConfig.StandardVisibilityConfigExist(),
persistenceConfig.AdvancedVisibilityConfigExist(),
)
}
func VisibilityManagerProvider(
logger log.Logger,
metricsHandler metrics.Handler,
persistenceConfig *config.Persistence,
serviceConfig *Config,
esClient esclient.Client,
persistenceServiceResolver resolver.ServiceResolver,
searchAttributesMapperProvider searchattribute.MapperProvider,
saProvider searchattribute.Provider,
) (manager.VisibilityManager, error) {
return visibility.NewManager(
*persistenceConfig,
persistenceServiceResolver,
esClient,
nil, // worker visibility never write
saProvider,
searchAttributesMapperProvider,
serviceConfig.VisibilityPersistenceMaxReadQPS,
serviceConfig.VisibilityPersistenceMaxWriteQPS,
serviceConfig.OperatorRPSRatio,
serviceConfig.EnableReadFromSecondaryVisibility,
dynamicconfig.GetStringPropertyFn(visibility.SecondaryVisibilityWritingModeOff), // worker visibility never write
serviceConfig.VisibilityDisableOrderByClause,
serviceConfig.VisibilityEnableManualPagination,
metricsHandler,
logger,
)
}
func ServiceLifetimeHooks(lc fx.Lifecycle, svc *Service) {
lc.Append(fx.StartStopHook(svc.Start, svc.Stop))
}