Skip to main content

RequestedTelemetryAttributes

Struct RequestedTelemetryAttributes 

Source
pub struct RequestedTelemetryAttributes { /* private fields */ }
Expand description

The operation-input member names a customer has opted in to for telemetry, split into two independent policies.

Every requested member is captured into CapturedTelemetryAttributes on the config bag; the two sets differ only in whether the value is also emitted on the built-in client metrics:

  • emit — the value is captured and attached to the built-in client metrics as an attribute. This is the common case (emit_input_attributes).
  • capture-only — the value is captured so a custom interceptor can read it during the operation, but it is not attached to the built-in metrics (capture_input_attributes). This keeps a high-cardinality value out of the metric label set while still making it available in-process.

The generated per-operation interceptor captures the union of both sets; the built-in metrics implementation emits only the emit set. Absent unless the customer opts in, so both are a no-op by default.

Names are the Smithy member names (e.g. "Bucket"), matched by generated code against the operation’s input members.

Implementations§

Source§

impl RequestedTelemetryAttributes

Source

pub fn new(names: impl IntoIterator<Item = impl AsRef<str>>) -> Self

Creates a selection whose members are both captured and emitted on the metrics.

Takes impl AsRef<str> items so the public API doesn’t commit to the internal storage type; names are cloned into the backing representation here.

Source

pub fn emit(&mut self, names: impl IntoIterator<Item = impl AsRef<str>>)

Adds member names to the emit set (captured and attached to the built-in metrics).

Source

pub fn capture_only(&mut self, names: impl IntoIterator<Item = impl AsRef<str>>)

Adds member names to the capture-only set (captured for in-process reads, not emitted on the built-in metrics).

Source

pub fn should_capture(&self, name: &str) -> bool

Returns true if name should be captured (in either set).

Source

pub fn should_emit(&self, name: &str) -> bool

Returns true if name should be emitted on the built-in metrics.

Source

pub fn is_empty(&self) -> bool

Returns true if nothing is requested for capture in either set.

Trait Implementations§

Source§

impl Clone for RequestedTelemetryAttributes

Source§

fn clone(&self) -> RequestedTelemetryAttributes

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 RequestedTelemetryAttributes

Source§

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

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

impl Default for RequestedTelemetryAttributes

Source§

fn default() -> RequestedTelemetryAttributes

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

impl PartialEq for RequestedTelemetryAttributes

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Storable for RequestedTelemetryAttributes

Source§

type Storer = StoreReplace<RequestedTelemetryAttributes>

Specify how an item is stored in the config bag, e.g. StoreReplace and StoreAppend
Source§

impl Eq for RequestedTelemetryAttributes

Source§

impl StructuralPartialEq for RequestedTelemetryAttributes

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
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> 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.
§

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