Home

Welcome to the BucketGuard wiki.

BucketGuard is a high-performance, dependency-free rate limiting library for Java 21+. It provides efficient, thread-safe protection for your applications using the Generic Cell Rate Algorithm (GCRA).

Documentation Sections

• Getting Started: Installation instructions and your first rate limiter.
• Configuration: Comprehensive guide to TokenBucketSpec and KeyedStoreSpec.
• Keyed Rate Limiting: Managing independent buckets, eviction strategies, and scheduled maintenance.
• Advanced Usage: Asynchronous acquisition, burst control semantics, and contention strategies.
• Performance: Design philosophy, GCRA implementation details, and zero-allocation guarantees.
• Cookbook: Code snippets for common rate limiting patterns.
• FAQ: Questions that are frequently asked or common