Skip to main content

GrpcExporter

rama::telemetry::opentelemetry::collector

Struct GrpcExporter

pub struct GrpcExporter<S = ()> { /* private fields */ }

Expand description

Wrapper type which allows you to use a rama gRPC GrpcService as a gRPC OTLP exporter for your OpenTelemetry setup.

Implementations§

impl<S> OtelExporter<S>

pub fn new(service: S) -> OtelExporter<S>

Create a new OtelExporter with default OTLP gRPC settings.

Defaults to http://localhost:4317 and no extra metadata or compression.

pub fn from_env(service: S) -> Result<OtelExporter<S>, OtelExporterConfigError>

Configure this exporter using the OTLP environment variables.

pub fn with_endpoint(self, endpoint: Uri) -> OtelExporter<S>

Override the base OTLP endpoint.

pub fn set_endpoint(&mut self, endpoint: Uri) -> &mut OtelExporter<S>

Override the base OTLP endpoint.

pub fn maybe_with_timeout(self, timeout: Option<Duration>) -> OtelExporter<S>

Override the base OTLP timeout.

pub fn maybe_set_timeout( &mut self, timeout: Option<Duration>, ) -> &mut OtelExporter<S>

Override the base OTLP timeout.

pub fn with_timeout(self, timeout: Duration) -> OtelExporter<S>

Override the base OTLP timeout.

pub fn set_timeout(&mut self, timeout: Duration) -> &mut OtelExporter<S>

Override the base OTLP timeout.

pub fn without_timeout(self) -> OtelExporter<S>

Override the base OTLP timeout.

pub fn unset_timeout(&mut self) -> &mut OtelExporter<S>

Override the base OTLP timeout.

pub fn maybe_with_compression( self, compression: Option<CompressionEncoding>, ) -> OtelExporter<S>

Override the base OTLP compression.

pub fn maybe_set_compression( &mut self, compression: Option<CompressionEncoding>, ) -> &mut OtelExporter<S>

Override the base OTLP compression.

pub fn with_compression( self, compression: CompressionEncoding, ) -> OtelExporter<S>

Override the base OTLP compression.

pub fn set_compression( &mut self, compression: CompressionEncoding, ) -> &mut OtelExporter<S>

Override the base OTLP compression.

pub fn without_compression(self) -> OtelExporter<S>

Override the base OTLP compression.

pub fn unset_compression(&mut self) -> &mut OtelExporter<S>

Override the base OTLP compression.

pub fn with_metadata(self, metadata: MetadataMap) -> OtelExporter<S>

Override the base OTLP metadata.

pub fn set_metadata(&mut self, metadata: MetadataMap) -> &mut OtelExporter<S>

Override the base OTLP metadata.

pub fn maybe_with_traces_endpoint( self, endpoint: Option<Uri>, ) -> OtelExporter<S>

Override the trace-specific endpoint.

pub fn maybe_set_traces_endpoint( &mut self, endpoint: Option<Uri>, ) -> &mut OtelExporter<S>

Override the trace-specific endpoint.

pub fn with_traces_endpoint(self, endpoint: Uri) -> OtelExporter<S>

Override the trace-specific endpoint.

pub fn set_traces_endpoint(&mut self, endpoint: Uri) -> &mut OtelExporter<S>

Override the trace-specific endpoint.

pub fn without_traces_endpoint(self) -> OtelExporter<S>

Override the trace-specific endpoint.

pub fn unset_traces_endpoint(&mut self) -> &mut OtelExporter<S>

Override the trace-specific endpoint.

pub fn maybe_with_traces_timeout( self, timeout: Option<Duration>, ) -> OtelExporter<S>

Override the trace-specific timeout.

pub fn maybe_set_traces_timeout( &mut self, timeout: Option<Duration>, ) -> &mut OtelExporter<S>

Override the trace-specific timeout.

pub fn with_traces_timeout(self, timeout: Duration) -> OtelExporter<S>

Override the trace-specific timeout.

pub fn set_traces_timeout(&mut self, timeout: Duration) -> &mut OtelExporter<S>

