Skip to main content

ZipkinPlugin

Struct ZipkinPlugin 

Source
pub struct ZipkinPlugin {
    phase: Phase,
    endpoint: String,
    service_name: String,
    server_addr: Option<String>,
    sample_ratio: f64,
    ssl_verify: bool,
    timeout: Duration,
    client: Arc<OutboundClient>,
}
Expand description

One node of the Zipkin tracing pair.

Fields§

§phase: Phase§endpoint: String

Full collector URL spans POST to, e.g. http://localhost:9411/api/v2/spans.

§service_name: String§server_addr: Option<String>

Optional localEndpoint.ipv4 reported on each span.

§sample_ratio: f64

Fraction of new traces to sample, in 0.0..=1.0.

§ssl_verify: bool§timeout: Duration§client: Arc<OutboundClient>

Implementations§

Source§

impl ZipkinPlugin

Source

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

Builds the plugin from node config.

Config keys:

KeyTypeDefaultDescription
phasestring— (required)start (before upstream) or end (after upstream).
endpointstring— (required)Full Zipkin v2 collector URL, e.g. http://localhost:9411/api/v2/spans.
service_namestring"featherbit"localEndpoint.serviceName reported on each span.
server_addrstringOptional localEndpoint.ipv4 for the reporting host.
sample_rationumber1.0Fraction of new traces to sample, in 0.0..=1.0.
ssl_verifybooltrueVerify the collector’s TLS certificate.
timeoutint (seconds)3Export request timeout (end node).

Fails fast on an unknown phase, a missing/empty endpoint, or a sample_ratio outside 0.0..=1.0. The same config (including endpoint) is placed on both the start and end nodes.

# start node — right after listener, before upstream
- id: zipkin-start
  type: zipkin
  config:
    phase: start
    endpoint: http://localhost:9411/api/v2/spans
    service_name: my-gateway
    sample_ratio: 0.1
# end node — after upstream, right before client
- id: zipkin-end
  type: zipkin
  config:
    phase: end
    endpoint: http://localhost:9411/api/v2/spans
Source

fn sample_new(&self, trace_id: &str) -> bool

Decides whether a brand-new trace should be sampled, per sample_ratio.

Source

fn run_start(&self, ctx: &mut Context)

START: extract or create the span, store it, and inject x-b3-*.

Source

fn run_end(&self, ctx: &Context)

END: load the span and fire-and-forget the Zipkin export when sampled.

Trait Implementations§

Source§

impl Plugin for ZipkinPlugin

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