https://github.com/leocolman/simplefeaturethrottler
When adding a new feature to an unstable production environment, a service might want to limit the amount of calls made to external services or procedures. With Simple Feature Throttle you can control this.
https://github.com/leocolman/simplefeaturethrottler
feature hacktoberfest kotlin percentage-throttle rate-limit rate-limiter rate-limiting throttle throttler throttling
Last synced: 6 months ago
JSON representation
When adding a new feature to an unstable production environment, a service might want to limit the amount of calls made to external services or procedures. With Simple Feature Throttle you can control this.
- Host: GitHub
- URL: https://github.com/leocolman/simplefeaturethrottler
- Owner: LeoColman
- License: mit
- Created: 2019-04-05T04:07:05.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T05:41:50.000Z (almost 2 years ago)
- Last Synced: 2024-05-01T16:48:50.629Z (over 1 year ago)
- Topics: feature, hacktoberfest, kotlin, percentage-throttle, rate-limit, rate-limiter, rate-limiting, throttle, throttler, throttling
- Language: Kotlin
- Homepage:
- Size: 70.3 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Simple Feature Throttler
[](https://travis-ci.com/LeoColman/SimpleFeatureThrottler) [](https://github.com/LeoColman/SimpleFeatureThrottler/blob/master/LICENSE) [](https://search.maven.org/search?q=a:simple-feature-throttler)
When adding a new feature to an unstable production environment, a service might want to limit the amount of calls made to external services or procedures. With Simple Feature Throttler you can control this.
## Using in your project
To use Simple Feature Throttler in your project, include the dependency in your `build.gradle`, and you're good to go!
```
implementation("com.kerooker.simplefeaturethrottler:simple-feature-throttler:{currentVersion}")
```
## Available API
To keep it simple, this library provides two ways to throttle your feature: `Throttler` and `FeatureThrottler`.
#### Using Throttler:
The `Throttler` class draws number from a Random pool and checks if the next execution of your feature should be denied or not, based on a throttle percentage:
```kotlin
val throttler = Throttler(90.0) // I'll deny 90% of the executions! Only 10% will go through
fun myFeatureThatShouldBeThrottled() {
if (throttler.shouldThrottle()) return
callOtherSystem()
}
```
The `Throttler` also contains a utility Companion Object, with a function that mimics its behavior:
```kotlin
fun myFeatureThatShouldBeThrottled() {
if (Throttler.shouldThrottle(33.3)) return
callOtherSystem()
}
```
#### Using Feature Throttler
The `FeatureThrottler` may be useful if you have more than one feature currently being throttled, and you want more configuration on it. You can configure a feature in 3 different ways:
1. By Environment Variables, with the key being your feature and the value being the throttle percentage, for example: `my.feature=33.3`
2. By the System Properties, in the same fashion as the Environment Variables: `my.feature=33.3`
3. By calling the function `FeatureThrottler.setThrottlePercentage("my.feature", 33.3)`
To use the value you set anywhere in the program, you can simply use `FeatureThrottler.shouldThrottle("my.feature")`
So, for example:
```kotlin
fun myFeatureThatShouldBeThrottled() {
if (FeatureThrottler.shouldThrottle("my.feature")) return
callBackend()
}
```
If for any reason you need to know what is the current throttling for a given feature, you can use `FeatureThrottler.getThrottlePercentage("my.feature")`