Struct TelemetryKit 

pub struct TelemetryKit { /* private fields */ }

Main telemetry SDK

Implementations

impl TelemetryKit

pub fn builder() -> TelemetryBuilder

Create a new TelemetryKit builder

pub async fn track_command<F>( &self, command: impl Into<String>, builder_fn: F, ) -> Result<()>

where F: FnOnce(CommandEventBuilder) -> CommandEventBuilder,

Track a command execution

Example

telemetry.track_command("build", |event| {
    event
        .flag("--release")
        .duration_ms(1234)
        .success(true)
}).await?;

pub async fn track_feature<F>( &self, feature: impl Into<String>, builder_fn: F, ) -> Result<()>

where F: FnOnce(FeatureEventBuilder) -> FeatureEventBuilder,

Track a feature usage

Example

telemetry.track_feature("authentication", |event| {
    event
        .method("oauth")
        .success(true)
}).await?;

pub async fn track_custom( &self, event_type: impl Into<String>, data: Value, ) -> Result<()>

Track a custom event

pub async fn sync(&self) -> Result<()>

Manually trigger a sync

pub async fn stats(&self) -> Result<EventStats>

Get statistics about buffered events

pub async fn cleanup(&self) -> Result<usize>

Clean up old synced events (older than 7 days)

pub fn grant_consent(&self) -> Result<()>

Grant user consent for telemetry tracking

pub fn deny_consent(&self) -> Result<()>

Deny user consent for telemetry tracking

pub fn opt_out(&self) -> Result<()>

Opt out of telemetry tracking (equivalent to DO_NOT_TRACK)

pub fn is_do_not_track_enabled() -> bool

Check if DO_NOT_TRACK environment variable is set

pub async fn shutdown(&self) -> Result<()>

Gracefully shutdown auto-sync task and optionally perform final sync

Trait Implementations

impl Drop for TelemetryKit

Available on crate feature sync only.

fn drop(&mut self)

Executes the destructor for this type.