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 downstream service

• URL Pattern

  • Uses the request Ant path pattern to the downstream service

• ROLE

  • Uses the authenticated user roles

• Request method

  • Uses the HTTP request method

• Request header

  • Uses the HTTP request header

• 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'

Add the dependency on pom.xml

Add the following dependency accordingly to the chosen data storage:

• Redis

• Consul

• Spring Data JPA

This implementation also requires a database table, bellow here you can find a sample script:

• Bucket4j JCache

• Bucket4j Hazelcast (depends on Bucket4j JCache)

• Bucket4j Infinispan (depends on Bucket4j JCache)

• Bucket4j Ignite (depends on Bucket4j JCache)

Sample YAML configuration

Sample Properties configuration

Both 'quota' and 'refresh-interval', can be expressed with Spring Boot’s duration formats:

• A regular long representation (using seconds as the default unit)

• The standard ISO-8601 format used by java.time.Duration (e.g. PT30M means 30 minutes)

• A more readable format where the value and the unit are coupled (e.g. 10s means 10 seconds)

There are eight implementations provided:

Bucket4j implementations require the relevant bean with @Qualifier("RateLimit"):

• JCache - javax.cache.Cache

• Hazelcast - com.hazelcast.map.IMap

• Ignite - org.apache.ignite.IgniteCache

• Infinispan - org.infinispan.functional.ReadWriteMap

Property namespace: zuul.ratelimit

Deny Request properties

Policy properties:

This section details how to add custom implementations

Key Generator

  @Bean
  public RateLimitKeyGenerator ratelimitKeyGenerator(RateLimitProperties properties, RateLimitUtils rateLimitUtils) {
      return new DefaultRateLimitKeyGenerator(properties, rateLimitUtils) {
          @Override
          public String key(HttpServletRequest request, Route route, RateLimitProperties.Policy policy) {
              return super.key(request, route, policy) + ":" + request.getMethod();
          }
      };
  }

Error Handling

  @Bean
  public RateLimiterErrorHandler rateLimitErrorHandler() {
    return new DefaultRateLimiterErrorHandler() {
        @Override
        public void handleSaveError(String key, Exception e) {
            // custom code
        }

        @Override
        public void handleFetchError(String key, Exception e) {
            // custom code
        }

        @Override
        public void handleError(String msg, Exception e) {
            // custom code
        }
    }
  }

Event Handling

    @EventListener
    public void observe(RateLimitExceededEvent event) {
        // custom code
    }

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.

Code of Conduct

Acknowledgement

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