package envoy.service.ratelimit.v2

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc ShouldRateLimit (RateLimitRequest, RateLimitResponse)

  rls.proto:21

  Determine whether rate limiting should take place.

  message RateLimitRequest

  rls.proto:32

  Main message for a rate limit request. The rate limit service is designed to be fully generic in the sense that it can operate on arbitrary hierarchical key/value pairs. The loaded configuration will parse the request and find the most specific limit to apply. In addition, a RateLimitRequest can contain multiple "descriptors" to limit on. When multiple descriptors are provided, the server will limit on *ALL* of them and return an OVER_LIMIT response if any of them are over limit. This enables more complex application level rate limiting scenarios if desired.

  • string domain = 1

    All rate limit requests must specify a domain. This enables the configuration to be per application without fear of overlap. E.g., "envoy".

  • repeated api.v2.ratelimit.RateLimitDescriptor descriptors = 2

    All rate limit requests must specify at least one RateLimitDescriptor. Each descriptor is processed by the service (see below). If any of the descriptors are over limit, the entire request is considered to be over limit.

  • uint32 hits_addend = 3

    Rate limit requests can optionally specify the number of hits a request adds to the matched limit. If the value is not set in the message, a request increases the matched limit by 1.

  message RateLimitResponse

  rls.proto:48

  A response from a ShouldRateLimit call.

  • RateLimitResponse.Code overall_code = 1

    The overall response code which takes into account all of the descriptors that were passed in the RateLimitRequest message.

  • repeated RateLimitResponse.DescriptorStatus statuses = 2

    A list of DescriptorStatus messages which matches the length of the descriptor list passed in the RateLimitRequest. This can be used by the caller to determine which individual descriptors failed and/or what the currently configured limits are for all of them.

  • repeated api.v2.core.HeaderValue headers = 3

    A list of headers to add to the response

  • repeated api.v2.core.HeaderValue request_headers_to_add = 4

    A list of headers to add to the request when forwarded

Used in: RateLimitResponse, DescriptorStatus

• UNKNOWN = 0

  The response code is not known.

• OK = 1

  The response code to notify that the number of requests are under limit.

• OVER_LIMIT = 2

  The response code to notify that the number of requests are over limit.

Used in: RateLimitResponse

• Code code = 1

  The response code for an individual descriptor.

• optional RateLimit current_limit = 2

  The current limit as configured by the server. Useful for debugging, etc.

• uint32 limit_remaining = 3

  The limit remaining in the current time unit.

Defines an actual rate limit in terms of requests per unit of time and the unit itself.

Used in: DescriptorStatus

• string name = 3

  A name or description of this limit.

• uint32 requests_per_unit = 1

  The number of requests per unit of time.

• RateLimit.Unit unit = 2

  The unit of time.

Used in: RateLimit

• UNKNOWN = 0

  The time unit is not known.

• SECOND = 1

  The time unit representing a second.

• MINUTE = 2

  The time unit representing a minute.

• HOUR = 3

  The time unit representing an hour.

• DAY = 4

  The time unit representing a day.