Skip to main content

TelemetryPolicy

Struct TelemetryPolicy 

Source
pub struct TelemetryPolicy {
    pub enabled: bool,
    pub span_name: Option<String>,
    /* private fields */
}
Expand description

Endpoint-level telemetry instructions consumed by tracing and metrics adapters.

Fields§

§enabled: bool

Whether request tracing and metrics are enabled.

§span_name: Option<String>

Optional stable span name; endpoint identity is used when absent.

Implementations§

Source§

impl TelemetryPolicy

Source

pub const fn enabled() -> Self

Creates enabled telemetry without recording request or response data.

Source

pub const fn disabled() -> Self

Disables endpoint tracing and metrics explicitly.

Source

pub fn span_name(self, span_name: impl Into<String>) -> SoapResult<Self>

Sets a stable non-empty span name.

Source

pub fn record_request_header(self, header: HeaderName) -> SoapResult<Self>

Allows one non-sensitive request header to be recorded.

Source

pub fn record_response_header(self, header: HeaderName) -> SoapResult<Self>

Allows one non-sensitive response header to be recorded.

Source

pub fn request_headers(&self) -> &[HeaderName]

Returns the allowlist of request headers safe to record.

Source

pub fn response_headers(&self) -> &[HeaderName]

Returns the allowlist of response headers safe to record.

Source

pub fn validate(&self) -> SoapResult<()>

Validates public telemetry fields after direct mutation.

Trait Implementations§

Source§

impl Clone for TelemetryPolicy

Source§

fn clone(&self) -> TelemetryPolicy

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TelemetryPolicy

Source§

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

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

impl Default for TelemetryPolicy

Source§

fn default() -> Self

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

impl Eq for TelemetryPolicy

Source§

impl PartialEq for TelemetryPolicy

Source§

fn eq(&self, other: &TelemetryPolicy) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TelemetryPolicy

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, 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> 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.