Struct RecorderOptions 

#[non_exhaustive]
pub struct RecorderOptions { /* private fields */ }

Options used when attaching a Recorder to a process.

Implementations

impl RecorderOptions

pub fn new(sample_rate: SampleRate) -> Self

Construct a usable recording configuration.

pub fn stack_size(self, stack_size: u32) -> Self

Set the user-stack snapshot size in bytes.

pub fn ring_buffer_stacks(self, stacks: u32) -> Self

Set the target per-CPU perf data-ring capacity in stack-sized records.

Capacity is the larger of the configured stack snapshot and system page size, times this count, with a floor large enough for any perf record and power-of-two page rounding. On 4 KiB-page hosts, the default count of 32 gives a 1 MiB ring for the default 32 KiB stack and a 2 MiB ring for a 64 KiB stack. Memory is pinned per CPU. Values requiring more than 256 MiB per CPU are rejected. Larger valid values can absorb occasional long stalls, but should be benchmarked under sustained load before deployment. Zero selects the default. If mmap fails with EPERM or ENOMEM, attach progressively halves the ring down to the minimum valid capacity. All per-CPU rings in one recorder also share a 1 GiB aggregate data budget; effective capacities are available in RecordingSummary.

pub fn include_kernel(self, include: bool) -> Self

Include kernel frames when permitted.

pub fn inherit_children(self, inherit: bool) -> Self

Follow child processes created after recording starts.

pub fn start_timestamp_us(self, timestamp: u64) -> Self

Set the Unix-timeline anchor stored in the spool header.

pub fn sample_interval_us(self, interval: u64) -> Self

Set optional sampling-interval metadata stored in the spool header.

Trait Implementations

impl Clone for RecorderOptions

fn clone(&self) -> RecorderOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecorderOptions

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

Formats the value using the given formatter.

impl Default for RecorderOptions

fn default() -> Self

Returns the “default value” for a type.