Struct FtraceCpuStats

pub struct FtraceCpuStats {
    pub cpu: Option<u64>,
    pub entries: Option<u64>,
    pub overrun: Option<u64>,
    pub commit_overrun: Option<u64>,
    pub bytes_read: Option<u64>,
    pub oldest_event_ts: Option<f64>,
    pub now_ts: Option<f64>,
    pub dropped_events: Option<u64>,
    pub read_events: Option<u64>,
}

Per-CPU kernel buffer stats for the ftrace data source gathered from /sys/kernel/tracing/per_cpu/cpuX/stats.

Fields

cpu: Option<u64>

CPU index.

entries: Option<u64>

Number of entries currently in the kernel buffer.

overrun: Option<u64>

Number of events lost in kernel buffers due to overwriting of old events before userspace had a chance to drain them. Valid if the buffer is in “overwrite” mode, otherwise see |dropped_events|.

commit_overrun: Option<u64>

This should always be zero. If not the buffer size is way too small or something went wrong with the tracer. Quoting the kernel: “number of commits failing due to the buffer wrapping around while there are uncommitted events, such as during an interrupt storm”.

bytes_read: Option<u64>

Size of entries currently in the kernel buffer (see |entries|) in bytes. The field should be named “bytes”, but is misnamed for historical reasons. This value has known inaccuracies before Linux v6.6: https://github.com/torvalds/linux/commit/45d99ea

oldest_event_ts: Option<f64>

The timestamp for the oldest event still in the ring buffer. Unit: seconds for typical trace clocks (i.e. not tsc/counter).

now_ts: Option<f64>

The current timestamp. Unit: seconds for typical trace clocks (i.e. not tsc/counter).

dropped_events: Option<u64>

If the kernel buffer has overwrite mode disabled, this will show the number of new events that were lost because the buffer was full. This is similar to |overrun| but only for the overwrite=false case.

read_events: Option<u64>

The number of events read (consumed) from the buffer by userspace.

Implementations

impl FtraceCpuStats

pub fn cpu(&self) -> u64

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

pub fn entries(&self) -> u64

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

pub fn overrun(&self) -> u64

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

pub fn commit_overrun(&self) -> u64

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

pub fn bytes_read(&self) -> u64

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

pub fn oldest_event_ts(&self) -> f64

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

pub fn now_ts(&self) -> f64

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

pub fn dropped_events(&self) -> u64

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

pub fn read_events(&self) -> u64

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

Trait Implementations

impl Clone for FtraceCpuStats

fn clone(&self) -> FtraceCpuStats

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FtraceCpuStats

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

Formats the value using the given formatter.

impl Default for FtraceCpuStats

fn default() -> Self

Returns the “default value” for a type.

impl Message for FtraceCpuStats

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 FtraceCpuStats

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