blob: 196ed69cacae0f7dbd625d805e8207409650f8b3 [file] [log] [blame]
Girish Gowdra631ef3d2020-06-15 10:45:52 -07001// Copyright (c) 2018 The Jaeger Authors.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package throttler
16
17// Throttler is used to rate limits operations. For example, given how debug spans
18// are always sampled, a throttler can be enabled per client to rate limit the amount
19// of debug spans a client can start.
20type Throttler interface {
21 // IsAllowed determines whether the operation should be allowed and not be
22 // throttled.
23 IsAllowed(operation string) bool
24}
25
26// DefaultThrottler doesn't throttle at all.
27type DefaultThrottler struct{}
28
29// IsAllowed implements Throttler#IsAllowed.
30func (t DefaultThrottler) IsAllowed(operation string) bool {
31 return true
32}