Skip to main content

OtelCollectorOptionsBuilder

temporalio_common::telemetry

Struct OtelCollectorOptionsBuilder 

Source 
pub struct OtelCollectorOptionsBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> OtelCollectorOptionsBuilder<S>

Source

pub fn build(self) -> OtelCollectorOptions
where S: IsComplete,

Finish building and return the requested object

Source

pub fn url(self, value: Url) -> OtelCollectorOptionsBuilder<SetUrl<S>>
where S::Url: IsUnset,

Required.

The url of the OTel collector to export telemetry and metrics to. Lang SDK should also export to this same collector.

Source

pub fn headers( self, value: HashMap<String, String>, ) -> OtelCollectorOptionsBuilder<SetHeaders<S>>
where S::Headers: IsUnset,

Optional (Some / Option setters). Default: HashMap::new().

Optional set of HTTP headers to send to the Collector, e.g for authentication.

Source

pub fn maybe_headers( self, value: Option<HashMap<String, String>>, ) -> OtelCollectorOptionsBuilder<SetHeaders<S>>
where S::Headers: IsUnset,

Optional (Some / Option setters). Default: HashMap::new().

Optional set of HTTP headers to send to the Collector, e.g for authentication.

Source

pub fn metric_periodicity( self, value: Duration, ) -> OtelCollectorOptionsBuilder<SetMetricPeriodicity<S>>
where S::MetricPeriodicity: IsUnset,

Optional (Some / Option setters). Default: Duration::from_secs(1).

Optionally specify how frequently metrics should be exported. Defaults to 1 second.

Source

pub fn maybe_metric_periodicity( self, value: Option<Duration>, ) -> OtelCollectorOptionsBuilder<SetMetricPeriodicity<S>>
where S::MetricPeriodicity: IsUnset,

Optional (Some / Option setters). Default: Duration::from_secs(1).

Optionally specify how frequently metrics should be exported. Defaults to 1 second.

Source

pub fn metric_temporality( self, value: MetricTemporality, ) -> OtelCollectorOptionsBuilder<SetMetricTemporality<S>>
where S::MetricTemporality: IsUnset,

Optional (Some / Option setters). Default: MetricTemporality::Cumulative.

Specifies the aggregation temporality for metric export. Defaults to cumulative.

Source

pub fn maybe_metric_temporality( self, value: Option<MetricTemporality>, ) -> OtelCollectorOptionsBuilder<SetMetricTemporality<S>>
where S::MetricTemporality: IsUnset,

Optional (Some / Option setters). Default: MetricTemporality::Cumulative.

Specifies the aggregation temporality for metric export. Defaults to cumulative.

Source

pub fn global_tags( self, value: HashMap<String, String>, ) -> OtelCollectorOptionsBuilder<SetGlobalTags<S>>
where S::GlobalTags: IsUnset,

Optional (Some / Option setters). Default: <HashMap<String, String> as Default>::default().

A map of tags to be applied to all metrics

Source

pub fn maybe_global_tags( self, value: Option<HashMap<String, String>>, ) -> OtelCollectorOptionsBuilder<SetGlobalTags<S>>
where S::GlobalTags: IsUnset,

Optional (Some / Option setters). Default: <HashMap<String, String> as Default>::default().

A map of tags to be applied to all metrics

Source

pub fn use_seconds_for_durations( self, value: bool, ) -> OtelCollectorOptionsBuilder<SetUseSecondsForDurations<S>>
where S::UseSecondsForDurations: IsUnset,

Optional (Some / Option setters). Default: false.

If set to true, use f64 seconds for durations instead of u64 milliseconds

Source

pub fn maybe_use_seconds_for_durations( self, value: Option<bool>, ) -> OtelCollectorOptionsBuilder<SetUseSecondsForDurations<S>>
where S::UseSecondsForDurations: IsUnset,

Optional (Some / Option setters). Default: false.

If set to true, use f64 seconds for durations instead of u64 milliseconds

Source

pub fn histogram_bucket_overrides( self, value: HistogramBucketOverrides, ) -> OtelCollectorOptionsBuilder<SetHistogramBucketOverrides<S>>
where S::HistogramBucketOverrides: IsUnset,

Optional (Some / Option setters). Default: <HistogramBucketOverrides as Default>::default().

Overrides for histogram buckets. Units depend on the value of use_seconds_for_durations.

Source

pub fn maybe_histogram_bucket_overrides( self, value: Option<HistogramBucketOverrides>, ) -> OtelCollectorOptionsBuilder<SetHistogramBucketOverrides<S>>
where S::HistogramBucketOverrides: IsUnset,

Optional (Some / Option setters). Default: <HistogramBucketOverrides as Default>::default().

Overrides for histogram buckets. Units depend on the value of use_seconds_for_durations.

Source

pub fn protocol( self, value: OtlpProtocol, ) -> OtelCollectorOptionsBuilder<SetProtocol<S>>
where S::Protocol: IsUnset,

Optional (Some / Option setters). Default: OtlpProtocol::Grpc.

Protocol to use for communication with the collector

Source

pub fn maybe_protocol( self, value: Option<OtlpProtocol>, ) -> OtelCollectorOptionsBuilder<SetProtocol<S>>
where S::Protocol: IsUnset,

Optional (Some / Option setters). Default: OtlpProtocol::Grpc.

Protocol to use for communication with the collector

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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<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> ErasedDestructor for T
where T: 'static,