Override the trace-specific timeout.

pub fn without_traces_timeout(self) -> OtelExporter<S>

Override the trace-specific timeout.

pub fn unset_traces_timeout(&mut self) -> &mut OtelExporter<S>

Override the trace-specific timeout.

pub fn maybe_with_traces_compression( self, compression: Option<CompressionEncoding>, ) -> OtelExporter<S>

Override the trace-specific compression.

pub fn maybe_set_traces_compression( &mut self, compression: Option<CompressionEncoding>, ) -> &mut OtelExporter<S>

Override the trace-specific compression.

pub fn with_traces_compression( self, compression: CompressionEncoding, ) -> OtelExporter<S>

Override the trace-specific compression.

pub fn set_traces_compression( &mut self, compression: CompressionEncoding, ) -> &mut OtelExporter<S>

Override the trace-specific compression.

pub fn without_traces_compression(self) -> OtelExporter<S>

Override the trace-specific compression.

pub fn unset_traces_compression(&mut self) -> &mut OtelExporter<S>

Override the trace-specific compression.

pub fn with_traces_metadata(self, metadata: MetadataMap) -> OtelExporter<S>

Override the trace-specific metadata.

pub fn set_traces_metadata( &mut self, metadata: MetadataMap, ) -> &mut OtelExporter<S>

Override the trace-specific metadata.

pub fn maybe_with_metrics_endpoint( self, endpoint: Option<Uri>, ) -> OtelExporter<S>

Override the metrics-specific endpoint.

pub fn maybe_set_metrics_endpoint( &mut self, endpoint: Option<Uri>, ) -> &mut OtelExporter<S>

Override the metrics-specific endpoint.

pub fn with_metrics_endpoint(self, endpoint: Uri) -> OtelExporter<S>

Override the metrics-specific endpoint.

pub fn set_metrics_endpoint(&mut self, endpoint: Uri) -> &mut OtelExporter<S>

Override the metrics-specific endpoint.

pub fn without_metrics_endpoint(self) -> OtelExporter<S>

Override the metrics-specific endpoint.

pub fn unset_metrics_endpoint(&mut self) -> &mut OtelExporter<S>

Override the metrics-specific endpoint.

pub fn maybe_with_metrics_timeout( self, timeout: Option<Duration>, ) -> OtelExporter<S>

Override the metrics-specific timeout.

pub fn maybe_set_metrics_timeout( &mut self, timeout: Option<Duration>, ) -> &mut OtelExporter<S>

Override the metrics-specific timeout.

pub fn with_metrics_timeout(self, timeout: Duration) -> OtelExporter<S>

Override the metrics-specific timeout.

pub fn set_metrics_timeout(&mut self, timeout: Duration) -> &mut OtelExporter<S>

Override the metrics-specific timeout.

pub fn without_metrics_timeout(self) -> OtelExporter<S>

Override the metrics-specific timeout.

pub fn unset_metrics_timeout(&mut self) -> &mut OtelExporter<S>

Override the metrics-specific timeout.

pub fn maybe_with_metrics_compression( self, compression: Option<CompressionEncoding>, ) -> OtelExporter<S>

Override the metrics-specific compression.

pub fn maybe_set_metrics_compression( &mut self, compression: Option<CompressionEncoding>, ) -> &mut OtelExporter<S>

Override the metrics-specific compression.

pub fn with_metrics_compression( self, compression: CompressionEncoding, ) -> OtelExporter<S>

Override the metrics-specific compression.

pub fn set_metrics_compression( &mut self, compression: CompressionEncoding, ) -> &mut OtelExporter<S>

Override the metrics-specific compression.

pub fn without_metrics_compression(self) -> OtelExporter<S>

Override the metrics-specific compression.

pub fn unset_metrics_compression(&mut self) -> &mut OtelExporter<S>

Override the metrics-specific compression.

pub fn with_metrics_metadata(self, metadata: MetadataMap) -> OtelExporter<S>

Override the metrics-specific metadata.

