Skip to main content

TelemetryBundle

Struct TelemetryBundle 

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

Declarative configuration for the telemetry stack. Consume with open.

Implementations§

Source§

impl TelemetryBundle

Source

pub fn new(event_schema_version: u32) -> Self

Empty bundle — at least one of with_anonymous / with_pseudonymous must be called before open.

Source

pub fn with_recent_log_capacity(self, n: usize) -> Self

Capacity of the user-facing “recently emitted” ring buffer surfaced by the PrivacySettings widget’s “Inspect data sent” accordion. Default: 200 events. Independent of any adapter’s own outbound queue.

Source

pub fn with_anonymous(self, reporter: Rc<dyn UsageReporter>) -> Self

Install the anonymous-mode adapter (e.g. teksilo-analytics-plausible). The adapter’s install_id() must return None.

Source

pub fn with_pseudonymous(self, reporter: Rc<dyn UsageReporter>) -> Self

Install the pseudonymous-mode adapter (e.g. teksilo-analytics-posthog). The adapter’s install_id() must return Some(uuid) once configured.

Source

pub fn with_default_mode(self, mode: TelemetryMode) -> Self

Which mode is active on first run before the user picks.

Source

pub fn with_debounce(self, debounce: Duration) -> Self

Source

pub fn with_data_processor_name(self, name: impl Into<String>) -> Self

Source

pub fn with_privacy_policy_url(self, url: impl Into<String>) -> Self

Source

pub fn with_data_residency_region(self, region: DataResidencyRegion) -> Self

Source

pub fn with_retention_days(self, days: u32) -> Self

Source

pub fn open( self, paths: &AppPaths, settings: &SettingsStore, ) -> Result<OpenedTelemetry, TelemetryBundleError>

Open every requested service against paths. Reads the runtime endpoint override from settings exactly once; the override is propagated to adapters via their constructors (each adapter is responsible for honoring it).

Trait Implementations§

Source§

impl Clone for TelemetryBundle

Source§

fn clone(&self) -> TelemetryBundle

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

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 = !

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.