Struct RequestIdPlugin 

pub struct RequestIdPlugin {
    header_name: String,
    include_in_response: bool,
}

Guarantees a request-id header on the request: when the header is absent (or empty) a fresh UUID v4 is generated and set; an id supplied by the client is kept as-is. With include_in_response the same id is also set on the response, unless the response already carries one.

This plugin never fails at execution time.

Note on placement: the upstream node replaces context.response.headers wholesale with the upstream’s response headers. To guarantee the id on the response, place a second request-id node after upstream — it finds the request header already set, reuses the same id, and stamps it on the response.

Fields

header_name: String

Lowercased name of the id header.

include_in_response: bool

When true, the id is echoed on the response (if not already present).

Implementations

impl RequestIdPlugin

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

Builds the plugin from node config.

Accepted keys (all optional):

• header_name (string, default X-Request-Id): header carrying the id (lowercased internally, per featherbit’s header convention).
• include_in_response (bool, default true): also set the id on the response when the response does not already carry the header.
• algorithm (string, default uuid): id generation algorithm. Only uuid (UUID v4) is supported; any other value (APISIX also offers nanoid, range_id, ksuid, uuidv7) is a config error.

type: request-id
config:
  header_name: X-Request-Id
  include_in_response: true
  algorithm: uuid

Trait Implementations

impl Plugin for RequestIdPlugin

fn plugin_type(&self) -> &str

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

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.