BoxLang 🚀 A New JVM Dynamic Language Learn More...

PresideCMS Extension: Smart Throttler

v0.2.2+0000014 Preside Extensions

Smart Throttler: Request limiting for Preside Applications

This extension allows you to add finer control of request throttling for your Preside applications:

  1. Limit the max number of requests Preside will process
  2. Set a maximum queue size for requests over the limit
  3. Define URL paths that will bypass the queue - i.e. healthchecks
  4. Define URL paths that should be treated as a priority
  5. Define whether or not to prioritise logged in users (web and admin)

The project is currently in an ALPHA state.

Configuration

Configuration of the extension can provided either through environment variables, or by direct settings in your application's Config.cfc. Variables to set:

  • maxActiveRequests: Maximum number of active requests before queueing requests. Default is 0 which turns off all functionality of this extension
  • queueSize: The maximum number of queued requests. Default is 0.
  • queueTimeout: The maximum time in seconds that a request can be in the queue before timing out. Default is 50.
  • failureStatusCode: Status code to use when either the queue is full, or requests timeout. Default is 503.
  • sleepInterval: How long queued threads sleep for before checking their status again (in ms). Default is 50.
  • skipPaths: An array of URL paths that can bypass the queue entirely. These are matched with a "startsWith" pattern so an incoming /api/v2/events/ request matches an /api/ path
  • skipAgents: An array of regular expressions for user agents that can bypass the queue entirely.
  • priorityPaths: An array of URL paths that will be placed in the priority queue and processed before "standard" requests. These are matched with a "startsWith" pattern so an incoming /api/v2/events/ request matches an /api/ path
  • priorityAgents: An array of regular expressions for user agents will be placed in the priority queue and processed before "standard" requests.
  • failPaths: An array of URL paths that will be immediately failed while max concurrent requests is reached. These are matched with a "startsWith" pattern so an incoming /api/v2/events/ request matches an /api/ path
  • failAgents: An array of regular expressions for user agents that will be immediately failed while max concurrent requests is reached.
  • prioritiseUsers: Boolean, whether or not to put logged in user requests into the priority queue. Default is true.
  • prioritiseAdmins: Boolean, whether or not to put logged in admin user requests into the priority queue. Default is false.
  • failStatelessReqs: Boolean, whether or not to fail stateless requests while max concurrent requests is exceeded. Default is false.

Using environment variables

The following environment variables can be set to control the configuration options, above:

  • SMARTTHROTTLER_MAX_ACTIVE_REQUESTS
  • SMARTTHROTTLER_QUEUE_SIZE
  • SMARTTHROTTLER_QUEUE_TIMEOUT
  • SMARTTHROTTLER_FAILURE_STATUS_CODE
  • SMARTTHROTTLER_SLEEP_INTERVAL
  • SMARTTHROTTLER_SKIP_PATHS (use a string list of paths, e.g. "/alive,/metrics")
  • SMARTTHROTTLER_SKIP_AGENTS (use a string list of agents, e.g. "^Uptime robot$,apiclient")
  • SMARTTHROTTLER_PRIORITY_PATHS (use a string list of paths, e.g. "/api,/login")
  • SMARTTHROTTLER_PRIORITY_AGENTS (use a string list of paths, e.g. "^Uptime robot$,apiclient")
  • SMARTTHROTTLER_FAIL_PATHS (use a string list of paths, e.g. "/somepath,/anotherpath")
  • SMARTTHROTTLER_FAIL_AGENTS (use a string list of paths, e.g. "\bbot\b,semver")
  • SMARTTHROTTLER_PRIORITISE_USERS
  • SMARTTHROTTLER_PRIORITISE_ADMINS
  • SMARTTHROTTLER_FAIL_STATELESSREQS

See Configuring Preside page in Preside docs for a guide to injecting environment variables.

Using Config.cfc

settings.smartThrottler.maxActiveRequests = 20;
settings.smartThrottler.queueSize         = 100;
settings.smartThrottler.queueTimeout      = 50;
settings.smartThrottler.failureStatusCode = 503;
settings.smartThrottler.sleepInterval     = 20;
settings.smartThrottler.skipPaths         = [ "/alive", "/metrics" ];
settings.smartThrottler.skipAgents        = [ "Uptime robot"       ];
settings.smartThrottler.priorityPaths     = [ "/login/", "/admin/" ];
settings.smartThrottler.priorityAgents    = [ "^APIClient04$"      ];
settings.smartThrottler.failPaths         = [ "/somepath/"         ];
settings.smartThrottler.failAgents        = [ "\bbot\b", "semrush" ];
settings.smartThrottler.prioritiseUsers   = true;
settings.smartThrottler.prioritiseAdmins  = false;
settings.smartThrottler.failStatelessReqs = false;

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository. Project releases can also be found and installed from Forgebox

License

This project is licensed under the GPLv2 License - see the LICENSE.txt file for details.

Authors

The project is maintained by The Pixl8 Group. The lead developer is Dominic Watson and the project is supported by the community (view contributors).

Code of conduct

We are a small, friendly and professional community. For the eradication of doubt, we publish a simple code of conduct and expect all contributors, users and passers-by to observe it.

Changelog

0.2.2

  • Add missing “return” keyword to isStatelessRequest()

0.2.1

  • Add a debug header for queue priority classification for your request

0.2.0

  • Added concept of immediate fail conditions. i.e. when exceeding max concurrent active requests, immediately fail requests under the matching conditions.
  • Added ability to specify one or more regex patterns for matching user agents for skip, fail + priority rules

0.1.0

Initial alpha testing release. Bringing some minor amount of configurability + a working queue system with some smartish defaults.

$ box install preside-ext-smart-throttler

No collaborators yet.
  • {{ getFullDate("2023-04-14T14:24:18Z") }}
  • {{ getFullDate("2023-05-05T11:26:41Z") }}
  • 538
  • 27,725