Struct SentryConfig 

pub struct SentryConfig { /* private fields */ }

Represents the application-level configuration section that covers everything related to Sentry integration.

This config comes with a custom Deserialize implementation, to support more human-oriented textual configuration.

Implementations

impl SentryConfig

pub fn dsn(&self) -> &SecureString

Returns the Sentry DSN (Data Source Name), which acts like a connection string. This value tells the app where to send error reports.

pub fn debug(&self) -> bool

Indicates whether Sentry debug mode is enabled.

When true, the Sentry client will log internal operations (e.g., failed event deliveries). Useful during development or troubleshooting.

pub fn sample_rate(&self) -> f32

Returns the sample rate for error event reporting (0.0 to 1.0).

For example, a value of 1.0 means all errors will be reported; 0.5 means only half (randomly selected). Helps control how much data is sent.

pub fn traces_sample_rate(&self) -> f32

Returns the traces sample rate (0.0 to 1.0), which controls performance tracing.

This affects how often spans and transaction traces are sent to Sentry. Higher values give more observability but can increase overhead.

pub fn max_breadcrumbs(&self) -> usize

Returns the maximum number of breadcrumbs (context logs) stored per event.

Breadcrumbs are small logs (like “user clicked button”) that help reconstruct what happened before an error. This setting limits how many of those are retained.

pub fn attach_stacktrace(&self) -> bool

Indicates whether stack traces should be automatically attached to events.

When true, errors and certain logs will include call stacks to help identify where they originated. This improves debugging but adds overhead.

pub fn shutdown_timeout(&self) -> Duration

Returns the maximum time allowed to send any remaining events before shutdown.

On application exit, Sentry will attempt to flush queued events. This timeout defines how long it should wait before giving up.

Trait Implementations

impl AsRef<SentryConfig> for SentryConfig

fn as_ref(&self) -> &SentryConfig

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SentryConfig

fn clone(&self) -> SentryConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SentryConfig

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

Formats the value using the given formatter.

impl Default for SentryConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SentryConfig

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SentryConfig

fn eq(&self, other: &SentryConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SentryConfig