pub fn set_metrics_metadata( &mut self, metadata: MetadataMap, ) -> &mut OtelExporter<S>

Override the metrics-specific metadata.

pub fn with_temporality(self, temporality: Temporality) -> OtelExporter<S>

Configure the metric temporality used by this exporter.

pub fn set_temporality( &mut self, temporality: Temporality, ) -> &mut OtelExporter<S>

Configure the metric temporality used by this exporter.

Trait Implementations§

impl<S> Clone for OtelExporter<S>
where S: Clone,

fn clone(&self) -> OtelExporter<S>

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

impl<S> Debug for OtelExporter<S>
where S: Debug,

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

Formats the value using the given formatter. Read more

impl<S> PushMetricExporter for OtelExporter<S>
where S: Debug + Clone + GrpcService<Body>, <S as GrpcService<Body>>::ResponseBody: Body + Send + Sync + 'static, <<S as GrpcService<Body>>::ResponseBody as Body>::Error: Into<Box<dyn Error + Send + Sync>>,

async fn export(&self, metrics: &ResourceMetrics) -> Result<(), OTelSdkError>

Export serializes and transmits metric data to a receiver. Read more

fn force_flush(&self) -> Result<(), OTelSdkError>

Flushes any metric data held by an exporter.

fn shutdown_with_timeout(&self, _timeout: Duration) -> Result<(), OTelSdkError>

Releases any held computational resources. Read more

fn temporality(&self) -> Temporality

Access the Temporality of the MetricExporter.

fn shutdown(&self) -> Result<(), OTelSdkError>

Shutdown with the default timeout of 5 seconds.

impl<S> SpanExporter for OtelExporter<S>
where S: Debug + Clone + GrpcService<Body>, <S as GrpcService<Body>>::ResponseBody: Body + Send + Sync + 'static, <<S as GrpcService<Body>>::ResponseBody as Body>::Error: Into<Box<dyn Error + Send + Sync>>,

async fn export(&self, batch: Vec<SpanData>) -> Result<(), OTelSdkError>

Exports a batch of readable spans. Protocol exporters that will implement this function are typically expected to serialize and transmit the data to the destination. Read more

fn shutdown_with_timeout( &mut self, _timeout: Duration, ) -> Result<(), OTelSdkError>

Shuts down the exporter. Called when SDK is shut down. This is an opportunity for exporter to do any cleanup required. Read more

fn force_flush(&mut self) -> Result<(), OTelSdkError>

This is a hint to ensure that the export of any Spans the exporter has received prior to the call to this function SHOULD be completed as soon as possible, preferably before returning from this method. Read more

fn set_resource(&mut self, resource: &Resource)

Set the resource for the exporter.

fn shutdown(&mut self) -> Result<(), OTelSdkError>

Shuts down the exporter with default timeout.

Auto Trait Implementations§

impl<S = ()> !Freeze for OtelExporter<S>

impl<S = ()> !RefUnwindSafe for OtelExporter<S>

impl<S> Send for OtelExporter<S>
where S: Send,

impl<S> Sync for OtelExporter<S>
where S: Sync,

impl<S> Unpin for OtelExporter<S>
where S: Unpin,

impl<S> UnsafeUnpin for OtelExporter<S>
where S: UnsafeUnpin,

impl<S = ()> !UnwindSafe for OtelExporter<S>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

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>

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more

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

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

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

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

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a rama_grpc::Request

impl<L> LayerExt<L> for L

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.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T, U> RamaFrom<T> for U
where U: From<T>,

fn rama_from(value: T) -> U

impl<T, U, CrateMarker> RamaInto<U, CrateMarker> for T
where U: RamaFrom<T, CrateMarker>,

fn rama_into(self) -> U

impl<T, U> RamaTryFrom<T> for U
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>

impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for T
where U: RamaTryFrom<T, CrateMarker>,

type Error = <U as RamaTryFrom<T, CrateMarker>>::Error

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T, CrateMarker>>::Error>

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

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> Extension for T
where T: Any + Send + Sync + Debug + 'static,