-
Notifications
You must be signed in to change notification settings - Fork 209
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implementation of RateLimitNetworkTrafficListener (#406)
* Initial implementation of RateLimitNetworkTrafficListener * Fix accidental removal of metrics listener * Remove bucket4j option as guava and resilience4j would be sufficient * Make NetworkTrafficRateLimiter and interface * Add test for RateLimitNetworkTrafficListener * Add range validator for NETWORK_TRAFFIC_RATE_LIMIT_BYTES_PER_SEC_CONFIG * Add comment and logging for RateLimitNetworkTrafficListener class, and change the test to show drastic effect of rate limiting * Fix comments in test and change validator to be atLeast instead of range
- Loading branch information
1 parent
4562e0f
commit 4e3152a
Showing
9 changed files
with
473 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
49 changes: 49 additions & 0 deletions
49
core/src/main/java/io/confluent/rest/RateLimitNetworkTrafficListener.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| /* | ||
| * Copyright 2023 Confluent Inc. | ||
| * | ||
| * Licensed 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 io.confluent.rest; | ||
|
|
||
| import io.confluent.rest.ratelimit.NetworkTrafficRateLimiter; | ||
| import io.confluent.rest.ratelimit.NetworkTrafficRateLimiterFactory; | ||
| import java.net.Socket; | ||
| import java.nio.ByteBuffer; | ||
| import org.eclipse.jetty.io.NetworkTrafficListener; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * This class is used as a way to apply back-pressure on all the network traffic sockets when | ||
| * incoming rate exceeds a threshold | ||
| */ | ||
| public class RateLimitNetworkTrafficListener implements NetworkTrafficListener { | ||
|
|
||
| private static final Logger log = LoggerFactory.getLogger(RateLimitNetworkTrafficListener.class); | ||
|
|
||
| private final NetworkTrafficRateLimiter rateLimiter; | ||
|
|
||
| public RateLimitNetworkTrafficListener(RestConfig restConfig) { | ||
| rateLimiter = NetworkTrafficRateLimiterFactory.create(restConfig); | ||
| } | ||
|
|
||
| @Override | ||
| public void incoming(final Socket socket, final ByteBuffer bytes) { | ||
| int cost = bytes.limit() - bytes.position(); | ||
| if (cost > 0) { | ||
| log.debug("Applying network traffic rate limit on socket: {} with cost: {}", socket, cost); | ||
| rateLimiter.rateLimit(cost); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
22 changes: 22 additions & 0 deletions
22
core/src/main/java/io/confluent/rest/ratelimit/NetworkTrafficRateLimitBackend.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| /* | ||
| * Copyright 2023 Confluent Inc. | ||
| * | ||
| * Licensed 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 io.confluent.rest.ratelimit; | ||
|
|
||
| public enum NetworkTrafficRateLimitBackend { | ||
| GUAVA, | ||
| RESILIENCE4J | ||
| } |
22 changes: 22 additions & 0 deletions
22
core/src/main/java/io/confluent/rest/ratelimit/NetworkTrafficRateLimiter.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| /* | ||
| * Copyright 2023 Confluent Inc. | ||
| * | ||
| * Licensed 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 io.confluent.rest.ratelimit; | ||
|
|
||
| public interface NetworkTrafficRateLimiter { | ||
|
|
||
| void rateLimit(int cost); | ||
| } |
86 changes: 86 additions & 0 deletions
86
core/src/main/java/io/confluent/rest/ratelimit/NetworkTrafficRateLimiterFactory.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| /* | ||
| * Copyright 2023 Confluent Inc. | ||
| * | ||
| * Licensed 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 io.confluent.rest.ratelimit; | ||
|
|
||
| import com.google.common.util.concurrent.RateLimiter; | ||
| import io.confluent.rest.RestConfig; | ||
| import io.github.resilience4j.ratelimiter.RateLimiterConfig; | ||
| import java.time.Duration; | ||
|
|
||
| public final class NetworkTrafficRateLimiterFactory { | ||
|
|
||
| private NetworkTrafficRateLimiterFactory() { | ||
| // prevent instantiation | ||
| } | ||
|
|
||
| public static NetworkTrafficRateLimiter create(RestConfig restConfig) { | ||
| int bytesPerSecond = restConfig.getNetworkTrafficRateLimitBytesPerSec(); | ||
| switch (restConfig.getNetworkTrafficRateLimitBackend()) { | ||
| case GUAVA: | ||
| return GuavaNetworkTrafficRateLimiter.create(bytesPerSecond); | ||
| case RESILIENCE4J: | ||
| return Resilience4JNetworkTrafficRateLimiter.create(bytesPerSecond); | ||
| default: | ||
| throw new AssertionError("Unknown enum constant: " | ||
| + restConfig.getNetworkTrafficRateLimitBackend()); | ||
| } | ||
| } | ||
|
|
||
| static final class GuavaNetworkTrafficRateLimiter implements NetworkTrafficRateLimiter { | ||
|
|
||
| private final RateLimiter delegate; | ||
|
|
||
| GuavaNetworkTrafficRateLimiter(RateLimiter delegate) { | ||
| this.delegate = delegate; | ||
| } | ||
|
|
||
| static GuavaNetworkTrafficRateLimiter create(int bytesPerSecond) { | ||
| return new GuavaNetworkTrafficRateLimiter(RateLimiter.create(bytesPerSecond)); | ||
| } | ||
|
|
||
| @Override | ||
| public void rateLimit(final int cost) { | ||
| delegate.acquire(cost); | ||
| } | ||
| } | ||
|
|
||
| static final class Resilience4JNetworkTrafficRateLimiter implements NetworkTrafficRateLimiter { | ||
|
|
||
| private final io.github.resilience4j.ratelimiter.RateLimiter delegate; | ||
|
|
||
| Resilience4JNetworkTrafficRateLimiter(io.github.resilience4j.ratelimiter.RateLimiter delegate) { | ||
| this.delegate = delegate; | ||
| } | ||
|
|
||
| static Resilience4JNetworkTrafficRateLimiter create(int bytesPerSecond) { | ||
| RateLimiterConfig config = | ||
| RateLimiterConfig.custom() | ||
| .limitRefreshPeriod(Duration.ofSeconds(1)) | ||
| .limitForPeriod(bytesPerSecond) | ||
| .build(); | ||
| return new Resilience4JNetworkTrafficRateLimiter( | ||
| io.github.resilience4j.ratelimiter.RateLimiter.of( | ||
| "Resilience4JNetworkTrafficRateLimiter", config) | ||
| ); | ||
| } | ||
|
|
||
| @Override | ||
| public void rateLimit(final int cost) { | ||
| delegate.acquirePermission(cost); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.