Struct TelemetryGuardBuilder 

pub struct TelemetryGuardBuilder { /* private fields */ }

Implementations

impl TelemetryGuardBuilder

pub fn add_sink<Sink>( self, max_level: LevelFilter, sink: Sink, ) -> TelemetryGuardBuilder

where Sink: EventSink + 'static,

pub fn with_max_level_override( self, level_filter: LevelFilter, ) -> TelemetryGuardBuilder

Programmatic override

pub fn with_local_sink_enabled(self, enabled: bool) -> TelemetryGuardBuilder

pub fn with_interop_max_level_override( self, level_filter: LevelFilter, ) -> TelemetryGuardBuilder

pub fn with_install_log_capture(self, enabled: bool) -> TelemetryGuardBuilder

pub fn with_install_tracing_capture( self, enabled: bool, ) -> TelemetryGuardBuilder

pub fn with_local_sink_max_level( self, level_filter: LevelFilter, ) -> TelemetryGuardBuilder

pub fn with_ctrlc_handling(self) -> TelemetryGuardBuilder

pub fn with_max_queue_bytes(self, bytes: usize) -> TelemetryGuardBuilder

Soft byte cap for the telemetry upload queue: once reached, new Traces items (thread and image blocks) are dropped first. Falls back to MICROMEGAS_TELEMETRY_MAX_QUEUE_BYTES, then HttpSinkConfig::DEFAULT_MAX_QUEUE_BYTES.

pub fn with_hard_queue_bytes(self, bytes: usize) -> TelemetryGuardBuilder

Hard byte cap for the telemetry upload queue: once reached, Logs and Metrics items are dropped too (Metadata is never dropped). Falls back to MICROMEGAS_TELEMETRY_HARD_QUEUE_BYTES, then HttpSinkConfig::DEFAULT_HARD_QUEUE_BYTES.

pub fn with_max_in_flight_requests( self, max_in_flight_requests: usize, ) -> TelemetryGuardBuilder

Maximum number of insert_* HTTP requests in flight at once. Falls back to MICROMEGAS_TELEMETRY_MAX_IN_FLIGHT_REQUESTS, then HttpSinkConfig::DEFAULT_MAX_IN_FLIGHT_REQUESTS.

pub fn with_request_timeout(self, timeout: Duration) -> TelemetryGuardBuilder

Per-request timeout (covers connect + send + receive for one attempt). Bounds how long a single retry attempt can hang against an ingestion service that accepts connections but never responds, which otherwise would make shutdown block indefinitely (Drop for HttpEventSink joins the worker thread). Falls back to MICROMEGAS_TELEMETRY_REQUEST_TIMEOUT_SECS, then HttpSinkConfig::DEFAULT_REQUEST_TIMEOUT.

pub fn with_retry_by_priority( self, retry_by_priority: [Take<ExponentialBackoff>; 4], ) -> TelemetryGuardBuilder

Retry strategy per upload priority (indexed by UploadPriority as usize: Metadata, Logs, Metrics, Traces). Defaults to HttpSinkConfig::default_retry_by_priority.

pub fn with_request_decorator( self, make_decorator: Box<dyn FnOnce() -> Arc<dyn RequestDecorator> + Send>, ) -> TelemetryGuardBuilder

pub fn with_auth_from_env(self) -> TelemetryGuardBuilder

Automatically configure authentication from environment variables.

Checks for authentication configuration in this order:

1. API key authentication via MICROMEGAS_INGESTION_API_KEY
2. OIDC client credentials via MICROMEGAS_OIDC_TOKEN_ENDPOINT, MICROMEGAS_OIDC_CLIENT_ID, and MICROMEGAS_OIDC_CLIENT_SECRET
3. Falls back to no authentication (TrivialRequestDecorator)

Example

use micromegas_telemetry_sink::TelemetryGuardBuilder;

// Set environment variable
unsafe {
    std::env::set_var("MICROMEGAS_INGESTION_API_KEY", "secret-key-123");
}

// Builder automatically configures API key authentication
let _guard = TelemetryGuardBuilder::default()
    .with_auth_from_env()
    .build()
    .expect("Failed to build telemetry guard");

pub fn with_system_metrics_enabled(self, enabled: bool) -> TelemetryGuardBuilder

pub fn with_default_system_properties_enabled( self, enabled: bool, ) -> TelemetryGuardBuilder

pub fn with_telemetry_sink_url(self, url: String) -> TelemetryGuardBuilder

Set the URL of telemetry sink.

If not explicitly set, the URL will be read from the MICROMEGAS_TELEMETRY_URL environment variable.

pub fn with_process_property( self, key: String, value: String, ) -> TelemetryGuardBuilder

Add a single property to the process info.

Warning

This will override any existing properties.

pub fn with_process_properties( self, process_properties: HashMap<String, String>, ) -> TelemetryGuardBuilder

Add multiple properties to the process info.

Warning

This will override any existing properties.

pub fn build(self) -> Result<TelemetryGuard, Error>

Trait Implementations

impl Default for TelemetryGuardBuilder

fn default() -> TelemetryGuardBuilder

Returns the “default value” for a type.