Struct PingoraPlugin 

pub struct PingoraPlugin { /* private fields */ }

Runs a Pingora reverse proxy inside an Autumn app.

use autumn_plugin_pingora::{PingoraPlugin, Route};

autumn_web::app()
    .routes(routes![index])
    .plugin(PingoraPlugin::new().route(
        Route::new("billing").path_prefix("/billing").upstream("10.0.0.7:8080"),
    ))
    .run()
    .await;

The plugin reads [pingora] from autumn.toml (see PingoraConfig). Fluent setters apply on top of the file values.

On boot, the plugin:

• resolves the upstreams,
• binds the listener (a failure stops boot),
• starts the health checks,
• adds a pingora health indicator and pingora_proxy_* metrics,
• puts a PingoraHandle into AppState.

The plugin drains when Autumn’s shutdown signal fires.

Implementations

impl PingoraPlugin

pub fn new() -> Self

A plugin with no routes, configured from [pingora].

pub fn route(self, route: Route) -> Self

Add a route after the routes from config.

pub fn configure( self, apply: impl Fn(&mut PingoraConfig) + Send + Sync + 'static, ) -> Self

Change the configuration in code, after files and environment.

pub fn config(self, config: PingoraConfig) -> Self

Use config and read no config files. The profile still comes from the environment (see development). Fluent setters still apply on top.

pub fn development(self, development: bool) -> Self

Force development (true) or production (false) defaults. By default, the active profile decides.

pub fn bind(self, addr: impl Into<String>) -> Self

Set the listen address, IP:port.

pub fn fallback(self, fallback: Fallback) -> Self

Set where unmatched requests go.

pub const fn public(self) -> Self

Mark the proxied prefixes as public in autumn routes. If you do not, they are unclassified. Then autumn routes audit fails.

pub fn handle(&self) -> PingoraHandle

A handle to this plugin’s proxy. It is valid before and after boot.

pub fn route_infos(&self) -> Vec<RouteInfo>

The proxied prefixes as autumn routes lists them: method PROXY, path [host]/prefix/*. The fallback is not listed: the app routes cover it.

pub fn effective_config(&self) -> Result<&PingoraConfig, &ConfigError>

The configuration after files, environment and code.

Errors

The ConfigError that aborts boot.

Trait Implementations

impl Debug for PingoraPlugin

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PingoraPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for PingoraPlugin

fn name(&self) -> Cow<'static, str>

Stable identifier used for duplicate-registration detection.

fn build(self, app: AppBuilder) -> AppBuilder

Apply this plugin’s configuration to the builder.

fn route_group(&self) -> Cow<'static, str>

The route group of the routes this plugin adds (#3544).

fn contract(&self) -> Option<PluginContract>

Declare which autumn-web versions this plugin supports, and any experimental surface it knowingly depends on.