xianrendzw / spring-cloud-zuul-ratelimit

Rate limit strategy for Spring Cloud Netflix Zuul

Spring Cloud Zuul RateLimit

Module to enable rate limit per service in Netflix Zuul.
There are five built-in rate limit approaches:

• Authenticated User
  • Uses the authenticated username or 'anonymous'
• Request Origin
  • Uses the user origin request
• URL
  • Uses the request path of the upstream service
• Global configuration per service:
  • This one does not validate the request Origin, Authenticated User or URI
  • To use this approach just don't set param 'type'

Note: It is possible to combine Authenticated User, Request Origin and URL just adding multiple values to the list

Default implementations

There are two implementations provided:

• RedisRateLimiter for production
• InMemoryRateLimiter only for dev environment

Usage

This project is available on maven central

Add the dependency on pom.xml

<dependency>
    <groupId>com.marcosbarbero.cloud</groupId>
    <artifactId>spring-cloud-zuul-ratelimit</artifactId>
    <version>1.1.0.RELEASE</version>
</dependency>

In case you are using Redis there will be needed to add the following dependency as well to pom.xml

 <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-data-redis</artifactId>
 </dependency>

Sample configuration

zuul:
  ratelimit:
    enabled: true #default false
    behind-proxy: true #default false
    policies:
      myServiceId:
        limit: 10
        refresh-interval: 60 #default value (in seconds)
        type: #optional
          - user
          - origin
          - url

Contributing

Spring Cloud Zuul Rate Limit is released under the non-restrictive Apache 2.0 license, and follows a very standard Github development process, using Github tracker for issues and merging pull requests into master. If you want to contribute even something trivial please do not hesitate, but follow the guidelines below.

Adding Project Lombok Agent

This project uses Project Lombok to generate getters and setters etc. Compiling from the command line this shouldn't cause any problems, but in an IDE you need to add an agent to the JVM. Full instructions can be found in the Lombok website. The sign that you need to do this is a lot of compiler errors to do with missing methods and fields.

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [e-mail].

Footnote

Any doubt open an issue.
Any fix send me a Pull Request.