https://github.com/lpicanco/krate
Rate Limit Library for Kotlin
https://github.com/lpicanco/krate
hacktoberfest kotlin library rate-limiter
Last synced: about 2 months ago
JSON representation
Rate Limit Library for Kotlin
- Host: GitHub
- URL: https://github.com/lpicanco/krate
- Owner: lpicanco
- License: apache-2.0
- Created: 2022-08-15T11:40:10.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-07-10T19:37:52.000Z (12 months ago)
- Last Synced: 2025-07-11T05:08:13.981Z (12 months ago)
- Topics: hacktoberfest, kotlin, library, rate-limiter
- Language: Kotlin
- Homepage: https://lpicanco.github.io/krate/
- Size: 2.06 MB
- Stars: 32
- Watchers: 3
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-java - Krate
README
# Krate
Krate is a rate limiter library for Kotlin.
[](http://kotlinlang.org)
[](https://sonarcloud.io/summary/new_code?id=lpicanco_krate)
[](https://sonarcloud.io/summary/new_code?id=lpicanco_krate)
[](https://search.maven.org/artifact/io.github.lpicanco/krate-core)
## Features
1. Token Bucket Algorithm: Krate uses the token bucket algorithm, a widely-used technique for rate limiting, to ensure efficient and fair resource allocation.
2. Burst Support: Krate allows for bursty request patterns, letting clients make a certain number of requests in a short time before being rate-limited.
3. Redis Support: Krate offers support for Redis as a backend for storing rate limit information, enabling distributed rate limiting across multiple instances of your application.
4. Keys eviction support: Krate automatically evicts unused keys, optimizing memory usage and ensuring optimal performance.
## Installation
### Gradle
```groovy
implementation 'io.github.lpicanco:krate-core:${krateVersion}'
```
### Gradle Kotlin DSL
```kotlin
implementation("io.github.lpicanco:krate-core:${krateVersion}")
```
### Maven
```xml
io.github.lpicanco
krate-core
${krateVersion}
```
## How to use
### Rate of 5 per second
```kotlin
import com.neutrine.krate.rateLimiter
// Create a rate limiter with a rate of 5 per second.
val rateLimiter = rateLimiter(maxRate = 5)
// Use the rate limiter.
val taken: Boolean = rateLimiter.tryTake()
```
### Rate of 10 per minute with a max burst of 10.
```kotlin
// Create a rate limiter with a rate of 5 per minute and a max burst of 10.
val rateLimiter = rateLimiter(maxRate = 5) {
maxBurst = 10
maxRateTimeUnit = ChronoUnit.MINUTES
}
// Use the rate limiter.
val taken: Boolean = rateLimiter.tryTake()
```
### Rate of 5 per second, blocking
```kotlin
// Create a rate limiter with a rate of 5 per second.
val rateLimiter = rateLimiter(maxRate = 5)
// Wait until a token is available.
rateLimiter.awaitUntilTake()
```
### Rate of 5 per second, expiring keys unused in the last 2 hours
```kotlin
import com.neutrine.krate.rateLimiter
// Create a rate limiter with a rate of 5 per second. Unused keys will be evicted after 2 hours.
val rateLimiter = rateLimiter(maxRate = 5) {
stateStorage = memoryStateStorageWithEviction {
ttlAfterLastAccess = 2.hours
}
}
// Use the rate limiter.
val taken: Boolean = rateLimiter.tryTake("myKey")
```
### Rate of 10 per second, using caffeine to evict keys unused in the last 2 hours
```kotlin
import com.neutrine.krate.rateLimiter
// Create a rate limiter with a rate of 5 per second. Unused keys will be evicted after 2 hours.
val rateLimiter = rateLimiter(maxRate = 10) {
stateStorage = memoryCaffeineStateStorage {
expireAfterAccess = 2.hours
}
}
// Use the rate limiter.
val taken: Boolean = rateLimiter.tryTake("myKey")
```
### Rate of 5 per second using Redis as state storage
```kotlin
// Create a rate limiter with a rate of 5 per second and redis.
val rateLimiter = rateLimiter(maxRate = 5) {
stateStorage = redisStateStorage {
host = "my-custom-uri.endpoint"
}
}
// Use the rate limiter.
val taken: Boolean = rateLimiter.tryTake()
```