Skip to main content

ProxyMirrorPlugin

Struct ProxyMirrorPlugin 

Source
pub struct ProxyMirrorPlugin {
    host: String,
    path: Option<String>,
    sample_ratio: f64,
    client: Arc<OutboundClient>,
}
Expand description

Mirrors matching requests to a shadow host, best-effort.

Fields§

§host: String

Shadow base URL, e.g. http://shadow:8080 (scheme + host + optional port, no trailing path).

§path: Option<String>

Optional path override; when unset the original request path is used.

§sample_ratio: f64

Fraction of requests to mirror, in 0.0..=1.0.

§client: Arc<OutboundClient>

Shared pooled outbound HTTP client (from PluginResources).

Implementations§

Source§

impl ProxyMirrorPlugin

Source

pub fn from_config( config: &HashMap<String, Value>, resources: &Arc<PluginResources>, ) -> Result<Self, String>

Builds the plugin from node config.

Accepted keys:

  • host (string, required): shadow base URL — scheme + host + optional port, e.g. http://shadow:8080. Must start with http:// or https://; no trailing path.
  • path (string, optional): overrides the mirrored request path; when unset the original request path is mirrored. The original query string is always appended.
  • sample_ratio (number, default 1.0): fraction of requests to mirror, in 0.0..=1.0. 1.0 mirrors every request; 0.0 mirrors none. Sampling uses a pseudo-random draw (see roll_fraction).
type: proxy-mirror
config:
  host: "http://shadow:8080"
  path: "/mirror"
  sample_ratio: 0.5
Source

fn should_mirror(&self) -> bool

Decides whether this request should be mirrored, per sample_ratio.

>= 1.0 always mirrors, 0.0 never mirrors; otherwise a pseudo-random draw is compared against the ratio.

Source

fn build_request(&self, ctx: &Context) -> OutboundRequest

Builds the outbound mirror request from the current context (pure; does no I/O). The mirrored URL is host + (path override or the original path) + the original query string. All request headers and the body are copied.

Trait Implementations§

Source§

impl Plugin for ProxyMirrorPlugin

Source§

fn plugin_type(&self) -> &str

Unique identifier for the plugin type (e.g., “proxy-rewrite”, “upstream”).
Source§

fn execute<'life0, 'life1, 'async_trait>( &'life0 self, ctx: Context, _named_inputs: &'life1 HashMap<String, Value>, ) -> Pin<Box<dyn Future<Output = Result<PluginOutput, PluginExecutionError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Executes the plugin logic against the request/response context. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> MaybeSend for T