Skip to main content

UpstreamConf

Struct UpstreamConf 

Source
pub struct UpstreamConf {
Show 34 fields pub addrs: Vec<String>, pub discovery: Option<String>, pub dns_server: Option<String>, pub dns_domain: Option<String>, pub dns_search: Option<String>, pub update_frequency: Option<Duration>, pub algo: Option<String>, pub sni: Option<String>, pub verify_cert: Option<bool>, pub health_check: Option<String>, pub ipv4_only: Option<bool>, pub enable_tracer: Option<bool>, pub enable_backend_stats: Option<bool>, pub backend_failure_status_code: Option<String>, pub circuit_break_max_consecutive_failures: Option<u32>, pub circuit_break_max_failure_percent: Option<u16>, pub circuit_break_min_requests_threshold: Option<u64>, pub circuit_break_half_open_consecutive_success_threshold: Option<u32>, pub circuit_break_open_duration: Option<Duration>, pub backend_stats_interval: Option<Duration>, pub alpn: Option<String>, pub connection_timeout: Option<Duration>, pub total_connection_timeout: Option<Duration>, pub read_timeout: Option<Duration>, pub idle_timeout: Option<Duration>, pub write_timeout: Option<Duration>, pub tcp_idle: Option<Duration>, pub tcp_interval: Option<Duration>, pub tcp_user_timeout: Option<Duration>, pub tcp_probe_count: Option<usize>, pub tcp_recv_buf: Option<ByteSize>, pub tcp_fast_open: Option<bool>, pub includes: Option<Vec<String>>, pub remark: Option<String>,
}
Expand description

Configuration for an upstream service that handles proxied requests

Fields§

§addrs: Vec<String>

List of upstream server addresses in format “host:port” or “host:port weight”

§discovery: Option<String>

Service discovery mechanism to use (e.g. “dns”, “static”)

§dns_server: Option<String>

DNS server for DNS discovery

§dns_domain: Option<String>

DNS domain for DNS discovery

§dns_search: Option<String>

DNS search for DNS discovery

§update_frequency: Option<Duration>

How frequently to update the upstream server list

§algo: Option<String>

Load balancing algorithm (e.g. “round_robin”, “hash:cookie”)

§sni: Option<String>

Server Name Indication for TLS connections

§verify_cert: Option<bool>

Whether to verify upstream TLS certificates

§health_check: Option<String>

Health check URL to verify upstream server status

§ipv4_only: Option<bool>

Whether to only use IPv4 addresses

§enable_tracer: Option<bool>

Enable request tracing

§enable_backend_stats: Option<bool>

Enable backend stats

§backend_failure_status_code: Option<String>

Failure status codes for backend stats Format: “400,500,502,503,504”

§circuit_break_max_consecutive_failures: Option<u32>

Maximum number of consecutive failures required to trip the circuit breaker

§circuit_break_max_failure_percent: Option<u16>

Maximum failure rate (percentage, 0 to 100) required to trip the circuit breaker

§circuit_break_min_requests_threshold: Option<u64>

Minimum total number of requests (within the statistics window) required before the failure rate is considered significant for circuit breaking. Prevents tripping the breaker when traffic is very low.

§circuit_break_half_open_consecutive_success_threshold: Option<u32>

The number of consecutive successes required to reset the circuit breaker to closed.

§circuit_break_open_duration: Option<Duration>

The duration of the open state of the circuit breaker.

§backend_stats_interval: Option<Duration>

Interval for backend stats, default is 60 seconds

§alpn: Option<String>

Application Layer Protocol Negotiation for TLS

§connection_timeout: Option<Duration>

Timeout for establishing new connections

§total_connection_timeout: Option<Duration>

Total timeout for the entire request/response cycle

§read_timeout: Option<Duration>

Timeout for reading response data

§idle_timeout: Option<Duration>

Timeout for idle connections in the pool

§write_timeout: Option<Duration>

Timeout for writing request data

§tcp_idle: Option<Duration>

TCP keepalive idle time

§tcp_interval: Option<Duration>

TCP keepalive probe interval

§tcp_user_timeout: Option<Duration>

TCP keepalive user timeout

§tcp_probe_count: Option<usize>

Number of TCP keepalive probes before connection is dropped

§tcp_recv_buf: Option<ByteSize>

TCP receive buffer size

§tcp_fast_open: Option<bool>

Enable TCP Fast Open

§includes: Option<Vec<String>>

List of included configuration files

§remark: Option<String>

Optional description/notes about this upstream

Implementations§

Source§

impl UpstreamConf

Source

pub fn guess_discovery(&self) -> String

Determines the appropriate service discovery mechanism:

  • Returns configured discovery if set
  • Returns DNS discovery if any address contains a hostname
  • Returns empty string (static discovery) otherwise

Trait Implementations§

Source§

impl Clone for UpstreamConf

Source§

fn clone(&self) -> UpstreamConf

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for UpstreamConf

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for UpstreamConf

Source§

fn default() -> UpstreamConf

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for UpstreamConf

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Hash for UpstreamConf

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Hashable for UpstreamConf

Source§

impl Serialize for UpstreamConf

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Validate for UpstreamConf

Source§

fn validate(&self) -> Result<(), Error>

Validates the upstream configuration:

  1. The address list can’t be empty
  2. For static discovery, addresses must be valid socket addresses
  3. Health check URL must be valid if specified
  4. TCP probe count must not exceed maximum (16)

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
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

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

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

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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,