/
SubscribeRateLimiter.java
336 lines (291 loc) · 13.3 KB
/
SubscribeRateLimiter.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.pulsar.broker.service.persistent;
import com.google.common.base.MoreObjects;
import java.util.Objects;
import java.util.Optional;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import org.apache.pulsar.broker.ServiceConfiguration;
import org.apache.pulsar.broker.service.BrokerService;
import org.apache.pulsar.common.naming.TopicName;
import org.apache.pulsar.common.policies.data.Policies;
import org.apache.pulsar.common.policies.data.SubscribeRate;
import org.apache.pulsar.common.policies.data.TopicPolicies;
import org.apache.pulsar.common.util.RateLimiter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class SubscribeRateLimiter {
private final String topicName;
private final BrokerService brokerService;
private ConcurrentHashMap<ConsumerIdentifier, RateLimiter> subscribeRateLimiter;
private final ScheduledExecutorService executorService;
private ScheduledFuture<?> resetTask;
private SubscribeRate subscribeRate;
public SubscribeRateLimiter(PersistentTopic topic) {
this.topicName = topic.getName();
this.brokerService = topic.getBrokerService();
subscribeRateLimiter = new ConcurrentHashMap<>();
this.executorService = brokerService.pulsar().getExecutor();
// get subscribeRate from topic level policies
this.subscribeRate = topic.getTopicPolicies()
.map(TopicPolicies::getSubscribeRate)
.orElse(null);
// subscribeRate of topic level policies not set, get from zookeeper
if (this.subscribeRate == null) {
this.subscribeRate = getPoliciesSubscribeRate();
}
// get subscribeRate from broker.conf
if (this.subscribeRate == null) {
this.subscribeRate = new SubscribeRate(brokerService.pulsar()
.getConfiguration().getSubscribeThrottlingRatePerConsumer(),
brokerService.pulsar().getConfiguration().getSubscribeRatePeriodPerConsumerInSecond());
}
if (isSubscribeRateEnabled(this.subscribeRate)) {
resetTask = createTask();
log.info("[{}] configured subscribe-dispatch rate at broker {}", this.topicName, subscribeRate);
}
}
/**
* returns available subscribes if subscribe-throttling is enabled else it returns -1.
*
* @return
*/
public long getAvailableSubscribeRateLimit(ConsumerIdentifier consumerIdentifier) {
return subscribeRateLimiter.get(consumerIdentifier)
== null ? -1 : subscribeRateLimiter.get(consumerIdentifier).getAvailablePermits();
}
/**
* It acquires subscribe from subscribe-limiter and returns if acquired permits succeed.
*
* @return
*/
public synchronized boolean tryAcquire(ConsumerIdentifier consumerIdentifier) {
addSubscribeLimiterIfAbsent(consumerIdentifier);
return subscribeRateLimiter.get(consumerIdentifier)
== null || subscribeRateLimiter.get(consumerIdentifier).tryAcquire();
}
/**
* checks if subscribe-rate limit is configured and if it's configured then check if
* subscribe are available or not.
*
* @return
*/
public boolean subscribeAvailable(ConsumerIdentifier consumerIdentifier) {
return (subscribeRateLimiter.get(consumerIdentifier)
== null || subscribeRateLimiter.get(consumerIdentifier).getAvailablePermits() > 0);
}
/**
* Update subscribe-throttling-rate. gives first priority to
* namespace-policy configured subscribe rate else applies
* default broker subscribe-throttling-rate
*/
private synchronized void addSubscribeLimiterIfAbsent(ConsumerIdentifier consumerIdentifier) {
if (subscribeRateLimiter.get(consumerIdentifier) != null || !isSubscribeRateEnabled(this.subscribeRate)) {
return;
}
updateSubscribeRate(consumerIdentifier, this.subscribeRate);
}
private synchronized void removeSubscribeLimiter(ConsumerIdentifier consumerIdentifier) {
if (this.subscribeRateLimiter.get(consumerIdentifier) != null) {
this.subscribeRateLimiter.get(consumerIdentifier).close();
this.subscribeRateLimiter.remove(consumerIdentifier);
}
}
/**
* Update subscribe rate by updating rate-limiter. If subscribe-rate is configured < 0 then it closes
* the rate-limiter and disables appropriate rate-limiter.
*
* @param subscribeRate
*/
private synchronized void updateSubscribeRate(ConsumerIdentifier consumerIdentifier, SubscribeRate subscribeRate) {
long ratePerConsumer = subscribeRate.subscribeThrottlingRatePerConsumer;
long ratePeriod = subscribeRate.ratePeriodInSecond;
// update subscribe-rateLimiter
if (ratePerConsumer > 0) {
if (this.subscribeRateLimiter.get(consumerIdentifier) == null) {
this.subscribeRateLimiter.put(consumerIdentifier,
new RateLimiter(brokerService.pulsar().getExecutor(), ratePerConsumer,
ratePeriod, TimeUnit.SECONDS));
} else {
this.subscribeRateLimiter.get(consumerIdentifier)
.setRate(ratePerConsumer, ratePeriod, TimeUnit.SECONDS,
null);
}
} else {
// subscribe-rate should be disable and close
removeSubscribeLimiter(consumerIdentifier);
}
}
public void onPoliciesUpdate(Policies data) {
// if subscribe rate is set on topic policy, skip subscribe rate update
SubscribeRate subscribeRate = brokerService.getTopicPolicies(TopicName.get(topicName))
.map(TopicPolicies::getSubscribeRate)
.orElse(null);
if (subscribeRate != null) {
return;
}
String cluster = brokerService.pulsar().getConfiguration().getClusterName();
subscribeRate = data.clusterSubscribeRate.get(cluster);
onSubscribeRateUpdate(subscribeRate);
}
public void onSubscribeRateUpdate(SubscribeRate subscribeRate) {
final SubscribeRate namespacePolicySubscribeRate = getPoliciesSubscribeRate();
final SubscribeRate newSubscribeRate = new SubscribeRate(
brokerService.pulsar().getConfiguration().getSubscribeThrottlingRatePerConsumer(),
brokerService.pulsar().getConfiguration().getSubscribeRatePeriodPerConsumerInSecond()
);
// if policy-throttling rate is disabled and cluster-throttling is enabled then apply
// cluster-throttling rate
// if topic policy-throttling rate is disabled
if (!isSubscribeRateEnabled(subscribeRate) && isSubscribeRateEnabled(namespacePolicySubscribeRate)) {
subscribeRate = namespacePolicySubscribeRate;
}
if (!isSubscribeRateEnabled(subscribeRate) && !isSubscribeRateEnabled(namespacePolicySubscribeRate)
&& isSubscribeRateEnabled(newSubscribeRate)) {
subscribeRate = newSubscribeRate;
}
this.subscribeRate = subscribeRate;
stopResetTask();
for (ConsumerIdentifier consumerIdentifier : this.subscribeRateLimiter.keySet()) {
if (!isSubscribeRateEnabled(this.subscribeRate)) {
removeSubscribeLimiter(consumerIdentifier);
} else {
updateSubscribeRate(consumerIdentifier, subscribeRate);
}
}
if (isSubscribeRateEnabled(this.subscribeRate)) {
this.resetTask = createTask();
log.info("[{}] configured subscribe-dispatch rate at broker {}", this.topicName, subscribeRate);
}
}
/**
* Gets configured subscribe-rate from namespace policies. Returns null if subscribe-rate is not configured
*
* @return
*/
public SubscribeRate getPoliciesSubscribeRate() {
return getPoliciesSubscribeRate(brokerService, topicName);
}
public static boolean isDispatchRateNeeded(BrokerService brokerService, Optional<Policies> policies,
String topicName) {
ServiceConfiguration serviceConfig = brokerService.pulsar().getConfiguration();
policies = policies.isPresent() ? policies : DispatchRateLimiter.getPolicies(brokerService, topicName);
return isDispatchRateNeeded(serviceConfig, policies, topicName);
}
private static boolean isDispatchRateNeeded(final ServiceConfiguration serviceConfig,
final Optional<Policies> policies, final String topicName) {
SubscribeRate subscribeRate = getPoliciesSubscribeRate(serviceConfig.getClusterName(), policies, topicName);
if (subscribeRate == null) {
return serviceConfig.getSubscribeThrottlingRatePerConsumer() > 0
|| serviceConfig.getSubscribeRatePeriodPerConsumerInSecond() > 0;
}
return true;
}
public static SubscribeRate getPoliciesSubscribeRate(BrokerService brokerService, final String topicName) {
final String cluster = brokerService.pulsar().getConfiguration().getClusterName();
final Optional<Policies> policies = DispatchRateLimiter.getPolicies(brokerService, topicName);
return getPoliciesSubscribeRate(cluster, policies, topicName);
}
public static SubscribeRate getPoliciesSubscribeRate(final String cluster, final Optional<Policies> policies,
String topicName) {
// return policy-subscribe rate only if it's enabled in policies
return policies.map(p -> {
if (p.clusterSubscribeRate != null) {
SubscribeRate subscribeRate = p.clusterSubscribeRate.get(cluster);
return isSubscribeRateEnabled(subscribeRate) ? subscribeRate : null;
} else {
return null;
}
}).orElse(null);
}
/**
* Get configured msg subscribe-throttling rate. Returns -1 if not configured
*
* @return
*/
public long getSubscribeRatePerConsumer(ConsumerIdentifier consumerIdentifier) {
return subscribeRateLimiter.get(consumerIdentifier)
!= null ? subscribeRateLimiter.get(consumerIdentifier).getRate() : -1;
}
private static boolean isSubscribeRateEnabled(SubscribeRate subscribeRate) {
return subscribeRate != null && (subscribeRate.subscribeThrottlingRatePerConsumer > 0);
}
public void close() {
closeAndClearRateLimiters();
stopResetTask();
}
private ScheduledFuture<?> createTask() {
return executorService.scheduleAtFixedRate(this::closeAndClearRateLimiters,
this.subscribeRate.ratePeriodInSecond,
this.subscribeRate.ratePeriodInSecond,
TimeUnit.SECONDS);
}
private void stopResetTask() {
if (this.resetTask != null) {
this.resetTask.cancel(false);
}
}
private synchronized void closeAndClearRateLimiters() {
// close rate-limiter
this.subscribeRateLimiter.values().forEach(rateLimiter -> {
if (rateLimiter != null) {
rateLimiter.close();
}
});
this.subscribeRateLimiter.clear();
}
public SubscribeRate getSubscribeRate() {
return subscribeRate;
}
public static class ConsumerIdentifier {
private String host;
private String consumerName;
private long consumerId;
public ConsumerIdentifier(String host, String consumerName, long consumerId) {
this.host = host;
this.consumerName = consumerName;
this.consumerId = consumerId;
}
@Override
public int hashCode() {
return Objects.hash(host, consumerName, consumerId);
}
@Override
public boolean equals(Object obj) {
if (obj instanceof ConsumerIdentifier) {
ConsumerIdentifier consumer = (ConsumerIdentifier) obj;
return Objects.equals(host, consumer.host)
&& Objects.equals(consumerName, consumer.consumerName)
&& Objects.equals(consumerId, consumer.consumerId);
}
return false;
}
@Override
public String toString() {
return MoreObjects.toStringHelper(this)
.add("host", host)
.add("consumerName", consumerName)
.add("consumerId", consumerId).toString();
}
}
private static final Logger log = LoggerFactory.getLogger(SubscribeRateLimiter.class);
}