Plugin Reference¶
Overview¶
One of the key features of Apache Traffic Server is modularity. Features that aren’t needed in the core simply aren’t there. This is a good thing, because it guarantees that our core can remain fast by concentrating on the things that we always provide: Caching and proxying.
All other things can be moved into plugins, by opening up a consistent C API, everyone can implement their own functionality, without having to touch the core.
Stable plugins¶
Plugins that are considered stable are installed by default in Apache Traffic Server releases.
- CacheURL Plugin: allows you to change the key that is used for caching a request by using any portion of the url via regex
- conf_remap Plugin: allows you to override configuration directives dependent on actual remapping rules
- gzip / deflate Plugin: gzips or deflates responses
- Header Rewrite Plugin: allows you to modify various headers based on defined rules (operations) on a request or response
- Regex Remap Plugin: allows you to configure mapping rules based on regular expressions
- Stats over HTTP Plugin: implements an HTTP interface to all Traffic Server statistics
- TCPInfo Plugin: logs TCP metrics at various points in the HTTP processing pipeline
Experimental plugins¶
Plugins that are considered experimental are located in the plugins/experimental directory of the Apache Traffic Server source tree. Exmperimental plugins can be compiled by passing the –enable-experimental-plugins option to configure:
$ autoconf -i
$ ./configure --enable-experimental-plugins
$ make
- AuthProxy Plugin: delegates the authorization decision of a request to an external HTTP service
- Background Fetch Plugin: allows you to proactively fetch content from Origin in a way that it will fill the object into cache
- Balancer Plugin: balances requests across multiple origin servers
- Buffer Upload Plugin: buffers POST data before connecting to the Origin server
- Combohandler Plugin: provides an intelligent way to combine multiple URLs into a single URL, and have Apache Traffic Server combine the components into one response
- Epic Plugin: emits Traffic Server metrics in a format that is consumed tby the Epic Network Monitoring System
- ESI Plugin: implements the ESI specification
- GeoIP ACLs Plugin: denying (or allowing) requests based on the source IP geo-location
- HIPES plugin
- Metalink Plugin: implements the Metalink download description format in order to try not to download the same file twice.
- MySQL Remap Plugin: allows dynamic “remaps” from a database
- AWS S3 Authentication plugin: provides support for the Amazon S3 authentication features
- Stale While Revalidate Plugin (undocumented)
- ts-lua Plugin: allows plugins to be written in Lua instead of C code
- XDebug Plugin: allows HTTP clients to debug the operation of the Traffic Server cache using the X-Debug header