Struct SysStatsConfig

pub struct SysStatsConfig {

    pub meminfo_period_ms: Option<u32>,
    pub meminfo_counters: Vec<i32>,
    pub vmstat_period_ms: Option<u32>,
    pub vmstat_counters: Vec<i32>,
    pub stat_period_ms: Option<u32>,
    pub stat_counters: Vec<i32>,
    pub devfreq_period_ms: Option<u32>,
    pub cpufreq_period_ms: Option<u32>,
    pub buddyinfo_period_ms: Option<u32>,
    pub diskstat_period_ms: Option<u32>,
    pub psi_period_ms: Option<u32>,
    pub thermal_period_ms: Option<u32>,
    pub cpuidle_period_ms: Option<u32>,
    pub gpufreq_period_ms: Option<u32>,
}

This file defines the configuration for the Linux /proc poller data source, which injects counters in the trace. Counters that are needed in the trace must be explicitly listed in the _counters fields. This is to avoid spamming the trace with all counters at all times. The sampling rate is configurable. All polling rates (_period_ms) need to be integer multiples of each other. OK: [10ms, 10ms, 10ms], [10ms, 20ms, 10ms], [10ms, 20ms, 60ms] Not OK: [10ms, 10ms, 11ms], [10ms, 15ms, 20ms]

Fields

meminfo_period_ms: Option<u32>

Polls /proc/meminfo every X ms, if non-zero. This is required to be > 10ms to avoid excessive CPU usage. Cost: 0.3 ms [read] + 0.07 ms [parse + trace injection]

meminfo_counters: Vec<i32>

If empty all known counters are reported. Otherwise, only the counters specified below are reported.

vmstat_period_ms: Option<u32>

Polls /proc/vmstat every X ms, if non-zero. This is required to be > 10ms to avoid excessive CPU usage. Cost: 0.2 ms [read] + 0.3 ms [parse + trace injection]

vmstat_counters: Vec<i32>

stat_period_ms: Option<u32>

Pols /proc/stat every X ms, if non-zero. This is required to be > 10ms to avoid excessive CPU usage. Cost: 4.1 ms [read] + 1.9 ms [parse + trace injection]

stat_counters: Vec<i32>

devfreq_period_ms: Option<u32>

Polls /sys/devfreq/*/curfreq every X ms, if non-zero. This is required to be > 10ms to avoid excessive CPU usage. This option can be used to record unchanging values. Updates from frequency changes can come from ftrace/set_clock_rate.

cpufreq_period_ms: Option<u32>

Polls /sys/devices/system/cpu/cpu*/cpufreq/cpuinfo_cur_freq every X ms. This is required to be > 10ms to avoid excessive CPU usage.

buddyinfo_period_ms: Option<u32>

Polls /proc/buddyinfo every X ms, if non-zero. This is required to be > 10ms to avoid excessive CPU usage.

diskstat_period_ms: Option<u32>

Polls /proc/diskstats every X ms, if non-zero. This is required to be > 10ms to avoid excessive CPU usage.

psi_period_ms: Option<u32>

Polls /proc/pressure/* every X ms, if non-zero. This is required to be > 10ms to avoid excessive CPU usage.

thermal_period_ms: Option<u32>

Polls /sys/class/thermal/* every X ms, if non-zero. This is required to be > 10ms to avoid excessive CPU usage.

cpuidle_period_ms: Option<u32>

Polls /sys/devices/system/cpu/cpu*/cpuidle/state* every X ms, if non-zero. This is required to be > 10ms to avoid excessive CPU usage.

gpufreq_period_ms: Option<u32>

Polls device-specific GPU frequency info every X ms, if non-zero. This is required to be > 10ms to avoid excessive CPU usage.

Implementations

impl SysStatsConfig

pub fn meminfo_period_ms(&self) -> u32

Returns the value of meminfo_period_ms, or the default value if meminfo_period_ms is unset.

pub fn meminfo_counters( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<MeminfoCounters>>

Returns an iterator which yields the valid enum values contained in meminfo_counters.

pub fn push_meminfo_counters(&mut self, value: MeminfoCounters)

Appends the provided enum value to meminfo_counters.

pub fn vmstat_period_ms(&self) -> u32

Returns the value of vmstat_period_ms, or the default value if vmstat_period_ms is unset.

pub fn vmstat_counters( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<VmstatCounters>>

Returns an iterator which yields the valid enum values contained in vmstat_counters.

pub fn push_vmstat_counters(&mut self, value: VmstatCounters)

Appends the provided enum value to vmstat_counters.

pub fn stat_period_ms(&self) -> u32

Returns the value of stat_period_ms, or the default value if stat_period_ms is unset.

pub fn stat_counters( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<StatCounters>>

Returns an iterator which yields the valid enum values contained in stat_counters.

pub fn push_stat_counters(&mut self, value: StatCounters)

Appends the provided enum value to stat_counters.

pub fn devfreq_period_ms(&self) -> u32

Returns the value of devfreq_period_ms, or the default value if devfreq_period_ms is unset.

pub fn cpufreq_period_ms(&self) -> u32

Returns the value of cpufreq_period_ms, or the default value if cpufreq_period_ms is unset.

pub fn buddyinfo_period_ms(&self) -> u32

Returns the value of buddyinfo_period_ms, or the default value if buddyinfo_period_ms is unset.

pub fn diskstat_period_ms(&self) -> u32

Returns the value of diskstat_period_ms, or the default value if diskstat_period_ms is unset.

pub fn psi_period_ms(&self) -> u32

Returns the value of psi_period_ms, or the default value if psi_period_ms is unset.

pub fn thermal_period_ms(&self) -> u32

Returns the value of thermal_period_ms, or the default value if thermal_period_ms is unset.

pub fn cpuidle_period_ms(&self) -> u32

Returns the value of cpuidle_period_ms, or the default value if cpuidle_period_ms is unset.

pub fn gpufreq_period_ms(&self) -> u32

Returns the value of gpufreq_period_ms, or the default value if gpufreq_period_ms is unset.

Trait Implementations

impl Clone for SysStatsConfig

fn clone(&self) -> SysStatsConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SysStatsConfig

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

Formats the value using the given formatter.

impl Default for SysStatsConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for SysStatsConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for SysStatsConfig

fn eq(&self, other: &SysStatsConfig) -> 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 SysStatsConfig